lockstep_rails 0.3.67 → 0.3.69

Sign up to get free protection for your applications and to get access to all the features.
@@ -1058,7 +1058,7 @@
1058
1058
  {
1059
1059
  "name": "include",
1060
1060
  "in": "query",
1061
- "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Notes, Attachments, CustomFields",
1061
+ "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Notes, Attachments, CustomFields, Enrollments",
1062
1062
  "schema": {
1063
1063
  "type": "string",
1064
1064
  "default": ""
@@ -1391,7 +1391,7 @@
1391
1391
  {
1392
1392
  "name": "include",
1393
1393
  "in": "query",
1394
- "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Notes, Attachments, CustomFields",
1394
+ "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Notes, Attachments, CustomFields, Enrollments",
1395
1395
  "schema": {
1396
1396
  "type": "string"
1397
1397
  }
@@ -3430,6 +3430,109 @@
3430
3430
  ]
3431
3431
  }
3432
3432
  },
3433
+ "/api/v1/Companies/views/magic-link-summary": {
3434
+ "get": {
3435
+ "tags": [
3436
+ "Companies"
3437
+ ],
3438
+ "summary": "Query Magic Link Summary",
3439
+ "description": "See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
3440
+ "operationId": "v1_Companies_QueryCompanyMagicLinkSummary",
3441
+ "parameters": [
3442
+ {
3443
+ "name": "filter",
3444
+ "in": "query",
3445
+ "description": "The filter for this query.\r\nSee [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)",
3446
+ "schema": {
3447
+ "type": "string"
3448
+ }
3449
+ },
3450
+ {
3451
+ "name": "include",
3452
+ "in": "query",
3453
+ "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nNo collections are currently available but may be offered in the future",
3454
+ "schema": {
3455
+ "type": "string"
3456
+ }
3457
+ },
3458
+ {
3459
+ "name": "order",
3460
+ "in": "query",
3461
+ "description": "The sort order for the results, in the [Searchlight order\r\nsyntax](https://github.com/tspence/csharp-searchlight).",
3462
+ "schema": {
3463
+ "type": "string"
3464
+ }
3465
+ },
3466
+ {
3467
+ "name": "pageSize",
3468
+ "in": "query",
3469
+ "description": "The page size for results (default 250, maximum of 500)",
3470
+ "schema": {
3471
+ "type": "integer",
3472
+ "format": "int32"
3473
+ }
3474
+ },
3475
+ {
3476
+ "name": "pageNumber",
3477
+ "in": "query",
3478
+ "description": "The page number for results (default 0)",
3479
+ "schema": {
3480
+ "type": "integer",
3481
+ "format": "int32"
3482
+ }
3483
+ }
3484
+ ],
3485
+ "responses": {
3486
+ "200": {
3487
+ "description": "Success",
3488
+ "content": {
3489
+ "application/json": {
3490
+ "schema": {
3491
+ "$ref": "#/components/schemas/CompanyMagicLinkSummaryModelFetchResult"
3492
+ }
3493
+ },
3494
+ "text/json": {
3495
+ "schema": {
3496
+ "$ref": "#/components/schemas/CompanyMagicLinkSummaryModelFetchResult"
3497
+ }
3498
+ }
3499
+ }
3500
+ },
3501
+ "404": {
3502
+ "description": "Not Found",
3503
+ "content": {
3504
+ "application/json": {
3505
+ "schema": {
3506
+ "$ref": "#/components/schemas/ProblemDetails"
3507
+ }
3508
+ },
3509
+ "text/json": {
3510
+ "schema": {
3511
+ "$ref": "#/components/schemas/ProblemDetails"
3512
+ }
3513
+ }
3514
+ }
3515
+ },
3516
+ "401": {
3517
+ "description": "Unauthorized"
3518
+ },
3519
+ "403": {
3520
+ "description": "Forbidden"
3521
+ }
3522
+ },
3523
+ "security": [
3524
+ {
3525
+ "oauth2": [ ]
3526
+ },
3527
+ {
3528
+ "bearer_token": [ ]
3529
+ },
3530
+ {
3531
+ "api_key": [ ]
3532
+ }
3533
+ ]
3534
+ }
3535
+ },
3433
3536
  "/api/v1/Companies/views/details/{id}": {
3434
3537
  "get": {
3435
3538
  "tags": [
@@ -3507,7 +3610,7 @@
3507
3610
  "Companies"
3508
3611
  ],
3509
3612
  "summary": "Set Company Logo",
3510
- "description": "Sets the logo for specified company. The logo will be stored in the Lockstep Platform and will be **publicly accessible**.\r\n\r\n.jpg, .jpeg, .png, and .webp are supported. 2MB maximum. If no logo is uploaded, the existing logo will be deleted.\r\n\r\nA Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.\r\n\r\nOptional view box meta data for the provided logo may be supplied using the following query parameters. Please note that you must supply either all of the values or none of the values. <ul><li>min_x</li><li>min_y</li><li>width</li><li>height</li></ul>\r\n\r\nSee [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
3613
+ "description": "Sets the logo for specified company. The logo will be stored in the Lockstep Platform and will be **publicly accessible**.\r\n\r\n.jpg, .jpeg, .png, and .webp are supported. 2MB maximum. If no logo is uploaded, the existing logo will be deleted.\r\n\r\nA Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.\r\n\r\nOptional view box meta data for the provided logo may be supplied using the following query parameters. Please note that you must supply either all of the values or none of the values. <ul><li>min_x</li><li>min_y</li><li>width</li><li>height</li></ul>\r\n\r\nSee [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
3511
3614
  "operationId": "v1_Companies_SetCompanyLogo",
3512
3615
  "parameters": [
3513
3616
  {
@@ -3619,7 +3722,7 @@
3619
3722
  "Companies"
3620
3723
  ],
3621
3724
  "summary": "Update logo view box settings",
3622
- "description": "Update view box meta data for the given Company id.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
3725
+ "description": "Update view box meta data for the given Company id.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
3623
3726
  "operationId": "v1_Companies_UpdateViewBox",
3624
3727
  "parameters": [
3625
3728
  {
@@ -9473,25 +9576,21 @@
9473
9576
  "description": "Creates one or more Invoices within this account and returns the records as created.\r\n\r\nAn Invoice represents a bill sent from one company to another. The creator of the invoice is identified by the `CompanyId` field, and the recipient of the invoice is identified by the `CustomerId` field. Most invoices are uniquely identified both by a Lockstep Platform ID number and a customer ERP \"key\" that was generated by the system that originated the invoice. Invoices have a total amount and a due date, and when some payments have been made on the Invoice the `TotalAmount` and the `OutstandingBalanceAmount` may be different.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
9474
9577
  "operationId": "v1_Invoices_CreateInvoices",
9475
9578
  "requestBody": {
9476
- "description": "The Invoices to create",
9579
+ "description": "Upload a UBL file or provide an InvoiceModel array",
9477
9580
  "content": {
9478
- "application/json": {
9479
- "schema": {
9480
- "type": "array",
9481
- "items": {
9482
- "$ref": "#/components/schemas/InvoiceModel"
9483
- }
9484
- }
9485
- },
9486
- "text/json": {
9581
+ "multipart/form-data": {
9487
9582
  "schema": {
9488
- "type": "array",
9489
- "items": {
9490
- "$ref": "#/components/schemas/InvoiceModel"
9583
+ "type": "object",
9584
+ "properties": {
9585
+ "ublFile": {
9586
+ "type": "string",
9587
+ "description": "Upload a UBL .xml file",
9588
+ "format": "binary"
9589
+ }
9491
9590
  }
9492
9591
  }
9493
9592
  },
9494
- "application/*+json": {
9593
+ "application/json": {
9495
9594
  "schema": {
9496
9595
  "type": "array",
9497
9596
  "items": {
@@ -9499,7 +9598,8 @@
9499
9598
  }
9500
9599
  }
9501
9600
  }
9502
- }
9601
+ },
9602
+ "required": true
9503
9603
  },
9504
9604
  "responses": {
9505
9605
  "200": {
@@ -9744,7 +9844,7 @@
9744
9844
  "Invoices"
9745
9845
  ],
9746
9846
  "summary": "Retrieve invoice PDF",
9747
- "description": "Retrieves a PDF file for this invoice if it is of one of the supported invoice types and has been synced using an app enrollment to one of the supported apps.\r\n\r\nSage Intacct supports AR Invoices.\r\n\r\nQuickBooks Online supports AR Invoices, and AR Credit Memos.\r\n\r\nXero supports AR Invoices, AP Invoices, AR Credit Memos, and AP Credit Memos.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
9847
+ "description": "Retrieves a PDF file for this invoice if it is of one of the supported invoice types and has been synced using an app enrollment to one of the supported apps.\r\n\r\nSage Intacct supports AR Invoices.\r\n\r\nQuickBooks Online supports AR Invoices, and AR Credit Memos.\r\n\r\nXero supports AR Invoices, AP Invoices, AR Credit Memos, and AP Credit Memos.\r\n\r\nSage 50 supports AR Invoices and AR Credit Memos.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
9748
9848
  "operationId": "v1_Invoices_RetrieveInvoicePdf",
9749
9849
  "parameters": [
9750
9850
  {
@@ -10002,6 +10102,173 @@
10002
10102
  ]
10003
10103
  }
10004
10104
  },
10105
+ "/api/v1/journal-entries/{id}": {
10106
+ "get": {
10107
+ "tags": [
10108
+ "JournalEntries"
10109
+ ],
10110
+ "summary": "Retrieve Journal Entry",
10111
+ "description": "Retrieves the Journal Entry specified by this unique identifier, optionally including nested data sets.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
10112
+ "operationId": "v1_JournalEntries_RetrieveJournalEntry",
10113
+ "parameters": [
10114
+ {
10115
+ "name": "id",
10116
+ "in": "path",
10117
+ "description": "The unique Lockstep Platform ID number of this journal entry; NOT the customer's ERP key",
10118
+ "required": true,
10119
+ "schema": {
10120
+ "type": "string",
10121
+ "format": "uuid"
10122
+ }
10123
+ },
10124
+ {
10125
+ "name": "include",
10126
+ "in": "query",
10127
+ "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Lines, Attachments",
10128
+ "schema": {
10129
+ "type": "string"
10130
+ }
10131
+ }
10132
+ ],
10133
+ "responses": {
10134
+ "200": {
10135
+ "description": "Success",
10136
+ "content": {
10137
+ "application/json": {
10138
+ "schema": {
10139
+ "$ref": "#/components/schemas/JournalEntryModel"
10140
+ }
10141
+ },
10142
+ "text/json": {
10143
+ "schema": {
10144
+ "$ref": "#/components/schemas/JournalEntryModel"
10145
+ }
10146
+ }
10147
+ }
10148
+ },
10149
+ "404": {
10150
+ "description": "Not Found",
10151
+ "content": {
10152
+ "application/json": {
10153
+ "schema": {
10154
+ "$ref": "#/components/schemas/ProblemDetails"
10155
+ }
10156
+ },
10157
+ "text/json": {
10158
+ "schema": {
10159
+ "$ref": "#/components/schemas/ProblemDetails"
10160
+ }
10161
+ }
10162
+ }
10163
+ },
10164
+ "401": {
10165
+ "description": "Unauthorized"
10166
+ },
10167
+ "403": {
10168
+ "description": "Forbidden"
10169
+ }
10170
+ },
10171
+ "security": [
10172
+ {
10173
+ "oauth2": [ ]
10174
+ },
10175
+ {
10176
+ "bearer_token": [ ]
10177
+ },
10178
+ {
10179
+ "api_key": [ ]
10180
+ }
10181
+ ]
10182
+ }
10183
+ },
10184
+ "/api/v1/journal-entries/query": {
10185
+ "get": {
10186
+ "tags": [
10187
+ "JournalEntries"
10188
+ ],
10189
+ "summary": "Query Journal Entries",
10190
+ "description": "Queries Journal Entries for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.\r\n\r\nMore information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
10191
+ "operationId": "v1_JournalEntries_QueryJournalEntries",
10192
+ "parameters": [
10193
+ {
10194
+ "name": "filter",
10195
+ "in": "query",
10196
+ "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)",
10197
+ "schema": {
10198
+ "type": "string"
10199
+ }
10200
+ },
10201
+ {
10202
+ "name": "include",
10203
+ "in": "query",
10204
+ "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Lines, Attachments",
10205
+ "schema": {
10206
+ "type": "string"
10207
+ }
10208
+ },
10209
+ {
10210
+ "name": "order",
10211
+ "in": "query",
10212
+ "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)",
10213
+ "schema": {
10214
+ "type": "string"
10215
+ }
10216
+ },
10217
+ {
10218
+ "name": "pageSize",
10219
+ "in": "query",
10220
+ "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)",
10221
+ "schema": {
10222
+ "type": "integer",
10223
+ "format": "int32"
10224
+ }
10225
+ },
10226
+ {
10227
+ "name": "pageNumber",
10228
+ "in": "query",
10229
+ "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)",
10230
+ "schema": {
10231
+ "type": "integer",
10232
+ "format": "int32"
10233
+ }
10234
+ }
10235
+ ],
10236
+ "responses": {
10237
+ "200": {
10238
+ "description": "Success",
10239
+ "content": {
10240
+ "application/json": {
10241
+ "schema": {
10242
+ "$ref": "#/components/schemas/JournalEntryModelFetchResult"
10243
+ }
10244
+ },
10245
+ "text/json": {
10246
+ "schema": {
10247
+ "$ref": "#/components/schemas/JournalEntryModelFetchResult"
10248
+ }
10249
+ }
10250
+ }
10251
+ },
10252
+ "401": {
10253
+ "description": "Unauthorized"
10254
+ },
10255
+ "403": {
10256
+ "description": "Forbidden"
10257
+ }
10258
+ },
10259
+ "security": [
10260
+ {
10261
+ "oauth2": [ ]
10262
+ },
10263
+ {
10264
+ "bearer_token": [ ]
10265
+ },
10266
+ {
10267
+ "api_key": [ ]
10268
+ }
10269
+ ]
10270
+ }
10271
+ },
10005
10272
  "/api/v1/Leads": {
10006
10273
  "post": {
10007
10274
  "tags": [
@@ -10212,6 +10479,77 @@
10212
10479
  ]
10213
10480
  }
10214
10481
  },
10482
+ "/api/v1/useraccounts/magic-links/{id}/bounced": {
10483
+ "delete": {
10484
+ "tags": [
10485
+ "MagicLinks"
10486
+ ],
10487
+ "summary": "Revoke Bounced Magic Link",
10488
+ "description": "Revokes the bounced magic link with the specified id so it cannot be used to call the API.\r\n\r\nRevocation will be received by all servers within five minutes of revocation. API calls made using this magic link after the revocation will fail. A revoked magic link cannot be un-revoked.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
10489
+ "operationId": "v1_MagicLinks_RevokeBouncedMagicLink",
10490
+ "parameters": [
10491
+ {
10492
+ "name": "id",
10493
+ "in": "path",
10494
+ "description": "The unique Lockstep Platform ID number of this magic link",
10495
+ "required": true,
10496
+ "schema": {
10497
+ "type": "string",
10498
+ "format": "uuid"
10499
+ }
10500
+ }
10501
+ ],
10502
+ "responses": {
10503
+ "200": {
10504
+ "description": "Success",
10505
+ "content": {
10506
+ "application/json": {
10507
+ "schema": {
10508
+ "$ref": "#/components/schemas/ActionResultModel"
10509
+ }
10510
+ },
10511
+ "text/json": {
10512
+ "schema": {
10513
+ "$ref": "#/components/schemas/ActionResultModel"
10514
+ }
10515
+ }
10516
+ }
10517
+ },
10518
+ "404": {
10519
+ "description": "Not Found",
10520
+ "content": {
10521
+ "application/json": {
10522
+ "schema": {
10523
+ "$ref": "#/components/schemas/ProblemDetails"
10524
+ }
10525
+ },
10526
+ "text/json": {
10527
+ "schema": {
10528
+ "$ref": "#/components/schemas/ProblemDetails"
10529
+ }
10530
+ }
10531
+ }
10532
+ },
10533
+ "401": {
10534
+ "description": "Unauthorized"
10535
+ },
10536
+ "403": {
10537
+ "description": "Forbidden"
10538
+ }
10539
+ },
10540
+ "security": [
10541
+ {
10542
+ "oauth2": [ ]
10543
+ },
10544
+ {
10545
+ "bearer_token": [ ]
10546
+ },
10547
+ {
10548
+ "api_key": [ ]
10549
+ }
10550
+ ]
10551
+ }
10552
+ },
10215
10553
  "/api/v1/useraccounts/magic-links/query": {
10216
10554
  "get": {
10217
10555
  "tags": [
@@ -10300,6 +10638,70 @@
10300
10638
  ]
10301
10639
  }
10302
10640
  },
10641
+ "/api/v1/useraccounts/magic-links/summary": {
10642
+ "get": {
10643
+ "tags": [
10644
+ "MagicLinks"
10645
+ ],
10646
+ "summary": "Magic Link Summary",
10647
+ "description": "Gets a summary of all magic links created during the specified date range, returns no content if there are no magic links for the specified date range\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
10648
+ "operationId": "v1_MagicLinks_GetMagicLinkSummary",
10649
+ "parameters": [
10650
+ {
10651
+ "name": "from",
10652
+ "in": "query",
10653
+ "description": "The date that the summary starts from (default one year ago from today)",
10654
+ "schema": {
10655
+ "type": "string",
10656
+ "format": "date-time"
10657
+ }
10658
+ },
10659
+ {
10660
+ "name": "to",
10661
+ "in": "query",
10662
+ "description": "The date that the summary ends at (default today)",
10663
+ "schema": {
10664
+ "type": "string",
10665
+ "format": "date-time"
10666
+ }
10667
+ }
10668
+ ],
10669
+ "responses": {
10670
+ "200": {
10671
+ "description": "Success",
10672
+ "content": {
10673
+ "application/json": {
10674
+ "schema": {
10675
+ "$ref": "#/components/schemas/MagicLinkSummaryModel"
10676
+ }
10677
+ },
10678
+ "text/json": {
10679
+ "schema": {
10680
+ "$ref": "#/components/schemas/MagicLinkSummaryModel"
10681
+ }
10682
+ }
10683
+ }
10684
+ },
10685
+ "401": {
10686
+ "description": "Unauthorized"
10687
+ },
10688
+ "403": {
10689
+ "description": "Forbidden"
10690
+ }
10691
+ },
10692
+ "security": [
10693
+ {
10694
+ "oauth2": [ ]
10695
+ },
10696
+ {
10697
+ "bearer_token": [ ]
10698
+ },
10699
+ {
10700
+ "api_key": [ ]
10701
+ }
10702
+ ]
10703
+ }
10704
+ },
10303
10705
  "/api/v1/Notes/{id}": {
10304
10706
  "get": {
10305
10707
  "tags": [
@@ -10379,6 +10781,125 @@
10379
10781
  }
10380
10782
  ]
10381
10783
  },
10784
+ "patch": {
10785
+ "tags": [
10786
+ "Notes"
10787
+ ],
10788
+ "summary": "Update Note",
10789
+ "description": "Updates the Note with the unique ID specified.\r\n\r\nA note is a customizable text string that can be attached to various account attributes within Lockstep. You can use notes for internal communication, correspondence with clients, or personal reminders. The Note Model represents a note and a number of different metadata attributes related to the creation, storage, and ownership of the note.\r\n\r\nSee [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
10790
+ "operationId": "v1_Notes_UpdateNote",
10791
+ "parameters": [
10792
+ {
10793
+ "name": "id",
10794
+ "in": "path",
10795
+ "description": "Note id to be updated",
10796
+ "required": true,
10797
+ "schema": {
10798
+ "type": "string",
10799
+ "format": "uuid"
10800
+ }
10801
+ }
10802
+ ],
10803
+ "requestBody": {
10804
+ "description": "A list of changes to apply to this Note",
10805
+ "content": {
10806
+ "application/json": {
10807
+ "schema": {
10808
+ "type": "object",
10809
+ "additionalProperties": { }
10810
+ }
10811
+ },
10812
+ "text/json": {
10813
+ "schema": {
10814
+ "type": "object",
10815
+ "additionalProperties": { }
10816
+ }
10817
+ },
10818
+ "application/*+json": {
10819
+ "schema": {
10820
+ "type": "object",
10821
+ "additionalProperties": { }
10822
+ }
10823
+ }
10824
+ }
10825
+ },
10826
+ "responses": {
10827
+ "404": {
10828
+ "description": "Not Found",
10829
+ "content": {
10830
+ "application/json": {
10831
+ "schema": {
10832
+ "$ref": "#/components/schemas/ProblemDetails"
10833
+ }
10834
+ },
10835
+ "text/json": {
10836
+ "schema": {
10837
+ "$ref": "#/components/schemas/ProblemDetails"
10838
+ }
10839
+ }
10840
+ }
10841
+ },
10842
+ "200": {
10843
+ "description": "Success",
10844
+ "content": {
10845
+ "application/json": {
10846
+ "schema": {
10847
+ "$ref": "#/components/schemas/NoteModel"
10848
+ }
10849
+ },
10850
+ "text/json": {
10851
+ "schema": {
10852
+ "$ref": "#/components/schemas/NoteModel"
10853
+ }
10854
+ }
10855
+ }
10856
+ },
10857
+ "400": {
10858
+ "description": "Bad Request",
10859
+ "content": {
10860
+ "application/json": {
10861
+ "schema": {
10862
+ "$ref": "#/components/schemas/ProblemDetails"
10863
+ }
10864
+ },
10865
+ "text/json": {
10866
+ "schema": {
10867
+ "$ref": "#/components/schemas/ProblemDetails"
10868
+ }
10869
+ }
10870
+ }
10871
+ },
10872
+ "403": {
10873
+ "description": "Forbidden",
10874
+ "content": {
10875
+ "application/json": {
10876
+ "schema": {
10877
+ "$ref": "#/components/schemas/ProblemDetails"
10878
+ }
10879
+ },
10880
+ "text/json": {
10881
+ "schema": {
10882
+ "$ref": "#/components/schemas/ProblemDetails"
10883
+ }
10884
+ }
10885
+ }
10886
+ },
10887
+ "401": {
10888
+ "description": "Unauthorized"
10889
+ }
10890
+ },
10891
+ "security": [
10892
+ {
10893
+ "oauth2": [ ]
10894
+ },
10895
+ {
10896
+ "bearer_token": [ ]
10897
+ },
10898
+ {
10899
+ "api_key": [ ]
10900
+ }
10901
+ ]
10902
+ },
10382
10903
  "delete": {
10383
10904
  "tags": [
10384
10905
  "Notes"
@@ -16642,122 +17163,476 @@
16642
17163
  }
16643
17164
  }
16644
17165
  },
16645
- "/api/v1/Status": {
17166
+ "/api/v1/service-fabric/directory/companies": {
16646
17167
  "get": {
16647
17168
  "tags": [
16648
- "Status"
17169
+ "Service-Fabric/Directory"
17170
+ ],
17171
+ "summary": "Retrieve Directory Company",
17172
+ "description": "Returns a company model mapped from a directory service object.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
17173
+ "operationId": "v1_DirectoryCompanies_GetDirectoryCompanyById",
17174
+ "parameters": [
17175
+ {
17176
+ "name": "id",
17177
+ "in": "query",
17178
+ "description": "",
17179
+ "schema": {
17180
+ "type": "string"
17181
+ }
17182
+ },
17183
+ {
17184
+ "name": "dataset",
17185
+ "in": "query",
17186
+ "description": "",
17187
+ "schema": {
17188
+ "allOf": [
17189
+ {
17190
+ "$ref": "#/components/schemas/DirectoryDataSet"
17191
+ }
17192
+ ],
17193
+ "description": "Different dataset types to retrieve information from the Directory Service",
17194
+ "default": 0
17195
+ }
17196
+ }
16649
17197
  ],
16650
- "summary": "Ping",
16651
- "description": "Verifies that your application can successfully call the Lockstep Platform API and returns a successful code regardless of your authentication status or permissions.\r\n\r\nThe Ping API can be used to verify that your app is working correctly. The Ping API will always return 200 OK. If you call this API and you receive a code other than 200 OK, you should check your network connectivity. A response code of anything other than 200 means that a routing issue or proxy issue may prevent your application from reaching the Lockstep API",
16652
- "operationId": "v1_Status_RetrieveStatus",
16653
17198
  "responses": {
16654
17199
  "200": {
16655
17200
  "description": "Success",
16656
17201
  "content": {
16657
17202
  "application/json": {
16658
17203
  "schema": {
16659
- "$ref": "#/components/schemas/StatusModel"
17204
+ "$ref": "#/components/schemas/DirectoryCompany"
16660
17205
  }
16661
17206
  },
16662
17207
  "text/json": {
16663
17208
  "schema": {
16664
- "$ref": "#/components/schemas/StatusModel"
17209
+ "$ref": "#/components/schemas/DirectoryCompany"
16665
17210
  }
16666
17211
  }
16667
17212
  }
16668
17213
  },
16669
- "401": {
16670
- "description": "Unauthorized"
16671
- },
16672
- "403": {
16673
- "description": "Forbidden"
16674
- }
16675
- },
16676
- "security": [
16677
- {
16678
- "oauth2": [ ]
16679
- },
16680
- {
16681
- "bearer_token": [ ]
16682
- },
16683
- {
16684
- "api_key": [ ]
16685
- }
16686
- ]
16687
- }
16688
- },
16689
- "/api/v1/Sync": {
16690
- "post": {
16691
- "tags": [
16692
- "Sync"
16693
- ],
16694
- "summary": "Create Sync",
16695
- "description": "Requests a new Sync task from the Application specified in the request and returns a token that can be used to check the progress and status of the task.\r\n\r\nA Sync task represents an action performed by an Application for a particular account. An Application can provide many different tasks as part of their capabilities. Sync tasks are executed in the background and will continue running after they are created. Use one of the creation APIs to request execution of a task. To check on the progress of the task, call GetSync or QuerySync.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
16696
- "operationId": "v1_Sync_CreateSync",
16697
- "requestBody": {
16698
- "description": "Information about the Sync to execute",
16699
- "content": {
16700
- "application/json": {
16701
- "schema": {
16702
- "allOf": [
16703
- {
16704
- "$ref": "#/components/schemas/SyncSubmitModel"
16705
- }
16706
- ],
16707
- "description": "A SyncSubmitModel represents a task that loads data from a connector to load into the Lockstep Platform. Data\r\ncontained in a sync will be merged with your existing data. Each record will be matched with existing data\r\ninside the Lockstep Platform using the [Identity Column](https://developer.lockstep.io/docs/identity-columns)\r\nrules. Any record that represents a new AppEnrollmentId+ErpKey will be inserted. A record that matches an\r\nexisting AppEnrollmentId+ErpKey will be updated, but only if the data has changed.\r\n \r\nA Sync process permits either a complete data file or a partial / delta data file. Lockstep recommends\r\nusing a sliding time window to avoid the risk of clock skew errors that might accidentally omit records.\r\nBest practice is to run a Sync process daily, and to export all data that has changed in the past 48 hours."
16708
- }
16709
- },
16710
- "text/json": {
16711
- "schema": {
16712
- "allOf": [
16713
- {
16714
- "$ref": "#/components/schemas/SyncSubmitModel"
16715
- }
16716
- ],
16717
- "description": "A SyncSubmitModel represents a task that loads data from a connector to load into the Lockstep Platform. Data\r\ncontained in a sync will be merged with your existing data. Each record will be matched with existing data\r\ninside the Lockstep Platform using the [Identity Column](https://developer.lockstep.io/docs/identity-columns)\r\nrules. Any record that represents a new AppEnrollmentId+ErpKey will be inserted. A record that matches an\r\nexisting AppEnrollmentId+ErpKey will be updated, but only if the data has changed.\r\n \r\nA Sync process permits either a complete data file or a partial / delta data file. Lockstep recommends\r\nusing a sliding time window to avoid the risk of clock skew errors that might accidentally omit records.\r\nBest practice is to run a Sync process daily, and to export all data that has changed in the past 48 hours."
16718
- }
16719
- },
16720
- "application/*+json": {
16721
- "schema": {
16722
- "allOf": [
16723
- {
16724
- "$ref": "#/components/schemas/SyncSubmitModel"
16725
- }
16726
- ],
16727
- "description": "A SyncSubmitModel represents a task that loads data from a connector to load into the Lockstep Platform. Data\r\ncontained in a sync will be merged with your existing data. Each record will be matched with existing data\r\ninside the Lockstep Platform using the [Identity Column](https://developer.lockstep.io/docs/identity-columns)\r\nrules. Any record that represents a new AppEnrollmentId+ErpKey will be inserted. A record that matches an\r\nexisting AppEnrollmentId+ErpKey will be updated, but only if the data has changed.\r\n \r\nA Sync process permits either a complete data file or a partial / delta data file. Lockstep recommends\r\nusing a sliding time window to avoid the risk of clock skew errors that might accidentally omit records.\r\nBest practice is to run a Sync process daily, and to export all data that has changed in the past 48 hours."
16728
- }
16729
- }
16730
- }
16731
- },
16732
- "responses": {
16733
- "200": {
16734
- "description": "Success",
17214
+ "400": {
17215
+ "description": "Bad Request",
16735
17216
  "content": {
16736
17217
  "application/json": {
16737
17218
  "schema": {
16738
- "$ref": "#/components/schemas/SyncRequestModel"
17219
+ "$ref": "#/components/schemas/ProblemDetails"
16739
17220
  }
16740
17221
  },
16741
17222
  "text/json": {
16742
17223
  "schema": {
16743
- "$ref": "#/components/schemas/SyncRequestModel"
17224
+ "$ref": "#/components/schemas/ProblemDetails"
16744
17225
  }
16745
17226
  }
16746
17227
  }
16747
17228
  },
16748
- "400": {
16749
- "description": "Bad Request",
17229
+ "404": {
17230
+ "description": "Not Found",
16750
17231
  "content": {
16751
17232
  "application/json": {
16752
17233
  "schema": {
16753
- "type": "object",
16754
- "additionalProperties": { }
17234
+ "$ref": "#/components/schemas/ProblemDetails"
16755
17235
  }
16756
17236
  },
16757
17237
  "text/json": {
16758
17238
  "schema": {
16759
- "type": "object",
16760
- "additionalProperties": { }
17239
+ "$ref": "#/components/schemas/ProblemDetails"
17240
+ }
17241
+ }
17242
+ }
17243
+ },
17244
+ "401": {
17245
+ "description": "Unauthorized"
17246
+ },
17247
+ "403": {
17248
+ "description": "Forbidden"
17249
+ }
17250
+ },
17251
+ "security": [
17252
+ {
17253
+ "oauth2": [ ]
17254
+ },
17255
+ {
17256
+ "bearer_token": [ ]
17257
+ },
17258
+ {
17259
+ "api_key": [ ]
17260
+ }
17261
+ ]
17262
+ }
17263
+ },
17264
+ "/api/v1/service-fabric/external-connectors/query": {
17265
+ "get": {
17266
+ "tags": [
17267
+ "Service-Fabric/External-Connectors"
17268
+ ],
17269
+ "summary": "Retrieve External Connectors",
17270
+ "description": "Returns list of available external connectors. Optionally filtered by category.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
17271
+ "operationId": "v1_ExternalConnectors_Query",
17272
+ "parameters": [
17273
+ {
17274
+ "name": "Category",
17275
+ "in": "query",
17276
+ "description": "Provider's category to search for. If no provider of the requested category exists the returned list is empty.",
17277
+ "schema": {
17278
+ "type": "string"
17279
+ }
17280
+ }
17281
+ ],
17282
+ "responses": {
17283
+ "200": {
17284
+ "description": "Success",
17285
+ "content": {
17286
+ "application/json": {
17287
+ "schema": {
17288
+ "type": "array",
17289
+ "items": {
17290
+ "$ref": "#/components/schemas/ExternalConnector"
17291
+ }
17292
+ }
17293
+ },
17294
+ "text/json": {
17295
+ "schema": {
17296
+ "type": "array",
17297
+ "items": {
17298
+ "$ref": "#/components/schemas/ExternalConnector"
17299
+ }
17300
+ }
17301
+ }
17302
+ }
17303
+ },
17304
+ "400": {
17305
+ "description": "Bad Request",
17306
+ "content": {
17307
+ "application/json": {
17308
+ "schema": {
17309
+ "type": "object",
17310
+ "additionalProperties": { }
17311
+ }
17312
+ },
17313
+ "text/json": {
17314
+ "schema": {
17315
+ "type": "object",
17316
+ "additionalProperties": { }
17317
+ }
17318
+ }
17319
+ }
17320
+ },
17321
+ "401": {
17322
+ "description": "Unauthorized"
17323
+ },
17324
+ "403": {
17325
+ "description": "Forbidden"
17326
+ }
17327
+ },
17328
+ "security": [
17329
+ {
17330
+ "oauth2": [ ]
17331
+ },
17332
+ {
17333
+ "bearer_token": [ ]
17334
+ },
17335
+ {
17336
+ "api_key": [ ]
17337
+ }
17338
+ ]
17339
+ }
17340
+ },
17341
+ "/api/v1/service-fabric/external-connectors/{id}/tokens": {
17342
+ "get": {
17343
+ "tags": [
17344
+ "Service-Fabric/External-Connectors"
17345
+ ],
17346
+ "summary": "Retrieve External Connector Tokens",
17347
+ "description": "Get list of tokens for a given external connector.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
17348
+ "operationId": "v1_ExternalConnectors_GetExternalConnectorTokensById",
17349
+ "parameters": [
17350
+ {
17351
+ "name": "id",
17352
+ "in": "path",
17353
+ "description": "External connector identifier",
17354
+ "required": true,
17355
+ "schema": {
17356
+ "type": "string"
17357
+ }
17358
+ }
17359
+ ],
17360
+ "responses": {
17361
+ "200": {
17362
+ "description": "Success",
17363
+ "content": {
17364
+ "application/json": {
17365
+ "schema": {
17366
+ "type": "array",
17367
+ "items": {
17368
+ "$ref": "#/components/schemas/ExternalConnectorToken"
17369
+ }
17370
+ }
17371
+ },
17372
+ "text/json": {
17373
+ "schema": {
17374
+ "type": "array",
17375
+ "items": {
17376
+ "$ref": "#/components/schemas/ExternalConnectorToken"
17377
+ }
17378
+ }
17379
+ }
17380
+ }
17381
+ },
17382
+ "404": {
17383
+ "description": "Not Found",
17384
+ "content": {
17385
+ "application/json": {
17386
+ "schema": {
17387
+ "$ref": "#/components/schemas/ProblemDetails"
17388
+ }
17389
+ },
17390
+ "text/json": {
17391
+ "schema": {
17392
+ "$ref": "#/components/schemas/ProblemDetails"
17393
+ }
17394
+ }
17395
+ }
17396
+ },
17397
+ "401": {
17398
+ "description": "Unauthorized"
17399
+ },
17400
+ "403": {
17401
+ "description": "Forbidden"
17402
+ }
17403
+ },
17404
+ "security": [
17405
+ {
17406
+ "oauth2": [ ]
17407
+ },
17408
+ {
17409
+ "bearer_token": [ ]
17410
+ },
17411
+ {
17412
+ "api_key": [ ]
17413
+ }
17414
+ ]
17415
+ },
17416
+ "post": {
17417
+ "tags": [
17418
+ "Service-Fabric/External-Connectors"
17419
+ ],
17420
+ "summary": "Start External Connector Authentication",
17421
+ "description": "Start the user authentication process with external connector\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
17422
+ "operationId": "v1_ExternalConnectors_StartExternalConnectorAuth",
17423
+ "parameters": [
17424
+ {
17425
+ "name": "id",
17426
+ "in": "path",
17427
+ "description": "External connector identifier",
17428
+ "required": true,
17429
+ "schema": {
17430
+ "type": "string"
17431
+ }
17432
+ }
17433
+ ],
17434
+ "requestBody": {
17435
+ "description": "External connector auth request information",
17436
+ "content": {
17437
+ "application/json": {
17438
+ "schema": {
17439
+ "allOf": [
17440
+ {
17441
+ "$ref": "#/components/schemas/ExternalConnectorAuthRequest"
17442
+ }
17443
+ ],
17444
+ "description": "An ExternalConnectorAuthRequest represents the information how an external connector authentication url should be\r\ngenerated and the access the customer should have with the external connector."
17445
+ }
17446
+ },
17447
+ "text/json": {
17448
+ "schema": {
17449
+ "allOf": [
17450
+ {
17451
+ "$ref": "#/components/schemas/ExternalConnectorAuthRequest"
17452
+ }
17453
+ ],
17454
+ "description": "An ExternalConnectorAuthRequest represents the information how an external connector authentication url should be\r\ngenerated and the access the customer should have with the external connector."
17455
+ }
17456
+ },
17457
+ "application/*+json": {
17458
+ "schema": {
17459
+ "allOf": [
17460
+ {
17461
+ "$ref": "#/components/schemas/ExternalConnectorAuthRequest"
17462
+ }
17463
+ ],
17464
+ "description": "An ExternalConnectorAuthRequest represents the information how an external connector authentication url should be\r\ngenerated and the access the customer should have with the external connector."
17465
+ }
17466
+ }
17467
+ }
17468
+ },
17469
+ "responses": {
17470
+ "200": {
17471
+ "description": "Success",
17472
+ "content": {
17473
+ "application/json": {
17474
+ "schema": {
17475
+ "$ref": "#/components/schemas/ExternalConnectorAuth"
17476
+ }
17477
+ },
17478
+ "text/json": {
17479
+ "schema": {
17480
+ "$ref": "#/components/schemas/ExternalConnectorAuth"
17481
+ }
17482
+ }
17483
+ }
17484
+ },
17485
+ "400": {
17486
+ "description": "Bad Request",
17487
+ "content": {
17488
+ "application/json": {
17489
+ "schema": {
17490
+ "$ref": "#/components/schemas/ProblemDetails"
17491
+ }
17492
+ },
17493
+ "text/json": {
17494
+ "schema": {
17495
+ "$ref": "#/components/schemas/ProblemDetails"
17496
+ }
17497
+ }
17498
+ }
17499
+ },
17500
+ "401": {
17501
+ "description": "Unauthorized"
17502
+ },
17503
+ "403": {
17504
+ "description": "Forbidden"
17505
+ }
17506
+ },
17507
+ "security": [
17508
+ {
17509
+ "oauth2": [ ]
17510
+ },
17511
+ {
17512
+ "bearer_token": [ ]
17513
+ },
17514
+ {
17515
+ "api_key": [ ]
17516
+ }
17517
+ ]
17518
+ }
17519
+ },
17520
+ "/api/v1/Status": {
17521
+ "get": {
17522
+ "tags": [
17523
+ "Status"
17524
+ ],
17525
+ "summary": "Ping",
17526
+ "description": "Verifies that your application can successfully call the Lockstep Platform API and returns a successful code regardless of your authentication status or permissions.\r\n\r\nThe Ping API can be used to verify that your app is working correctly. The Ping API will always return 200 OK. If you call this API and you receive a code other than 200 OK, you should check your network connectivity. A response code of anything other than 200 means that a routing issue or proxy issue may prevent your application from reaching the Lockstep API",
17527
+ "operationId": "v1_Status_RetrieveStatus",
17528
+ "responses": {
17529
+ "200": {
17530
+ "description": "Success",
17531
+ "content": {
17532
+ "application/json": {
17533
+ "schema": {
17534
+ "$ref": "#/components/schemas/StatusModel"
17535
+ }
17536
+ },
17537
+ "text/json": {
17538
+ "schema": {
17539
+ "$ref": "#/components/schemas/StatusModel"
17540
+ }
17541
+ }
17542
+ }
17543
+ },
17544
+ "401": {
17545
+ "description": "Unauthorized"
17546
+ },
17547
+ "403": {
17548
+ "description": "Forbidden"
17549
+ }
17550
+ },
17551
+ "security": [
17552
+ {
17553
+ "oauth2": [ ]
17554
+ },
17555
+ {
17556
+ "bearer_token": [ ]
17557
+ },
17558
+ {
17559
+ "api_key": [ ]
17560
+ }
17561
+ ]
17562
+ }
17563
+ },
17564
+ "/api/v1/Sync": {
17565
+ "post": {
17566
+ "tags": [
17567
+ "Sync"
17568
+ ],
17569
+ "summary": "Create Sync",
17570
+ "description": "Requests a new Sync task from the Application specified in the request and returns a token that can be used to check the progress and status of the task.\r\n\r\nA Sync task represents an action performed by an Application for a particular account. An Application can provide many different tasks as part of their capabilities. Sync tasks are executed in the background and will continue running after they are created. Use one of the creation APIs to request execution of a task. To check on the progress of the task, call GetSync or QuerySync.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
17571
+ "operationId": "v1_Sync_CreateSync",
17572
+ "requestBody": {
17573
+ "description": "Information about the Sync to execute",
17574
+ "content": {
17575
+ "application/json": {
17576
+ "schema": {
17577
+ "allOf": [
17578
+ {
17579
+ "$ref": "#/components/schemas/SyncSubmitModel"
17580
+ }
17581
+ ],
17582
+ "description": "A SyncSubmitModel represents a task that loads data from a connector to load into the Lockstep Platform. Data\r\ncontained in a sync will be merged with your existing data. Each record will be matched with existing data\r\ninside the Lockstep Platform using the [Identity Column](https://developer.lockstep.io/docs/identity-columns)\r\nrules. Any record that represents a new AppEnrollmentId+ErpKey will be inserted. A record that matches an\r\nexisting AppEnrollmentId+ErpKey will be updated, but only if the data has changed.\r\n \r\nA Sync process permits either a complete data file or a partial / delta data file. Lockstep recommends\r\nusing a sliding time window to avoid the risk of clock skew errors that might accidentally omit records.\r\nBest practice is to run a Sync process daily, and to export all data that has changed in the past 48 hours."
17583
+ }
17584
+ },
17585
+ "text/json": {
17586
+ "schema": {
17587
+ "allOf": [
17588
+ {
17589
+ "$ref": "#/components/schemas/SyncSubmitModel"
17590
+ }
17591
+ ],
17592
+ "description": "A SyncSubmitModel represents a task that loads data from a connector to load into the Lockstep Platform. Data\r\ncontained in a sync will be merged with your existing data. Each record will be matched with existing data\r\ninside the Lockstep Platform using the [Identity Column](https://developer.lockstep.io/docs/identity-columns)\r\nrules. Any record that represents a new AppEnrollmentId+ErpKey will be inserted. A record that matches an\r\nexisting AppEnrollmentId+ErpKey will be updated, but only if the data has changed.\r\n \r\nA Sync process permits either a complete data file or a partial / delta data file. Lockstep recommends\r\nusing a sliding time window to avoid the risk of clock skew errors that might accidentally omit records.\r\nBest practice is to run a Sync process daily, and to export all data that has changed in the past 48 hours."
17593
+ }
17594
+ },
17595
+ "application/*+json": {
17596
+ "schema": {
17597
+ "allOf": [
17598
+ {
17599
+ "$ref": "#/components/schemas/SyncSubmitModel"
17600
+ }
17601
+ ],
17602
+ "description": "A SyncSubmitModel represents a task that loads data from a connector to load into the Lockstep Platform. Data\r\ncontained in a sync will be merged with your existing data. Each record will be matched with existing data\r\ninside the Lockstep Platform using the [Identity Column](https://developer.lockstep.io/docs/identity-columns)\r\nrules. Any record that represents a new AppEnrollmentId+ErpKey will be inserted. A record that matches an\r\nexisting AppEnrollmentId+ErpKey will be updated, but only if the data has changed.\r\n \r\nA Sync process permits either a complete data file or a partial / delta data file. Lockstep recommends\r\nusing a sliding time window to avoid the risk of clock skew errors that might accidentally omit records.\r\nBest practice is to run a Sync process daily, and to export all data that has changed in the past 48 hours."
17603
+ }
17604
+ }
17605
+ }
17606
+ },
17607
+ "responses": {
17608
+ "200": {
17609
+ "description": "Success",
17610
+ "content": {
17611
+ "application/json": {
17612
+ "schema": {
17613
+ "$ref": "#/components/schemas/SyncRequestModel"
17614
+ }
17615
+ },
17616
+ "text/json": {
17617
+ "schema": {
17618
+ "$ref": "#/components/schemas/SyncRequestModel"
17619
+ }
17620
+ }
17621
+ }
17622
+ },
17623
+ "400": {
17624
+ "description": "Bad Request",
17625
+ "content": {
17626
+ "application/json": {
17627
+ "schema": {
17628
+ "type": "object",
17629
+ "additionalProperties": { }
17630
+ }
17631
+ },
17632
+ "text/json": {
17633
+ "schema": {
17634
+ "type": "object",
17635
+ "additionalProperties": { }
16761
17636
  }
16762
17637
  }
16763
17638
  }
@@ -18495,7 +19370,7 @@
18495
19370
  "UserAccounts"
18496
19371
  ],
18497
19372
  "summary": "Update User",
18498
- "description": "Updates a User that matches the specified id with the requested information.\r\n\r\nThe PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.\r\n\r\nA User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox. A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account. All Users must validate their email to make use of Lockstep platform services. Users may have different privileges and access control rights within the Lockstep Platform.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
19373
+ "description": "Updates a User that matches the specified id with the requested information. The following limitations are applied when updating a user:\r\n\r\n<list type=\"bullet\"><item>Only Group Owners and Admins can change other users.</item><item>When updating another user, only the role and status can be updated.</item><item>A user can only change their own status when their current status is Onboarding.</item><item>A user can never change their own role.</item><item>Nobody can change the owner's role or status. See the \"/transfer-owner\" route for changing the owner.</item><item>A user can change their own personal information.</item></list>\r\n\r\nThe PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.\r\n\r\nA User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox. A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account. All Users must validate their email to make use of Lockstep platform services. Users may have different privileges and access control rights within the Lockstep Platform.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
18499
19374
  "operationId": "v1_UserAccounts_UpdateUser",
18500
19375
  "parameters": [
18501
19376
  {
@@ -19102,7 +19977,7 @@
19102
19977
  "UserAccounts"
19103
19978
  ],
19104
19979
  "summary": "Change User Group",
19105
- "description": "Change the active GroupKey of the calling user.\r\n\r\nA User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox. A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account. All Users must validate their email to make use of Lockstep platform services. Users may have different privileges and access control rights within the Lockstep Platform.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
19980
+ "description": "Change the active GroupKey of the calling user.\r\n\r\nA User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox. A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account. All Users must validate their email to make use of Lockstep platform services. Users may have different privileges and access control rights within the Lockstep Platform.",
19106
19981
  "operationId": "v1_UserAccounts_ChangeUserGroup",
19107
19982
  "parameters": [
19108
19983
  {
@@ -19188,7 +20063,7 @@
19188
20063
  "UserAccounts"
19189
20064
  ],
19190
20065
  "summary": "Get User Data",
19191
- "description": "Retrieves the user data for the current user. This allows for retrieving extended user data such as UTM parameters.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
20066
+ "description": "Retrieves the user data for the current user. This allows for retrieving extended user data such as UTM parameters.",
19192
20067
  "operationId": "v1_UserAccounts_GetUserData",
19193
20068
  "parameters": [
19194
20069
  {
@@ -19276,7 +20151,7 @@
19276
20151
  "UserAccounts"
19277
20152
  ],
19278
20153
  "summary": "Set Support Access",
19279
- "description": "Set support access for the calling user.\r\n\r\nSupport access allows Lockstep to access the user's account to troubleshoot issues. Access is granted for a limited time, can be revoked at any time, and requires a code to verify the access.\r\n\r\nEvery call to this API will regenerate the support access code.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
20154
+ "description": "Set support access for the calling user.\r\n\r\nSupport access allows Lockstep to access the user's account to troubleshoot issues. Access is granted for a limited time, can be revoked at any time, and requires a code to verify the access.\r\n\r\nEvery call to this API will regenerate the support access code.",
19280
20155
  "operationId": "v1_UserAccounts_SetSupportAccess",
19281
20156
  "requestBody": {
19282
20157
  "description": "",
@@ -20792,13 +21667,6 @@
20792
21667
  "AccountingProfileContactModelFetchResult": {
20793
21668
  "type": "object",
20794
21669
  "properties": {
20795
- "records": {
20796
- "type": "array",
20797
- "items": {
20798
- "$ref": "#/components/schemas/AccountingProfileContactModel"
20799
- },
20800
- "nullable": true
20801
- },
20802
21670
  "totalCount": {
20803
21671
  "type": "integer",
20804
21672
  "format": "int32",
@@ -20813,6 +21681,13 @@
20813
21681
  "type": "integer",
20814
21682
  "format": "int32",
20815
21683
  "nullable": true
21684
+ },
21685
+ "records": {
21686
+ "type": "array",
21687
+ "items": {
21688
+ "$ref": "#/components/schemas/AccountingProfileContactModel"
21689
+ },
21690
+ "nullable": true
20816
21691
  }
20817
21692
  },
20818
21693
  "additionalProperties": false
@@ -21250,13 +22125,6 @@
21250
22125
  "AccountingProfileModelFetchResult": {
21251
22126
  "type": "object",
21252
22127
  "properties": {
21253
- "records": {
21254
- "type": "array",
21255
- "items": {
21256
- "$ref": "#/components/schemas/AccountingProfileModel"
21257
- },
21258
- "nullable": true
21259
- },
21260
22128
  "totalCount": {
21261
22129
  "type": "integer",
21262
22130
  "format": "int32",
@@ -21271,6 +22139,13 @@
21271
22139
  "type": "integer",
21272
22140
  "format": "int32",
21273
22141
  "nullable": true
22142
+ },
22143
+ "records": {
22144
+ "type": "array",
22145
+ "items": {
22146
+ "$ref": "#/components/schemas/AccountingProfileModel"
22147
+ },
22148
+ "nullable": true
21274
22149
  }
21275
22150
  },
21276
22151
  "additionalProperties": false
@@ -21457,7 +22332,7 @@
21457
22332
  }
21458
22333
  },
21459
22334
  "additionalProperties": false,
21460
- "description": "Represents the result of an action.\r\n\r\nIn the Lockstep API, an Action is returned when an API call does not produce any data\r\nbut does produce messages that can be useful in understanding what work was performed.\r\nYou may use the messages text to display user visible error messages or the results of\r\nvarious operations."
22335
+ "description": "Represents the result of an action.\r\n \r\nIn the Lockstep API, an Action is returned when an API call does not produce any data\r\nbut does produce messages that can be useful in understanding what work was performed.\r\nYou may use the messages text to display user visible error messages or the results of\r\nvarious operations."
21461
22336
  },
21462
22337
  "Address": {
21463
22338
  "type": "object",
@@ -21835,13 +22710,6 @@
21835
22710
  "ApiKeyModelFetchResult": {
21836
22711
  "type": "object",
21837
22712
  "properties": {
21838
- "records": {
21839
- "type": "array",
21840
- "items": {
21841
- "$ref": "#/components/schemas/ApiKeyModel"
21842
- },
21843
- "nullable": true
21844
- },
21845
22713
  "totalCount": {
21846
22714
  "type": "integer",
21847
22715
  "format": "int32",
@@ -21856,6 +22724,13 @@
21856
22724
  "type": "integer",
21857
22725
  "format": "int32",
21858
22726
  "nullable": true
22727
+ },
22728
+ "records": {
22729
+ "type": "array",
22730
+ "items": {
22731
+ "$ref": "#/components/schemas/ApiKeyModel"
22732
+ },
22733
+ "nullable": true
21859
22734
  }
21860
22735
  },
21861
22736
  "additionalProperties": false
@@ -21945,13 +22820,6 @@
21945
22820
  "AppEnrollmentCustomFieldModelFetchResult": {
21946
22821
  "type": "object",
21947
22822
  "properties": {
21948
- "records": {
21949
- "type": "array",
21950
- "items": {
21951
- "$ref": "#/components/schemas/AppEnrollmentCustomFieldModel"
21952
- },
21953
- "nullable": true
21954
- },
21955
22823
  "totalCount": {
21956
22824
  "type": "integer",
21957
22825
  "format": "int32",
@@ -21966,6 +22834,13 @@
21966
22834
  "type": "integer",
21967
22835
  "format": "int32",
21968
22836
  "nullable": true
22837
+ },
22838
+ "records": {
22839
+ "type": "array",
22840
+ "items": {
22841
+ "$ref": "#/components/schemas/AppEnrollmentCustomFieldModel"
22842
+ },
22843
+ "nullable": true
21969
22844
  }
21970
22845
  },
21971
22846
  "additionalProperties": false
@@ -22106,13 +22981,6 @@
22106
22981
  "AppEnrollmentModelFetchResult": {
22107
22982
  "type": "object",
22108
22983
  "properties": {
22109
- "records": {
22110
- "type": "array",
22111
- "items": {
22112
- "$ref": "#/components/schemas/AppEnrollmentModel"
22113
- },
22114
- "nullable": true
22115
- },
22116
22984
  "totalCount": {
22117
22985
  "type": "integer",
22118
22986
  "format": "int32",
@@ -22127,6 +22995,13 @@
22127
22995
  "type": "integer",
22128
22996
  "format": "int32",
22129
22997
  "nullable": true
22998
+ },
22999
+ "records": {
23000
+ "type": "array",
23001
+ "items": {
23002
+ "$ref": "#/components/schemas/AppEnrollmentModel"
23003
+ },
23004
+ "nullable": true
22130
23005
  }
22131
23006
  },
22132
23007
  "additionalProperties": false
@@ -22299,6 +23174,15 @@
22299
23174
  "description": "A collection of custom fields linked to this record. To retrieve this collection, specify\r\n`CustomFieldValues` in the `include` parameter when retrieving data.\r\n \r\nTo create a custom field, use the [Create Custom Field](https://developer.lockstep.io/reference/post_api-v1-customfieldvalues)\r\nendpoint with the `TableKey` to `Application` and the `ObjectKey` set to the `ApplicationId` for this record. For\r\nmore information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).",
22300
23175
  "nullable": true,
22301
23176
  "readOnly": true
23177
+ },
23178
+ "enrollments": {
23179
+ "type": "array",
23180
+ "items": {
23181
+ "$ref": "#/components/schemas/AppEnrollmentModel"
23182
+ },
23183
+ "description": "A collection of app enrollments linked to this record. To retrieve this collection, specify\r\n`Enrollments` in the `include` parameter when retrieving data.\r\n \r\nTo create an app enrollment, use the [Create App Enrollment](https://developer.lockstep.io/reference/v1_appenrollments_createappenrollments)\r\nendpoint with the `AppId` set to the `ApplicationId` for this record and associated auth connection info for the record.\r\n \r\nFor more information on extensibility, see [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments).",
23184
+ "nullable": true,
23185
+ "readOnly": true
22302
23186
  }
22303
23187
  },
22304
23188
  "additionalProperties": false,
@@ -22307,13 +23191,6 @@
22307
23191
  "ApplicationModelFetchResult": {
22308
23192
  "type": "object",
22309
23193
  "properties": {
22310
- "records": {
22311
- "type": "array",
22312
- "items": {
22313
- "$ref": "#/components/schemas/ApplicationModel"
22314
- },
22315
- "nullable": true
22316
- },
22317
23194
  "totalCount": {
22318
23195
  "type": "integer",
22319
23196
  "format": "int32",
@@ -22328,6 +23205,13 @@
22328
23205
  "type": "integer",
22329
23206
  "format": "int32",
22330
23207
  "nullable": true
23208
+ },
23209
+ "records": {
23210
+ "type": "array",
23211
+ "items": {
23212
+ "$ref": "#/components/schemas/ApplicationModel"
23213
+ },
23214
+ "nullable": true
22331
23215
  }
22332
23216
  },
22333
23217
  "additionalProperties": false
@@ -22677,13 +23561,6 @@
22677
23561
  "AtRiskInvoiceSummaryModelFetchResult": {
22678
23562
  "type": "object",
22679
23563
  "properties": {
22680
- "records": {
22681
- "type": "array",
22682
- "items": {
22683
- "$ref": "#/components/schemas/AtRiskInvoiceSummaryModel"
22684
- },
22685
- "nullable": true
22686
- },
22687
23564
  "totalCount": {
22688
23565
  "type": "integer",
22689
23566
  "format": "int32",
@@ -22698,6 +23575,13 @@
22698
23575
  "type": "integer",
22699
23576
  "format": "int32",
22700
23577
  "nullable": true
23578
+ },
23579
+ "records": {
23580
+ "type": "array",
23581
+ "items": {
23582
+ "$ref": "#/components/schemas/AtRiskInvoiceSummaryModel"
23583
+ },
23584
+ "nullable": true
22701
23585
  }
22702
23586
  },
22703
23587
  "additionalProperties": false
@@ -22780,13 +23664,6 @@
22780
23664
  "AttachmentLinkModelFetchResult": {
22781
23665
  "type": "object",
22782
23666
  "properties": {
22783
- "records": {
22784
- "type": "array",
22785
- "items": {
22786
- "$ref": "#/components/schemas/AttachmentLinkModel"
22787
- },
22788
- "nullable": true
22789
- },
22790
23667
  "totalCount": {
22791
23668
  "type": "integer",
22792
23669
  "format": "int32",
@@ -22801,6 +23678,13 @@
22801
23678
  "type": "integer",
22802
23679
  "format": "int32",
22803
23680
  "nullable": true
23681
+ },
23682
+ "records": {
23683
+ "type": "array",
23684
+ "items": {
23685
+ "$ref": "#/components/schemas/AttachmentLinkModel"
23686
+ },
23687
+ "nullable": true
22804
23688
  }
22805
23689
  },
22806
23690
  "additionalProperties": false
@@ -22897,13 +23781,6 @@
22897
23781
  "AttachmentModelFetchResult": {
22898
23782
  "type": "object",
22899
23783
  "properties": {
22900
- "records": {
22901
- "type": "array",
22902
- "items": {
22903
- "$ref": "#/components/schemas/AttachmentModel"
22904
- },
22905
- "nullable": true
22906
- },
22907
23784
  "totalCount": {
22908
23785
  "type": "integer",
22909
23786
  "format": "int32",
@@ -22918,6 +23795,13 @@
22918
23795
  "type": "integer",
22919
23796
  "format": "int32",
22920
23797
  "nullable": true
23798
+ },
23799
+ "records": {
23800
+ "type": "array",
23801
+ "items": {
23802
+ "$ref": "#/components/schemas/AttachmentModel"
23803
+ },
23804
+ "nullable": true
22921
23805
  }
22922
23806
  },
22923
23807
  "additionalProperties": false
@@ -23194,13 +24078,6 @@
23194
24078
  "CodeDefinitionModelFetchResult": {
23195
24079
  "type": "object",
23196
24080
  "properties": {
23197
- "records": {
23198
- "type": "array",
23199
- "items": {
23200
- "$ref": "#/components/schemas/CodeDefinitionModel"
23201
- },
23202
- "nullable": true
23203
- },
23204
24081
  "totalCount": {
23205
24082
  "type": "integer",
23206
24083
  "format": "int32",
@@ -23215,6 +24092,13 @@
23215
24092
  "type": "integer",
23216
24093
  "format": "int32",
23217
24094
  "nullable": true
24095
+ },
24096
+ "records": {
24097
+ "type": "array",
24098
+ "items": {
24099
+ "$ref": "#/components/schemas/CodeDefinitionModel"
24100
+ },
24101
+ "nullable": true
23218
24102
  }
23219
24103
  },
23220
24104
  "additionalProperties": false
@@ -23403,6 +24287,120 @@
23403
24287
  "additionalProperties": false,
23404
24288
  "description": "Company payment collected information"
23405
24289
  },
24290
+ "CompanyMagicLinkSummaryModel": {
24291
+ "required": [
24292
+ "companyName"
24293
+ ],
24294
+ "type": "object",
24295
+ "properties": {
24296
+ "companyId": {
24297
+ "type": "string",
24298
+ "description": "The unique id for this company",
24299
+ "format": "uuid"
24300
+ },
24301
+ "companyName": {
24302
+ "maxLength": 100,
24303
+ "minLength": 0,
24304
+ "type": "string",
24305
+ "description": "The short name of the company."
24306
+ },
24307
+ "companyType": {
24308
+ "maxLength": 20,
24309
+ "minLength": 0,
24310
+ "type": "string",
24311
+ "description": "This field indicates the type of company. It can be one of a limited number of values:\r\nCompany, Customer, Group, Vendor, or Third Party. A company that represents both a customer and a vendor\r\nis identified as a CustomerVendor.\r\n \r\n* `Company` - This record represents a company that is part of the organization of the account holder.\r\n* `Customer` - This record represents a business entity that purchases things from the account holder.\r\n* `Group` - Only one record of type `GROUP` exists in each account. Contains your account profile.\r\n* `Vendor` - This record represents a business entity that sells things to the account holder.\r\n* `Third Party` - This record represents a business entity that is neither a customer nor vendor.\r\n* `CustomerVendor` - Both a customer and a vendor.\r\n* `CompanyProfile` - Profile for a Company, each Company should have at most 1 profile, used only for Profile Management.",
24312
+ "nullable": true
24313
+ },
24314
+ "groupKey": {
24315
+ "type": "string",
24316
+ "description": "The GroupKey uniquely identifies a single Lockstep Platform account. All records for this\r\naccount will share the same GroupKey value. GroupKey values cannot be changed once created.\r\n \r\nFor more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).",
24317
+ "format": "uuid"
24318
+ },
24319
+ "primaryContactName": {
24320
+ "type": "string",
24321
+ "description": "The name of the primary contact for this company",
24322
+ "nullable": true
24323
+ },
24324
+ "primaryContactEmailAddress": {
24325
+ "type": "string",
24326
+ "description": "The email of the primary contact for this company",
24327
+ "nullable": true
24328
+ },
24329
+ "outstandingAmount": {
24330
+ "type": "integer",
24331
+ "description": "The total outstanding amount for this company",
24332
+ "format": "int32"
24333
+ },
24334
+ "totalOpenInvoices": {
24335
+ "type": "integer",
24336
+ "description": "The total number of open invoices for this company",
24337
+ "format": "int32"
24338
+ },
24339
+ "pastDue": {
24340
+ "type": "integer",
24341
+ "description": "The total number of invoices that are past due for this company",
24342
+ "format": "int32"
24343
+ },
24344
+ "totalVisits": {
24345
+ "type": "integer",
24346
+ "description": "Total number of visits for all magic links sent for this company",
24347
+ "format": "int32"
24348
+ },
24349
+ "linksSent": {
24350
+ "type": "integer",
24351
+ "description": "Total number of sent links for this company",
24352
+ "format": "int32"
24353
+ },
24354
+ "latestMagicLinkDate": {
24355
+ "type": "string",
24356
+ "description": "Created date of the most recent magic link made for this company",
24357
+ "format": "date-time"
24358
+ },
24359
+ "latestMagicLinkId": {
24360
+ "type": "string",
24361
+ "description": "Id of the most recent magic link made for this company",
24362
+ "format": "uuid"
24363
+ },
24364
+ "latestMagicLinkStatus": {
24365
+ "allOf": [
24366
+ {
24367
+ "$ref": "#/components/schemas/MagicLinkStatus"
24368
+ }
24369
+ ],
24370
+ "description": "Possible statuses for a Magic Link."
24371
+ }
24372
+ },
24373
+ "additionalProperties": false,
24374
+ "description": "A summary of companies combined with their most recent magic links"
24375
+ },
24376
+ "CompanyMagicLinkSummaryModelFetchResult": {
24377
+ "type": "object",
24378
+ "properties": {
24379
+ "totalCount": {
24380
+ "type": "integer",
24381
+ "format": "int32",
24382
+ "nullable": true
24383
+ },
24384
+ "pageSize": {
24385
+ "type": "integer",
24386
+ "format": "int32",
24387
+ "nullable": true
24388
+ },
24389
+ "pageNumber": {
24390
+ "type": "integer",
24391
+ "format": "int32",
24392
+ "nullable": true
24393
+ },
24394
+ "records": {
24395
+ "type": "array",
24396
+ "items": {
24397
+ "$ref": "#/components/schemas/CompanyMagicLinkSummaryModel"
24398
+ },
24399
+ "nullable": true
24400
+ }
24401
+ },
24402
+ "additionalProperties": false
24403
+ },
23406
24404
  "CompanyModel": {
23407
24405
  "required": [
23408
24406
  "companyName"
@@ -23432,7 +24430,7 @@
23432
24430
  "maxLength": 20,
23433
24431
  "minLength": 0,
23434
24432
  "type": "string",
23435
- "description": "This field indicates the type of company. It can be one of a limited number of values:\r\nCompany, Customer, Group, Vendor, or Third Party. A company that represents both a customer and a vendor\r\nis identified as a CustomerVendor.\r\n \r\n* `Company` - This record represents a company that is part of the organization of the account holder.\r\n* `Customer` - This record represents a business entity that purchases things from the account holder.\r\n* `Group` - Only one record of type `GROUP` exists in each account. Contains your account profile.\r\n* `Vendor` - This record represents a business entity that sells things to the account holder.\r\n* `Third Party` - This record represents a business entity that is neither a customer nor vendor.\r\n* `CustomerVendor` - Both a customer and a vendor.",
24433
+ "description": "This field indicates the type of company. It can be one of a limited number of values:\r\nCompany, Customer, Group, Vendor, or Third Party. A company that represents both a customer and a vendor\r\nis identified as a CustomerVendor.\r\n \r\n* `Company` - This record represents a company that is part of the organization of the account holder.\r\n* `Customer` - This record represents a business entity that purchases things from the account holder.\r\n* `Group` - Only one record of type `GROUP` exists in each account. Contains your account profile.\r\n* `Vendor` - This record represents a business entity that sells things to the account holder.\r\n* `Third Party` - This record represents a business entity that is neither a customer nor vendor.\r\n* `CustomerVendor` - Both a customer and a vendor.\r\n* `CompanyProfile` - Profile for a Company, each Company should have at most 1 profile, used only for Profile Management.",
23436
24434
  "nullable": true
23437
24435
  },
23438
24436
  "parentCompanyId": {
@@ -23730,6 +24728,13 @@
23730
24728
  "description": "A unique identification number assigned to the company by the national registration office.",
23731
24729
  "nullable": true
23732
24730
  },
24731
+ "profileReferenceId": {
24732
+ "type": "string",
24733
+ "description": "An optional reference to a real company, making this a profile.",
24734
+ "format": "uuid",
24735
+ "nullable": true,
24736
+ "readOnly": true
24737
+ },
23733
24738
  "notes": {
23734
24739
  "type": "array",
23735
24740
  "items": {
@@ -23799,13 +24804,6 @@
23799
24804
  "CompanyModelFetchResult": {
23800
24805
  "type": "object",
23801
24806
  "properties": {
23802
- "records": {
23803
- "type": "array",
23804
- "items": {
23805
- "$ref": "#/components/schemas/CompanyModel"
23806
- },
23807
- "nullable": true
23808
- },
23809
24807
  "totalCount": {
23810
24808
  "type": "integer",
23811
24809
  "format": "int32",
@@ -23820,6 +24818,13 @@
23820
24818
  "type": "integer",
23821
24819
  "format": "int32",
23822
24820
  "nullable": true
24821
+ },
24822
+ "records": {
24823
+ "type": "array",
24824
+ "items": {
24825
+ "$ref": "#/components/schemas/CompanyModel"
24826
+ },
24827
+ "nullable": true
23823
24828
  }
23824
24829
  },
23825
24830
  "additionalProperties": false
@@ -24282,13 +25287,6 @@
24282
25287
  "ContactModelFetchResult": {
24283
25288
  "type": "object",
24284
25289
  "properties": {
24285
- "records": {
24286
- "type": "array",
24287
- "items": {
24288
- "$ref": "#/components/schemas/ContactModel"
24289
- },
24290
- "nullable": true
24291
- },
24292
25290
  "totalCount": {
24293
25291
  "type": "integer",
24294
25292
  "format": "int32",
@@ -24303,6 +25301,13 @@
24303
25301
  "type": "integer",
24304
25302
  "format": "int32",
24305
25303
  "nullable": true
25304
+ },
25305
+ "records": {
25306
+ "type": "array",
25307
+ "items": {
25308
+ "$ref": "#/components/schemas/ContactModel"
25309
+ },
25310
+ "nullable": true
24306
25311
  }
24307
25312
  },
24308
25313
  "additionalProperties": false
@@ -24515,13 +25520,6 @@
24515
25520
  "CountryModelFetchResult": {
24516
25521
  "type": "object",
24517
25522
  "properties": {
24518
- "records": {
24519
- "type": "array",
24520
- "items": {
24521
- "$ref": "#/components/schemas/CountryModel"
24522
- },
24523
- "nullable": true
24524
- },
24525
25523
  "totalCount": {
24526
25524
  "type": "integer",
24527
25525
  "format": "int32",
@@ -24536,6 +25534,13 @@
24536
25534
  "type": "integer",
24537
25535
  "format": "int32",
24538
25536
  "nullable": true
25537
+ },
25538
+ "records": {
25539
+ "type": "array",
25540
+ "items": {
25541
+ "$ref": "#/components/schemas/CountryModel"
25542
+ },
25543
+ "nullable": true
24539
25544
  }
24540
25545
  },
24541
25546
  "additionalProperties": false
@@ -24702,13 +25707,6 @@
24702
25707
  "CreditMemoAppliedModelFetchResult": {
24703
25708
  "type": "object",
24704
25709
  "properties": {
24705
- "records": {
24706
- "type": "array",
24707
- "items": {
24708
- "$ref": "#/components/schemas/CreditMemoAppliedModel"
24709
- },
24710
- "nullable": true
24711
- },
24712
25710
  "totalCount": {
24713
25711
  "type": "integer",
24714
25712
  "format": "int32",
@@ -24723,6 +25721,13 @@
24723
25721
  "type": "integer",
24724
25722
  "format": "int32",
24725
25723
  "nullable": true
25724
+ },
25725
+ "records": {
25726
+ "type": "array",
25727
+ "items": {
25728
+ "$ref": "#/components/schemas/CreditMemoAppliedModel"
25729
+ },
25730
+ "nullable": true
24726
25731
  }
24727
25732
  },
24728
25733
  "additionalProperties": false
@@ -24966,13 +25971,6 @@
24966
25971
  "CurrencyModelFetchResult": {
24967
25972
  "type": "object",
24968
25973
  "properties": {
24969
- "records": {
24970
- "type": "array",
24971
- "items": {
24972
- "$ref": "#/components/schemas/CurrencyModel"
24973
- },
24974
- "nullable": true
24975
- },
24976
25974
  "totalCount": {
24977
25975
  "type": "integer",
24978
25976
  "format": "int32",
@@ -24987,6 +25985,13 @@
24987
25985
  "type": "integer",
24988
25986
  "format": "int32",
24989
25987
  "nullable": true
25988
+ },
25989
+ "records": {
25990
+ "type": "array",
25991
+ "items": {
25992
+ "$ref": "#/components/schemas/CurrencyModel"
25993
+ },
25994
+ "nullable": true
24990
25995
  }
24991
25996
  },
24992
25997
  "additionalProperties": false
@@ -25479,13 +26484,6 @@
25479
26484
  "CustomerSummaryModelFetchResult": {
25480
26485
  "type": "object",
25481
26486
  "properties": {
25482
- "records": {
25483
- "type": "array",
25484
- "items": {
25485
- "$ref": "#/components/schemas/CustomerSummaryModel"
25486
- },
25487
- "nullable": true
25488
- },
25489
26487
  "totalCount": {
25490
26488
  "type": "integer",
25491
26489
  "format": "int32",
@@ -25500,6 +26498,13 @@
25500
26498
  "type": "integer",
25501
26499
  "format": "int32",
25502
26500
  "nullable": true
26501
+ },
26502
+ "records": {
26503
+ "type": "array",
26504
+ "items": {
26505
+ "$ref": "#/components/schemas/CustomerSummaryModel"
26506
+ },
26507
+ "nullable": true
25503
26508
  }
25504
26509
  },
25505
26510
  "additionalProperties": false
@@ -25657,6 +26662,96 @@
25657
26662
  "additionalProperties": false,
25658
26663
  "description": "Model containing information to create a new developer account."
25659
26664
  },
26665
+ "DirectoryCompany": {
26666
+ "type": "object",
26667
+ "properties": {
26668
+ "dataSet": {
26669
+ "allOf": [
26670
+ {
26671
+ "$ref": "#/components/schemas/DirectoryDataSet"
26672
+ }
26673
+ ],
26674
+ "description": "The field indicates the dataset type used to generate the directory company."
26675
+ },
26676
+ "id": {
26677
+ "type": "string",
26678
+ "description": "Unique identifier of this record based on the dataset.\r\n<remarks>\r\nExamples of this would be:\r\n * DataSet = Siren, Identifier = string\r\n * DataSet = Siret, Identifier = string\r\n</remarks>",
26679
+ "nullable": true
26680
+ },
26681
+ "companyType": {
26682
+ "type": "string",
26683
+ "description": "This field indicates the type of company.",
26684
+ "nullable": true
26685
+ },
26686
+ "name": {
26687
+ "type": "string",
26688
+ "description": "The name of the directory company entity.",
26689
+ "nullable": true
26690
+ },
26691
+ "address1": {
26692
+ "type": "string",
26693
+ "description": "Address info",
26694
+ "nullable": true
26695
+ },
26696
+ "address2": {
26697
+ "type": "string",
26698
+ "description": "Address info",
26699
+ "nullable": true
26700
+ },
26701
+ "address3": {
26702
+ "type": "string",
26703
+ "description": "Address info",
26704
+ "nullable": true
26705
+ },
26706
+ "city": {
26707
+ "type": "string",
26708
+ "description": "Address info",
26709
+ "nullable": true
26710
+ },
26711
+ "country": {
26712
+ "type": "string",
26713
+ "description": "Address info",
26714
+ "nullable": true
26715
+ },
26716
+ "postalCode": {
26717
+ "type": "string",
26718
+ "description": "Address info",
26719
+ "nullable": true
26720
+ },
26721
+ "phoneNumber": {
26722
+ "type": "string",
26723
+ "description": "Phone number",
26724
+ "nullable": true
26725
+ },
26726
+ "emailAddress": {
26727
+ "type": "string",
26728
+ "description": "Email address",
26729
+ "nullable": true
26730
+ },
26731
+ "createdDateTime": {
26732
+ "type": "string",
26733
+ "description": "The date this directory company entity was created",
26734
+ "format": "date-time"
26735
+ },
26736
+ "modifiedDateTime": {
26737
+ "type": "string",
26738
+ "description": "The date this directory company entity was modified",
26739
+ "format": "date-time"
26740
+ }
26741
+ },
26742
+ "additionalProperties": false,
26743
+ "description": "A DirectoryCompany represents a French legal entity, or French establishment within the Sage directory service.\r\nSage directory service objects (company, French legal entity or French establishment) are mapped to a single Platform\r\ncompany object\r\n \r\nSee [Companies, French Legal Entities, and French Establishment](https://confluence.sage.com/display/DNBU/Platform+Company+Mapping) for more information."
26744
+ },
26745
+ "DirectoryDataSet": {
26746
+ "enum": [
26747
+ 0,
26748
+ 1,
26749
+ 2
26750
+ ],
26751
+ "type": "integer",
26752
+ "description": "Different dataset types to retrieve information from the Directory Service",
26753
+ "format": "int32"
26754
+ },
25660
26755
  "DpoSummaryGroupTotalModel": {
25661
26756
  "type": "object",
25662
26757
  "properties": {
@@ -25899,6 +26994,118 @@
25899
26994
  "description": "Possible statuses for a record that supports ERP write.",
25900
26995
  "format": "int32"
25901
26996
  },
26997
+ "ExternalConnector": {
26998
+ "type": "object",
26999
+ "properties": {
27000
+ "id": {
27001
+ "type": "string",
27002
+ "description": "External Connector ID",
27003
+ "nullable": true
27004
+ },
27005
+ "name": {
27006
+ "type": "string",
27007
+ "description": "External connector name",
27008
+ "nullable": true
27009
+ },
27010
+ "onboardingUrl": {
27011
+ "type": "string",
27012
+ "description": "URL to start onboarding with the given external connector",
27013
+ "nullable": true
27014
+ },
27015
+ "description": {
27016
+ "type": "string",
27017
+ "description": "Information about the external connector.",
27018
+ "nullable": true
27019
+ },
27020
+ "categories": {
27021
+ "type": "array",
27022
+ "items": {
27023
+ "type": "string"
27024
+ },
27025
+ "description": "Categories external connector is associated with",
27026
+ "nullable": true
27027
+ }
27028
+ },
27029
+ "additionalProperties": false,
27030
+ "description": "An ExternalConnector represents a third-party provider available to customers within Sage Service Fabric. When a customer\r\nstarts and completes the authentication process with an external connector, they obtain an AppEnrollment which represents\r\nthe customer's instance of this ExternalConnector. The customer-specific AppEnrollment contains a customer's configuration data\r\nfor the ExternalConnector, which is not customer-specific."
27031
+ },
27032
+ "ExternalConnectorAuth": {
27033
+ "type": "object",
27034
+ "properties": {
27035
+ "authenticationUrl": {
27036
+ "type": "string",
27037
+ "description": "The URL to open a browser with. This begins the user authentication process driven by a provider.",
27038
+ "nullable": true
27039
+ }
27040
+ },
27041
+ "additionalProperties": false,
27042
+ "description": "An ExternalConnectorAuth represents the authentication starting point of the Sage Connections Service workflow to connect\r\nthe customer to an external connector."
27043
+ },
27044
+ "ExternalConnectorAuthRequest": {
27045
+ "type": "object",
27046
+ "properties": {
27047
+ "scopes": {
27048
+ "type": "array",
27049
+ "items": {
27050
+ "type": "string"
27051
+ },
27052
+ "description": "An array of scopes requested from 3rd-party provider.",
27053
+ "nullable": true
27054
+ },
27055
+ "redirectUrl": {
27056
+ "type": "string",
27057
+ "description": "The URL the browser is redirected to after a user grants, or denies, permissions for Sage software.",
27058
+ "nullable": true
27059
+ },
27060
+ "connectionContextId": {
27061
+ "type": "string",
27062
+ "description": "Opaque value that a secret will be tagged with on the service side when created",
27063
+ "nullable": true
27064
+ }
27065
+ },
27066
+ "additionalProperties": false,
27067
+ "description": "An ExternalConnectorAuthRequest represents the information how an external connector authentication url should be\r\ngenerated and the access the customer should have with the external connector."
27068
+ },
27069
+ "ExternalConnectorToken": {
27070
+ "type": "object",
27071
+ "properties": {
27072
+ "id": {
27073
+ "type": "string",
27074
+ "description": "ID of the token reference.",
27075
+ "nullable": true
27076
+ },
27077
+ "authenticatedAt": {
27078
+ "type": "string",
27079
+ "description": "When the user was authenticated.",
27080
+ "format": "date-time"
27081
+ },
27082
+ "scopes": {
27083
+ "type": "array",
27084
+ "items": {
27085
+ "type": "string"
27086
+ },
27087
+ "description": "An array of scopes requested from 3rd-party external connector.",
27088
+ "nullable": true
27089
+ },
27090
+ "expiresAt": {
27091
+ "type": "string",
27092
+ "description": "When the token expires. This can be earlier if the token is revoked.",
27093
+ "format": "date-time"
27094
+ },
27095
+ "externalConnectorId": {
27096
+ "type": "string",
27097
+ "description": "External Connector ID",
27098
+ "nullable": true
27099
+ },
27100
+ "connectionContextId": {
27101
+ "type": "string",
27102
+ "description": "Connection context ID set by the product when starting onboarding with a external connector",
27103
+ "nullable": true
27104
+ }
27105
+ },
27106
+ "additionalProperties": false,
27107
+ "description": "An ExternalConnectorToken represents the token information for a customer's valid, expired or revoked connection to\r\nan external connector."
27108
+ },
25902
27109
  "FeatureFlagsRequestModel": {
25903
27110
  "type": "object",
25904
27111
  "properties": {
@@ -26250,13 +27457,6 @@
26250
27457
  "FinancialAccountModelFetchResult": {
26251
27458
  "type": "object",
26252
27459
  "properties": {
26253
- "records": {
26254
- "type": "array",
26255
- "items": {
26256
- "$ref": "#/components/schemas/FinancialAccountModel"
26257
- },
26258
- "nullable": true
26259
- },
26260
27460
  "totalCount": {
26261
27461
  "type": "integer",
26262
27462
  "format": "int32",
@@ -26271,6 +27471,13 @@
26271
27471
  "type": "integer",
26272
27472
  "format": "int32",
26273
27473
  "nullable": true
27474
+ },
27475
+ "records": {
27476
+ "type": "array",
27477
+ "items": {
27478
+ "$ref": "#/components/schemas/FinancialAccountModel"
27479
+ },
27480
+ "nullable": true
26274
27481
  }
26275
27482
  },
26276
27483
  "additionalProperties": false
@@ -27397,13 +28604,6 @@
27397
28604
  "InvoiceLineModelFetchResult": {
27398
28605
  "type": "object",
27399
28606
  "properties": {
27400
- "records": {
27401
- "type": "array",
27402
- "items": {
27403
- "$ref": "#/components/schemas/InvoiceLineModel"
27404
- },
27405
- "nullable": true
27406
- },
27407
28607
  "totalCount": {
27408
28608
  "type": "integer",
27409
28609
  "format": "int32",
@@ -27418,6 +28618,13 @@
27418
28618
  "type": "integer",
27419
28619
  "format": "int32",
27420
28620
  "nullable": true
28621
+ },
28622
+ "records": {
28623
+ "type": "array",
28624
+ "items": {
28625
+ "$ref": "#/components/schemas/InvoiceLineModel"
28626
+ },
28627
+ "nullable": true
27421
28628
  }
27422
28629
  },
27423
28630
  "additionalProperties": false
@@ -28026,12 +29233,6 @@
28026
29233
  "InvoiceModelFetchResult": {
28027
29234
  "type": "object",
28028
29235
  "properties": {
28029
- "records": {
28030
- "type": "array",
28031
- "items": { },
28032
- "description": " For more information on Invoices, see [InvoiceModel](https://developer.lockstep.io/reference/get_api-v1-invoices-id).",
28033
- "nullable": true
28034
- },
28035
29236
  "totalCount": {
28036
29237
  "type": "integer",
28037
29238
  "format": "int32",
@@ -28046,6 +29247,12 @@
28046
29247
  "type": "integer",
28047
29248
  "format": "int32",
28048
29249
  "nullable": true
29250
+ },
29251
+ "records": {
29252
+ "type": "array",
29253
+ "items": { },
29254
+ "description": " For more information on Invoices, see [InvoiceModel](https://developer.lockstep.io/reference/get_api-v1-invoices-id).",
29255
+ "nullable": true
28049
29256
  }
28050
29257
  },
28051
29258
  "additionalProperties": false
@@ -28295,13 +29502,6 @@
28295
29502
  "InvoiceSummaryModelInvoiceSummaryTotalsModelSummaryFetchResult": {
28296
29503
  "type": "object",
28297
29504
  "properties": {
28298
- "records": {
28299
- "type": "array",
28300
- "items": {
28301
- "$ref": "#/components/schemas/InvoiceSummaryModel"
28302
- },
28303
- "nullable": true
28304
- },
28305
29505
  "totalCount": {
28306
29506
  "type": "integer",
28307
29507
  "format": "int32",
@@ -28317,6 +29517,13 @@
28317
29517
  "format": "int32",
28318
29518
  "nullable": true
28319
29519
  },
29520
+ "records": {
29521
+ "type": "array",
29522
+ "items": {
29523
+ "$ref": "#/components/schemas/InvoiceSummaryModel"
29524
+ },
29525
+ "nullable": true
29526
+ },
28320
29527
  "summary": {
28321
29528
  "allOf": [
28322
29529
  {
@@ -28688,6 +29895,302 @@
28688
29895
  "additionalProperties": false,
28689
29896
  "description": "The InvoiceSyncModel represents information coming into Lockstep from an external financial system or other\r\nenterprise resource planning system. To import data from an external system, convert your original data into\r\nthe InvoiceSyncModel format and call the [Upload Sync File API](https://developer.lockstep.io/reference/post_api-v1-sync-zip).\r\nThis API retrieves all of the data you uploaded in a compressed ZIP file and imports it into the Lockstep\r\nplatform.\r\n \r\nOnce imported, this record will be available in the Lockstep API as an [InvoiceModel](https://developer.lockstep.io/docs/invoicemodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)."
28690
29897
  },
29898
+ "JournalEntryLineModel": {
29899
+ "type": "object",
29900
+ "properties": {
29901
+ "journalEntryLineId": {
29902
+ "type": "string",
29903
+ "description": "The unique ID of this record, automatically assigned by Lockstep when this record is\r\nadded to the Lockstep platform.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.",
29904
+ "format": "uuid",
29905
+ "readOnly": true
29906
+ },
29907
+ "journalEntryId": {
29908
+ "type": "string",
29909
+ "description": "The Journal Entry with which this line is associated.",
29910
+ "format": "uuid"
29911
+ },
29912
+ "groupKey": {
29913
+ "type": "string",
29914
+ "description": "The GroupKey uniquely identifies a single Lockstep Platform account. All records for this\r\naccount will share the same GroupKey value. GroupKey values cannot be changed once created.\r\n \r\nFor more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).",
29915
+ "format": "uuid",
29916
+ "readOnly": true
29917
+ },
29918
+ "appEnrollmentId": {
29919
+ "type": "string",
29920
+ "description": "The AppEnrollmentId of the application that imported this record. For accounts\r\nwith more than one financial system connected, this field identifies the originating\r\nfinancial system that produced this record. This value is null if this record\r\nwas not loaded from an external ERP or financial system.",
29921
+ "format": "uuid",
29922
+ "nullable": true,
29923
+ "readOnly": true
29924
+ },
29925
+ "erpKey": {
29926
+ "type": "string",
29927
+ "description": "The unique ID of this record as it was known in its originating financial system.\r\n \r\nIf this journal entry record was imported from a financial system, it will have the value `ErpKey`\r\nset to the original primary key number of the record as it was known in the originating financial\r\nsystem. If this record was not imported, this value will be `null`.\r\n \r\nFor more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).",
29928
+ "nullable": true
29929
+ },
29930
+ "financialAccountId": {
29931
+ "type": "string",
29932
+ "description": "The Financial Account with which this line is associated.",
29933
+ "format": "uuid",
29934
+ "nullable": true
29935
+ },
29936
+ "accountNumber": {
29937
+ "type": "string",
29938
+ "description": "The unique code/identifier assigned to each account in the chart of accounts.",
29939
+ "nullable": true
29940
+ },
29941
+ "accountName": {
29942
+ "type": "string",
29943
+ "description": "The name of the account.",
29944
+ "nullable": true
29945
+ },
29946
+ "debit": {
29947
+ "type": "number",
29948
+ "description": "Debit to account.",
29949
+ "format": "double"
29950
+ },
29951
+ "credit": {
29952
+ "type": "number",
29953
+ "description": "Credit to account.",
29954
+ "format": "double"
29955
+ },
29956
+ "currency": {
29957
+ "maxLength": 3,
29958
+ "minLength": 0,
29959
+ "type": "string",
29960
+ "description": "The transaction currency in which the entry is recorded, especially useful for multi-currency environments.",
29961
+ "nullable": true
29962
+ },
29963
+ "baseDebit": {
29964
+ "type": "number",
29965
+ "description": "The base currency debit amount for the account.",
29966
+ "format": "double"
29967
+ },
29968
+ "baseCredit": {
29969
+ "type": "number",
29970
+ "description": "The base currency credit amount for the account.",
29971
+ "format": "double"
29972
+ },
29973
+ "baseCurrency": {
29974
+ "maxLength": 3,
29975
+ "minLength": 0,
29976
+ "type": "string",
29977
+ "description": "The base currency in which the entry is recorded, especially useful for multi-currency environments.",
29978
+ "nullable": true
29979
+ },
29980
+ "sourceCreatedUser": {
29981
+ "type": "string",
29982
+ "description": "The ERP’s identifier for the user who recorded the journal entry line.",
29983
+ "nullable": true
29984
+ },
29985
+ "memo": {
29986
+ "type": "string",
29987
+ "description": "A memo related to this line.",
29988
+ "nullable": true
29989
+ },
29990
+ "created": {
29991
+ "type": "string",
29992
+ "description": "The date that the journal entry line was created.",
29993
+ "format": "date-time",
29994
+ "readOnly": true
29995
+ },
29996
+ "createdUserId": {
29997
+ "type": "string",
29998
+ "description": "The ID of the user who created the journal entry line.",
29999
+ "format": "uuid",
30000
+ "readOnly": true
30001
+ },
30002
+ "modified": {
30003
+ "type": "string",
30004
+ "description": "The date that the journal entry line was last modified.",
30005
+ "format": "date-time",
30006
+ "readOnly": true
30007
+ },
30008
+ "modifiedUserId": {
30009
+ "type": "string",
30010
+ "description": "The ID of the user who last modified the journal entry line.",
30011
+ "format": "uuid",
30012
+ "readOnly": true
30013
+ }
30014
+ },
30015
+ "additionalProperties": false,
30016
+ "description": "Contains information about a journal entry line"
30017
+ },
30018
+ "JournalEntryModel": {
30019
+ "type": "object",
30020
+ "properties": {
30021
+ "journalEntryId": {
30022
+ "type": "string",
30023
+ "description": "The unique ID of this record, automatically assigned by Lockstep when this record is\r\nadded to the Lockstep platform.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.",
30024
+ "format": "uuid",
30025
+ "readOnly": true
30026
+ },
30027
+ "groupKey": {
30028
+ "type": "string",
30029
+ "description": "The GroupKey uniquely identifies a single Lockstep Platform account. All records for this\r\naccount will share the same GroupKey value. GroupKey values cannot be changed once created.\r\n \r\nFor more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).",
30030
+ "format": "uuid",
30031
+ "readOnly": true
30032
+ },
30033
+ "appEnrollmentId": {
30034
+ "type": "string",
30035
+ "description": "The AppEnrollmentId of the application that imported this record. For accounts\r\nwith more than one financial system connected, this field identifies the originating\r\nfinancial system that produced this record. This value is null if this record\r\nwas not loaded from an external ERP or financial system.",
30036
+ "format": "uuid",
30037
+ "nullable": true,
30038
+ "readOnly": true
30039
+ },
30040
+ "erpKey": {
30041
+ "type": "string",
30042
+ "description": "The unique ID of this record as it was known in its originating financial system.\r\n \r\nIf this journal entry record was imported from a financial system, it will have the value `ErpKey`\r\nset to the original primary key number of the record as it was known in the originating financial\r\nsystem. If this record was not imported, this value will be `null`.\r\n \r\nFor more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).",
30043
+ "nullable": true
30044
+ },
30045
+ "journalId": {
30046
+ "type": "string",
30047
+ "description": "The ERP’s identifier for this journal entry, usually has meaning to the user.\r\nMay be the same value of the ERP Key.",
30048
+ "nullable": true
30049
+ },
30050
+ "source": {
30051
+ "allOf": [
30052
+ {
30053
+ "$ref": "#/components/schemas/JournalEntrySource"
30054
+ }
30055
+ ],
30056
+ "description": "Possible sources for a Journal Entry.",
30057
+ "readOnly": true
30058
+ },
30059
+ "postingDate": {
30060
+ "type": "string",
30061
+ "description": "The UTC date and time when this journal entry was posted.",
30062
+ "format": "date-time",
30063
+ "readOnly": true
30064
+ },
30065
+ "status": {
30066
+ "allOf": [
30067
+ {
30068
+ "$ref": "#/components/schemas/JournalEntryStatus"
30069
+ }
30070
+ ],
30071
+ "description": "Possible statuses for a Journal Entry.",
30072
+ "readOnly": true
30073
+ },
30074
+ "description": {
30075
+ "type": "string",
30076
+ "description": "A brief description explaining the purpose of the journal entry.",
30077
+ "nullable": true
30078
+ },
30079
+ "comment": {
30080
+ "type": "string",
30081
+ "description": "An additional comment related to the entry.",
30082
+ "nullable": true
30083
+ },
30084
+ "referenceNumber": {
30085
+ "type": "string",
30086
+ "description": "Any reference number or identifier associated with the entry, such as an invoice number or purchase order.",
30087
+ "nullable": true
30088
+ },
30089
+ "sourcePostingDate": {
30090
+ "type": "string",
30091
+ "description": "The raw posting date from the source.",
30092
+ "format": "date-time",
30093
+ "readOnly": true
30094
+ },
30095
+ "created": {
30096
+ "type": "string",
30097
+ "description": "The date that the journal entry was created.",
30098
+ "format": "date-time",
30099
+ "readOnly": true
30100
+ },
30101
+ "createdUserId": {
30102
+ "type": "string",
30103
+ "description": "The ID of the user who created the journal entry.",
30104
+ "format": "uuid",
30105
+ "readOnly": true
30106
+ },
30107
+ "modified": {
30108
+ "type": "string",
30109
+ "description": "The date that the journal entry was last modified.",
30110
+ "format": "date-time",
30111
+ "readOnly": true
30112
+ },
30113
+ "modifiedUserId": {
30114
+ "type": "string",
30115
+ "description": "The ID of the user who last modified the journal entry.",
30116
+ "format": "uuid",
30117
+ "readOnly": true
30118
+ },
30119
+ "lines": {
30120
+ "type": "array",
30121
+ "items": {
30122
+ "$ref": "#/components/schemas/JournalEntryLineModel"
30123
+ },
30124
+ "description": "All lines attached to this journal entry.\r\nTo retrieve this collection, specify `Lines` in the \"Include\" parameter for your query.",
30125
+ "nullable": true
30126
+ },
30127
+ "attachments": {
30128
+ "type": "array",
30129
+ "items": {
30130
+ "$ref": "#/components/schemas/AttachmentModel"
30131
+ },
30132
+ "description": "A collection of attachments linked to this record. To retrieve this collection, specify `Attachments` in\r\nthe `include` parameter when retrieving data.\r\n \r\nTo create an attachment, use the [Upload Attachment](https://developer.lockstep.io/reference/post_api-v1-attachments)\r\nendpoint with the `TableKey` to `Invoice` and the `ObjectKey` set to the `InvoiceId` for this record. For\r\nmore information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).",
30133
+ "nullable": true,
30134
+ "readOnly": true
30135
+ }
30136
+ },
30137
+ "additionalProperties": false,
30138
+ "description": "Contains information about a journal entry"
30139
+ },
30140
+ "JournalEntryModelFetchResult": {
30141
+ "type": "object",
30142
+ "properties": {
30143
+ "totalCount": {
30144
+ "type": "integer",
30145
+ "format": "int32",
30146
+ "nullable": true
30147
+ },
30148
+ "pageSize": {
30149
+ "type": "integer",
30150
+ "format": "int32",
30151
+ "nullable": true
30152
+ },
30153
+ "pageNumber": {
30154
+ "type": "integer",
30155
+ "format": "int32",
30156
+ "nullable": true
30157
+ },
30158
+ "records": {
30159
+ "type": "array",
30160
+ "items": {
30161
+ "$ref": "#/components/schemas/JournalEntryModel"
30162
+ },
30163
+ "nullable": true
30164
+ }
30165
+ },
30166
+ "additionalProperties": false
30167
+ },
30168
+ "JournalEntrySource": {
30169
+ "enum": [
30170
+ 0,
30171
+ 1,
30172
+ 2,
30173
+ 3,
30174
+ 4,
30175
+ 5,
30176
+ 6,
30177
+ 7,
30178
+ 8
30179
+ ],
30180
+ "type": "integer",
30181
+ "description": "Possible sources for a Journal Entry.",
30182
+ "format": "int32"
30183
+ },
30184
+ "JournalEntryStatus": {
30185
+ "enum": [
30186
+ 0,
30187
+ 1,
30188
+ 2
30189
+ ],
30190
+ "type": "integer",
30191
+ "description": "Possible statuses for a Journal Entry.",
30192
+ "format": "int32"
30193
+ },
28691
30194
  "LeadModel": {
28692
30195
  "required": [
28693
30196
  "name"
@@ -28830,6 +30333,21 @@
28830
30333
  "description": "The user associated with this magic link.\r\nTo retrieve this item, specify `User` in the \"Include\" parameter for your query.",
28831
30334
  "nullable": true,
28832
30335
  "readOnly": true
30336
+ },
30337
+ "visits": {
30338
+ "type": "integer",
30339
+ "description": "The number of visits to this Magic Link",
30340
+ "format": "int32",
30341
+ "readOnly": true
30342
+ },
30343
+ "status": {
30344
+ "allOf": [
30345
+ {
30346
+ "$ref": "#/components/schemas/MagicLinkStatus"
30347
+ }
30348
+ ],
30349
+ "description": "Possible statuses for a Magic Link.",
30350
+ "readOnly": true
28833
30351
  }
28834
30352
  },
28835
30353
  "additionalProperties": false,
@@ -28838,13 +30356,6 @@
28838
30356
  "MagicLinkModelFetchResult": {
28839
30357
  "type": "object",
28840
30358
  "properties": {
28841
- "records": {
28842
- "type": "array",
28843
- "items": {
28844
- "$ref": "#/components/schemas/MagicLinkModel"
28845
- },
28846
- "nullable": true
28847
- },
28848
30359
  "totalCount": {
28849
30360
  "type": "integer",
28850
30361
  "format": "int32",
@@ -28859,10 +30370,29 @@
28859
30370
  "type": "integer",
28860
30371
  "format": "int32",
28861
30372
  "nullable": true
30373
+ },
30374
+ "records": {
30375
+ "type": "array",
30376
+ "items": {
30377
+ "$ref": "#/components/schemas/MagicLinkModel"
30378
+ },
30379
+ "nullable": true
28862
30380
  }
28863
30381
  },
28864
30382
  "additionalProperties": false
28865
30383
  },
30384
+ "MagicLinkStatus": {
30385
+ "enum": [
30386
+ 0,
30387
+ 1,
30388
+ 2,
30389
+ 3,
30390
+ 4
30391
+ ],
30392
+ "type": "integer",
30393
+ "description": "Possible statuses for a Magic Link.",
30394
+ "format": "int32"
30395
+ },
28866
30396
  "MagicLinkStatusModel": {
28867
30397
  "type": "object",
28868
30398
  "properties": {
@@ -28896,6 +30426,33 @@
28896
30426
  "additionalProperties": false,
28897
30427
  "description": "Contains information about the user's magic link"
28898
30428
  },
30429
+ "MagicLinkSummaryModel": {
30430
+ "type": "object",
30431
+ "properties": {
30432
+ "groupKey": {
30433
+ "type": "string",
30434
+ "description": "Group that the summary is for",
30435
+ "format": "uuid"
30436
+ },
30437
+ "totalCount": {
30438
+ "type": "integer",
30439
+ "description": "Total number of magic links sent",
30440
+ "format": "int32"
30441
+ },
30442
+ "totalBounced": {
30443
+ "type": "integer",
30444
+ "description": "Total number of magic links that failed to send",
30445
+ "format": "int32"
30446
+ },
30447
+ "totalVisited": {
30448
+ "type": "integer",
30449
+ "description": "Total number of visits across all magic links",
30450
+ "format": "int32"
30451
+ }
30452
+ },
30453
+ "additionalProperties": false,
30454
+ "description": "A historic summary of all magic links sent in a given group"
30455
+ },
28899
30456
  "MatchAction": {
28900
30457
  "enum": [
28901
30458
  0,
@@ -28941,13 +30498,15 @@
28941
30498
  "maxLength": 40,
28942
30499
  "minLength": 1,
28943
30500
  "type": "string",
28944
- "description": "A Note is connected to an existing item within the Lockstep Platform by the fields `TableKey` and\r\n`ObjectKey`. For example, a Note connected to Invoice 12345 would have a `TableKey` value of\r\n`Invoice` and an `ObjectKey` value of `12345`.\r\n \r\nThe `TableKey` value contains the name of the table within the Lockstep Platform to which this metadata\r\nis connected.\r\n \r\nFor more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object)."
30501
+ "description": "A Note is connected to an existing item within the Lockstep Platform by the fields `TableKey` and\r\n`ObjectKey`. For example, a Note connected to Invoice 12345 would have a `TableKey` value of\r\n`Invoice` and an `ObjectKey` value of `12345`.\r\n \r\nThe `TableKey` value contains the name of the table within the Lockstep Platform to which this metadata\r\nis connected.\r\n \r\nFor more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).",
30502
+ "readOnly": true
28945
30503
  },
28946
30504
  "objectKey": {
28947
30505
  "minLength": 1,
28948
30506
  "type": "string",
28949
30507
  "description": "A Note is connected to an existing item within the Lockstep Platform by the fields `TableKey` and\r\n`ObjectKey`. For example, a Note connected to Invoice 12345 would have a `TableKey` value of\r\n`Invoice` and an `ObjectKey` value of `12345`.\r\n \r\nThe `ObjectKey` value contains the primary key of the record within the Lockstep Platform to which this\r\nmetadata is connected.\r\n \r\nFor more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).",
28950
- "format": "uuid"
30508
+ "format": "uuid",
30509
+ "readOnly": true
28951
30510
  },
28952
30511
  "noteText": {
28953
30512
  "maxLength": 1000,
@@ -28978,6 +30537,18 @@
28978
30537
  "format": "uuid",
28979
30538
  "readOnly": true
28980
30539
  },
30540
+ "modified": {
30541
+ "type": "string",
30542
+ "description": "The date this note was last modified",
30543
+ "format": "date-time",
30544
+ "readOnly": true
30545
+ },
30546
+ "modifiedUserId": {
30547
+ "type": "string",
30548
+ "description": "The ID of the user who last modified this note",
30549
+ "format": "uuid",
30550
+ "readOnly": true
30551
+ },
28981
30552
  "createdUserName": {
28982
30553
  "type": "string",
28983
30554
  "description": "The name of the user who created the note",
@@ -29004,13 +30575,6 @@
29004
30575
  "NoteModelFetchResult": {
29005
30576
  "type": "object",
29006
30577
  "properties": {
29007
- "records": {
29008
- "type": "array",
29009
- "items": {
29010
- "$ref": "#/components/schemas/NoteModel"
29011
- },
29012
- "nullable": true
29013
- },
29014
30578
  "totalCount": {
29015
30579
  "type": "integer",
29016
30580
  "format": "int32",
@@ -29025,6 +30589,13 @@
29025
30589
  "type": "integer",
29026
30590
  "format": "int32",
29027
30591
  "nullable": true
30592
+ },
30593
+ "records": {
30594
+ "type": "array",
30595
+ "items": {
30596
+ "$ref": "#/components/schemas/NoteModel"
30597
+ },
30598
+ "nullable": true
29028
30599
  }
29029
30600
  },
29030
30601
  "additionalProperties": false
@@ -29389,13 +30960,6 @@
29389
30960
  "PaymentAppliedModelFetchResult": {
29390
30961
  "type": "object",
29391
30962
  "properties": {
29392
- "records": {
29393
- "type": "array",
29394
- "items": {
29395
- "$ref": "#/components/schemas/PaymentAppliedModel"
29396
- },
29397
- "nullable": true
29398
- },
29399
30963
  "totalCount": {
29400
30964
  "type": "integer",
29401
30965
  "format": "int32",
@@ -29410,6 +30974,13 @@
29410
30974
  "type": "integer",
29411
30975
  "format": "int32",
29412
30976
  "nullable": true
30977
+ },
30978
+ "records": {
30979
+ "type": "array",
30980
+ "items": {
30981
+ "$ref": "#/components/schemas/PaymentAppliedModel"
30982
+ },
30983
+ "nullable": true
29413
30984
  }
29414
30985
  },
29415
30986
  "additionalProperties": false
@@ -29691,13 +31262,6 @@
29691
31262
  "PaymentDetailModelFetchResult": {
29692
31263
  "type": "object",
29693
31264
  "properties": {
29694
- "records": {
29695
- "type": "array",
29696
- "items": {
29697
- "$ref": "#/components/schemas/PaymentDetailModel"
29698
- },
29699
- "nullable": true
29700
- },
29701
31265
  "totalCount": {
29702
31266
  "type": "integer",
29703
31267
  "format": "int32",
@@ -29712,6 +31276,13 @@
29712
31276
  "type": "integer",
29713
31277
  "format": "int32",
29714
31278
  "nullable": true
31279
+ },
31280
+ "records": {
31281
+ "type": "array",
31282
+ "items": {
31283
+ "$ref": "#/components/schemas/PaymentDetailModel"
31284
+ },
31285
+ "nullable": true
29715
31286
  }
29716
31287
  },
29717
31288
  "additionalProperties": false
@@ -30031,13 +31602,6 @@
30031
31602
  "PaymentModelFetchResult": {
30032
31603
  "type": "object",
30033
31604
  "properties": {
30034
- "records": {
30035
- "type": "array",
30036
- "items": {
30037
- "$ref": "#/components/schemas/PaymentModel"
30038
- },
30039
- "nullable": true
30040
- },
30041
31605
  "totalCount": {
30042
31606
  "type": "integer",
30043
31607
  "format": "int32",
@@ -30052,6 +31616,13 @@
30052
31616
  "type": "integer",
30053
31617
  "format": "int32",
30054
31618
  "nullable": true
31619
+ },
31620
+ "records": {
31621
+ "type": "array",
31622
+ "items": {
31623
+ "$ref": "#/components/schemas/PaymentModel"
31624
+ },
31625
+ "nullable": true
30055
31626
  }
30056
31627
  },
30057
31628
  "additionalProperties": false
@@ -30387,13 +31958,6 @@
30387
31958
  "PaymentSummaryModelPaymentSummaryTotalsModelSummaryFetchResult": {
30388
31959
  "type": "object",
30389
31960
  "properties": {
30390
- "records": {
30391
- "type": "array",
30392
- "items": {
30393
- "$ref": "#/components/schemas/PaymentSummaryModel"
30394
- },
30395
- "nullable": true
30396
- },
30397
31961
  "totalCount": {
30398
31962
  "type": "integer",
30399
31963
  "format": "int32",
@@ -30409,6 +31973,13 @@
30409
31973
  "format": "int32",
30410
31974
  "nullable": true
30411
31975
  },
31976
+ "records": {
31977
+ "type": "array",
31978
+ "items": {
31979
+ "$ref": "#/components/schemas/PaymentSummaryModel"
31980
+ },
31981
+ "nullable": true
31982
+ },
30412
31983
  "summary": {
30413
31984
  "allOf": [
30414
31985
  {
@@ -32364,13 +33935,6 @@
32364
33935
  "SyncRequestModelFetchResult": {
32365
33936
  "type": "object",
32366
33937
  "properties": {
32367
- "records": {
32368
- "type": "array",
32369
- "items": {
32370
- "$ref": "#/components/schemas/SyncRequestModel"
32371
- },
32372
- "nullable": true
32373
- },
32374
33938
  "totalCount": {
32375
33939
  "type": "integer",
32376
33940
  "format": "int32",
@@ -32385,6 +33949,13 @@
32385
33949
  "type": "integer",
32386
33950
  "format": "int32",
32387
33951
  "nullable": true
33952
+ },
33953
+ "records": {
33954
+ "type": "array",
33955
+ "items": {
33956
+ "$ref": "#/components/schemas/SyncRequestModel"
33957
+ },
33958
+ "nullable": true
32388
33959
  }
32389
33960
  },
32390
33961
  "additionalProperties": false
@@ -32593,6 +34164,11 @@
32593
34164
  "supportsErpPdfRetrieval": {
32594
34165
  "type": "boolean",
32595
34166
  "description": "Specific transactions have support for pdf retrieval from their respective erp. When this flag is true, an additional\r\ncall to Invoices/{id}/pdf or Payments/{id}/pdf can be made to retrieve a pdf directly from the erp."
34167
+ },
34168
+ "transactionCustomerId": {
34169
+ "type": "string",
34170
+ "description": "The customer associated with this transaction",
34171
+ "format": "uuid"
32596
34172
  }
32597
34173
  },
32598
34174
  "additionalProperties": false,
@@ -32601,13 +34177,6 @@
32601
34177
  "TransactionModelTransactionSummaryTotalModelSummaryFetchResult": {
32602
34178
  "type": "object",
32603
34179
  "properties": {
32604
- "records": {
32605
- "type": "array",
32606
- "items": {
32607
- "$ref": "#/components/schemas/TransactionModel"
32608
- },
32609
- "nullable": true
32610
- },
32611
34180
  "totalCount": {
32612
34181
  "type": "integer",
32613
34182
  "format": "int32",
@@ -32623,6 +34192,13 @@
32623
34192
  "format": "int32",
32624
34193
  "nullable": true
32625
34194
  },
34195
+ "records": {
34196
+ "type": "array",
34197
+ "items": {
34198
+ "$ref": "#/components/schemas/TransactionModel"
34199
+ },
34200
+ "nullable": true
34201
+ },
32626
34202
  "summary": {
32627
34203
  "allOf": [
32628
34204
  {
@@ -33250,13 +34826,6 @@
33250
34826
  "UserAccountModelFetchResult": {
33251
34827
  "type": "object",
33252
34828
  "properties": {
33253
- "records": {
33254
- "type": "array",
33255
- "items": {
33256
- "$ref": "#/components/schemas/UserAccountModel"
33257
- },
33258
- "nullable": true
33259
- },
33260
34829
  "totalCount": {
33261
34830
  "type": "integer",
33262
34831
  "format": "int32",
@@ -33271,6 +34840,13 @@
33271
34840
  "type": "integer",
33272
34841
  "format": "int32",
33273
34842
  "nullable": true
34843
+ },
34844
+ "records": {
34845
+ "type": "array",
34846
+ "items": {
34847
+ "$ref": "#/components/schemas/UserAccountModel"
34848
+ },
34849
+ "nullable": true
33274
34850
  }
33275
34851
  },
33276
34852
  "additionalProperties": false
@@ -33379,13 +34955,6 @@
33379
34955
  "UserRoleModelFetchResult": {
33380
34956
  "type": "object",
33381
34957
  "properties": {
33382
- "records": {
33383
- "type": "array",
33384
- "items": {
33385
- "$ref": "#/components/schemas/UserRoleModel"
33386
- },
33387
- "nullable": true
33388
- },
33389
34958
  "totalCount": {
33390
34959
  "type": "integer",
33391
34960
  "format": "int32",
@@ -33400,6 +34969,13 @@
33400
34969
  "type": "integer",
33401
34970
  "format": "int32",
33402
34971
  "nullable": true
34972
+ },
34973
+ "records": {
34974
+ "type": "array",
34975
+ "items": {
34976
+ "$ref": "#/components/schemas/UserRoleModel"
34977
+ },
34978
+ "nullable": true
33403
34979
  }
33404
34980
  },
33405
34981
  "additionalProperties": false
@@ -33565,13 +35141,6 @@
33565
35141
  "VendorSummaryModelFetchResult": {
33566
35142
  "type": "object",
33567
35143
  "properties": {
33568
- "records": {
33569
- "type": "array",
33570
- "items": {
33571
- "$ref": "#/components/schemas/VendorSummaryModel"
33572
- },
33573
- "nullable": true
33574
- },
33575
35144
  "totalCount": {
33576
35145
  "type": "integer",
33577
35146
  "format": "int32",
@@ -33586,6 +35155,13 @@
33586
35155
  "type": "integer",
33587
35156
  "format": "int32",
33588
35157
  "nullable": true
35158
+ },
35159
+ "records": {
35160
+ "type": "array",
35161
+ "items": {
35162
+ "$ref": "#/components/schemas/VendorSummaryModel"
35163
+ },
35164
+ "nullable": true
33589
35165
  }
33590
35166
  },
33591
35167
  "additionalProperties": false