lockstep_rails 0.3.67 → 0.3.68

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b9caa7796257df2cf09f394b6ab631e4922b2a8f0c0419e5d5213b5ffc4ad878
4
- data.tar.gz: cbb88f32896582f39526be39488360a836202ee7fce260a990a983a1d067c219
3
+ metadata.gz: 30bd1402599f256e2ddbf905c1a69109c6ced07b14fcca59e0e9c89aab48bf3c
4
+ data.tar.gz: 314ca2d138cb0612b223857a084b259acf5d28485d30806b464fb9ca572a546a
5
5
  SHA512:
6
- metadata.gz: 4ee749d754595dfaa1bea76fd3c1f477d572f13193596952a905c1fefb70d12f822f7d2f843678d4736125b2cf500339481865f6120ba3b85347ae36f91e038e
7
- data.tar.gz: e5eae79797f82b4f0cee3878c2bff602456e5362ad023f1c6f08f68aefe3a62797f5d7acc3fbe0e3d5fee0dd2237f2154a276d7a9fb0e605fd6612971c30c1f4
6
+ metadata.gz: 5f684eb6844a106cd5fae3d4cc1a6dc3dbcdb42a2977ec630087fb40a3629784fa2b085d119da69ac8cea104034df57451f3cf9ec7f4bfeafff76afef8f8772a
7
+ data.tar.gz: 7b9090e647a6707cfbf5ddd7169e16552cb73dc6396fba243c5bdb5a86f594ddb099fa5759da2f26f2b0cff84dd3def96a1a3160c7061c425676eae426e0e0f6
@@ -36,7 +36,8 @@ end
36
36
  # * `Group` - Only one record of type `GROUP` exists in each account. Contains your account profile.
37
37
  # * `Vendor` - This record represents a business entity that sells things to the account holder.
38
38
  # * `Third Party` - This record represents a business entity that is neither a customer nor vendor.
39
- # * `CustomerVendor` - Both a customer and a vendor.
39
+ # * `CustomerVendor` - Both a customer and a vendor.
40
+ # * `CompanyProfile` - Profile for a Company, each Company should have at most 1 profile, used only for Profile Management.
40
41
  # @type: string
41
42
  field :company_type
42
43
 
@@ -243,6 +244,11 @@ end
243
244
  # @type: string
244
245
  field :company_registration_number
245
246
 
247
+ # An optional reference to a real company, making this a profile.
248
+ # @type: string
249
+ # @format: uuid
250
+ field :profile_reference_id
251
+
246
252
  # All invoices attached to this company.
247
253
  #
248
254
  # To retrieve this collection, specify `Invoices` in the "Include" parameter for your query. For more information on Invoices, see [InvoiceModel](https://developer.lockstep.io/reference/get_api-v1-invoices-id).
@@ -5,10 +5,6 @@ def self.id_ref
5
5
  nil
6
6
  end
7
7
 
8
- # For more information on Invoices, see [InvoiceModel](https://developer.lockstep.io/reference/get_api-v1-invoices-id).
9
- # @type: array
10
- field :records
11
-
12
8
 
13
9
  # @type: integer
14
10
  # @format: int32
@@ -24,6 +20,8 @@ end
24
20
  # @format: int32
25
21
  field :page_number
26
22
 
27
-
28
-
29
- end
23
+ # For more information on Invoices, see [InvoiceModel](https://developer.lockstep.io/reference/get_api-v1-invoices-id).
24
+ # @type: array
25
+ field :records
26
+
27
+ end
@@ -5,38 +5,38 @@ def self.id_ref
5
5
  nil
6
6
  end
7
7
 
8
- # The unique ID of this record, automatically assigned by Lockstep when this record is
8
+ # The unique ID of this record, automatically assigned by Lockstep when this record is
9
9
  # added to the Lockstep platform.
10
10
  # @type: string
11
11
  # @format: uuid
12
12
  field :note_id
13
13
 
14
- # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
15
- # account will share the same GroupKey value. GroupKey values cannot be changed once created.
16
- #
14
+ # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
15
+ # account will share the same GroupKey value. GroupKey values cannot be changed once created.
16
+ #
17
17
  # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
18
18
  # @type: string
19
19
  # @format: uuid
20
20
  field :group_key
21
21
 
22
- # A Note is connected to an existing item within the Lockstep Platform by the fields `TableKey` and
23
- # `ObjectKey`. For example, a Note connected to Invoice 12345 would have a `TableKey` value of
24
- # `Invoice` and an `ObjectKey` value of `12345`.
25
- #
26
- # The `TableKey` value contains the name of the table within the Lockstep Platform to which this metadata
27
- # is connected.
28
- #
22
+ # A Note is connected to an existing item within the Lockstep Platform by the fields `TableKey` and
23
+ # `ObjectKey`. For example, a Note connected to Invoice 12345 would have a `TableKey` value of
24
+ # `Invoice` and an `ObjectKey` value of `12345`.
25
+ #
26
+ # The `TableKey` value contains the name of the table within the Lockstep Platform to which this metadata
27
+ # is connected.
28
+ #
29
29
  # For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
30
30
  # @type: string
31
31
  field :table_key
32
32
 
33
- # A Note is connected to an existing item within the Lockstep Platform by the fields `TableKey` and
34
- # `ObjectKey`. For example, a Note connected to Invoice 12345 would have a `TableKey` value of
35
- # `Invoice` and an `ObjectKey` value of `12345`.
36
- #
37
- # The `ObjectKey` value contains the primary key of the record within the Lockstep Platform to which this
38
- # metadata is connected.
39
- #
33
+ # A Note is connected to an existing item within the Lockstep Platform by the fields `TableKey` and
34
+ # `ObjectKey`. For example, a Note connected to Invoice 12345 would have a `TableKey` value of
35
+ # `Invoice` and an `ObjectKey` value of `12345`.
36
+ #
37
+ # The `ObjectKey` value contains the primary key of the record within the Lockstep Platform to which this
38
+ # metadata is connected.
39
+ #
40
40
  # For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
41
41
  # @type: string
42
42
  # @format: uuid
@@ -50,10 +50,10 @@ end
50
50
  # @type: string
51
51
  field :note_type
52
52
 
53
- # A flag indicating whether this Note is archived (also known as hidden or deleted). When you call
54
- # [ArchiveNote](https://developer.lockstep.io/reference/delete_api-v1-notes-id) this field will
55
- # be set to true.
56
- #
53
+ # A flag indicating whether this Note is archived (also known as hidden or deleted). When you call
54
+ # [ArchiveNote](https://developer.lockstep.io/reference/delete_api-v1-notes-id) this field will
55
+ # be set to true.
56
+ #
57
57
  # You should avoid displaying Notes with the IsArchived field set to true in your user interface.
58
58
  # @type: boolean
59
59
  field :is_archived
@@ -63,19 +63,29 @@ end
63
63
  # @format: date-time
64
64
  field :created, Types::Params::DateTime
65
65
 
66
- # The unique ID of the [UserAccount](https://developer.lockstep.io/docs/useraccountmodel) of the user
66
+ # The unique ID of the [UserAccount](https://developer.lockstep.io/docs/useraccountmodel) of the user
67
67
  # who created this Note.
68
68
  # @type: string
69
69
  # @format: uuid
70
70
  field :created_user_id
71
71
 
72
+ # The date this note was last modified
73
+ # @type: string
74
+ # @format: date-time
75
+ field :modified, Types::Params::DateTime
76
+
77
+ # The ID of the user who last modified this note
78
+ # @type: string
79
+ # @format: uuid
80
+ field :modified_user_id
81
+
72
82
  # The name of the user who created the note
73
83
  # @type: string
74
84
  field :created_user_name
75
85
 
76
- # The AppEnrollmentId of the application that imported this record. For accounts
77
- # with more than one financial system connected, this field identifies the originating
78
- # financial system that produced this record. This value is null if this record
86
+ # The AppEnrollmentId of the application that imported this record. For accounts
87
+ # with more than one financial system connected, this field identifies the originating
88
+ # financial system that produced this record. This value is null if this record
79
89
  # was not loaded from an external ERP or financial system.
80
90
  # @type: string
81
91
  # @format: uuid
@@ -86,6 +96,6 @@ end
86
96
  field :recipient_name
87
97
 
88
98
  belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
99
+ belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
89
100
 
90
-
91
- end
101
+ end
@@ -9744,7 +9744,7 @@
9744
9744
  "Invoices"
9745
9745
  ],
9746
9746
  "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.",
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.\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
9748
  "operationId": "v1_Invoices_RetrieveInvoicePdf",
9749
9749
  "parameters": [
9750
9750
  {
@@ -10379,6 +10379,125 @@
10379
10379
  }
10380
10380
  ]
10381
10381
  },
10382
+ "patch": {
10383
+ "tags": [
10384
+ "Notes"
10385
+ ],
10386
+ "summary": "Update Note",
10387
+ "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.",
10388
+ "operationId": "v1_Notes_UpdateNote",
10389
+ "parameters": [
10390
+ {
10391
+ "name": "id",
10392
+ "in": "path",
10393
+ "description": "Note id to be updated",
10394
+ "required": true,
10395
+ "schema": {
10396
+ "type": "string",
10397
+ "format": "uuid"
10398
+ }
10399
+ }
10400
+ ],
10401
+ "requestBody": {
10402
+ "description": "A list of changes to apply to this Note",
10403
+ "content": {
10404
+ "application/json": {
10405
+ "schema": {
10406
+ "type": "object",
10407
+ "additionalProperties": { }
10408
+ }
10409
+ },
10410
+ "text/json": {
10411
+ "schema": {
10412
+ "type": "object",
10413
+ "additionalProperties": { }
10414
+ }
10415
+ },
10416
+ "application/*+json": {
10417
+ "schema": {
10418
+ "type": "object",
10419
+ "additionalProperties": { }
10420
+ }
10421
+ }
10422
+ }
10423
+ },
10424
+ "responses": {
10425
+ "404": {
10426
+ "description": "Not Found",
10427
+ "content": {
10428
+ "application/json": {
10429
+ "schema": {
10430
+ "$ref": "#/components/schemas/ProblemDetails"
10431
+ }
10432
+ },
10433
+ "text/json": {
10434
+ "schema": {
10435
+ "$ref": "#/components/schemas/ProblemDetails"
10436
+ }
10437
+ }
10438
+ }
10439
+ },
10440
+ "200": {
10441
+ "description": "Success",
10442
+ "content": {
10443
+ "application/json": {
10444
+ "schema": {
10445
+ "$ref": "#/components/schemas/NoteModel"
10446
+ }
10447
+ },
10448
+ "text/json": {
10449
+ "schema": {
10450
+ "$ref": "#/components/schemas/NoteModel"
10451
+ }
10452
+ }
10453
+ }
10454
+ },
10455
+ "400": {
10456
+ "description": "Bad Request",
10457
+ "content": {
10458
+ "application/json": {
10459
+ "schema": {
10460
+ "$ref": "#/components/schemas/ProblemDetails"
10461
+ }
10462
+ },
10463
+ "text/json": {
10464
+ "schema": {
10465
+ "$ref": "#/components/schemas/ProblemDetails"
10466
+ }
10467
+ }
10468
+ }
10469
+ },
10470
+ "403": {
10471
+ "description": "Forbidden",
10472
+ "content": {
10473
+ "application/json": {
10474
+ "schema": {
10475
+ "$ref": "#/components/schemas/ProblemDetails"
10476
+ }
10477
+ },
10478
+ "text/json": {
10479
+ "schema": {
10480
+ "$ref": "#/components/schemas/ProblemDetails"
10481
+ }
10482
+ }
10483
+ }
10484
+ },
10485
+ "401": {
10486
+ "description": "Unauthorized"
10487
+ }
10488
+ },
10489
+ "security": [
10490
+ {
10491
+ "oauth2": [ ]
10492
+ },
10493
+ {
10494
+ "bearer_token": [ ]
10495
+ },
10496
+ {
10497
+ "api_key": [ ]
10498
+ }
10499
+ ]
10500
+ },
10382
10501
  "delete": {
10383
10502
  "tags": [
10384
10503
  "Notes"
@@ -20792,13 +20911,6 @@
20792
20911
  "AccountingProfileContactModelFetchResult": {
20793
20912
  "type": "object",
20794
20913
  "properties": {
20795
- "records": {
20796
- "type": "array",
20797
- "items": {
20798
- "$ref": "#/components/schemas/AccountingProfileContactModel"
20799
- },
20800
- "nullable": true
20801
- },
20802
20914
  "totalCount": {
20803
20915
  "type": "integer",
20804
20916
  "format": "int32",
@@ -20813,6 +20925,13 @@
20813
20925
  "type": "integer",
20814
20926
  "format": "int32",
20815
20927
  "nullable": true
20928
+ },
20929
+ "records": {
20930
+ "type": "array",
20931
+ "items": {
20932
+ "$ref": "#/components/schemas/AccountingProfileContactModel"
20933
+ },
20934
+ "nullable": true
20816
20935
  }
20817
20936
  },
20818
20937
  "additionalProperties": false
@@ -21250,13 +21369,6 @@
21250
21369
  "AccountingProfileModelFetchResult": {
21251
21370
  "type": "object",
21252
21371
  "properties": {
21253
- "records": {
21254
- "type": "array",
21255
- "items": {
21256
- "$ref": "#/components/schemas/AccountingProfileModel"
21257
- },
21258
- "nullable": true
21259
- },
21260
21372
  "totalCount": {
21261
21373
  "type": "integer",
21262
21374
  "format": "int32",
@@ -21271,6 +21383,13 @@
21271
21383
  "type": "integer",
21272
21384
  "format": "int32",
21273
21385
  "nullable": true
21386
+ },
21387
+ "records": {
21388
+ "type": "array",
21389
+ "items": {
21390
+ "$ref": "#/components/schemas/AccountingProfileModel"
21391
+ },
21392
+ "nullable": true
21274
21393
  }
21275
21394
  },
21276
21395
  "additionalProperties": false
@@ -21835,13 +21954,6 @@
21835
21954
  "ApiKeyModelFetchResult": {
21836
21955
  "type": "object",
21837
21956
  "properties": {
21838
- "records": {
21839
- "type": "array",
21840
- "items": {
21841
- "$ref": "#/components/schemas/ApiKeyModel"
21842
- },
21843
- "nullable": true
21844
- },
21845
21957
  "totalCount": {
21846
21958
  "type": "integer",
21847
21959
  "format": "int32",
@@ -21856,6 +21968,13 @@
21856
21968
  "type": "integer",
21857
21969
  "format": "int32",
21858
21970
  "nullable": true
21971
+ },
21972
+ "records": {
21973
+ "type": "array",
21974
+ "items": {
21975
+ "$ref": "#/components/schemas/ApiKeyModel"
21976
+ },
21977
+ "nullable": true
21859
21978
  }
21860
21979
  },
21861
21980
  "additionalProperties": false
@@ -21945,13 +22064,6 @@
21945
22064
  "AppEnrollmentCustomFieldModelFetchResult": {
21946
22065
  "type": "object",
21947
22066
  "properties": {
21948
- "records": {
21949
- "type": "array",
21950
- "items": {
21951
- "$ref": "#/components/schemas/AppEnrollmentCustomFieldModel"
21952
- },
21953
- "nullable": true
21954
- },
21955
22067
  "totalCount": {
21956
22068
  "type": "integer",
21957
22069
  "format": "int32",
@@ -21966,6 +22078,13 @@
21966
22078
  "type": "integer",
21967
22079
  "format": "int32",
21968
22080
  "nullable": true
22081
+ },
22082
+ "records": {
22083
+ "type": "array",
22084
+ "items": {
22085
+ "$ref": "#/components/schemas/AppEnrollmentCustomFieldModel"
22086
+ },
22087
+ "nullable": true
21969
22088
  }
21970
22089
  },
21971
22090
  "additionalProperties": false
@@ -22106,13 +22225,6 @@
22106
22225
  "AppEnrollmentModelFetchResult": {
22107
22226
  "type": "object",
22108
22227
  "properties": {
22109
- "records": {
22110
- "type": "array",
22111
- "items": {
22112
- "$ref": "#/components/schemas/AppEnrollmentModel"
22113
- },
22114
- "nullable": true
22115
- },
22116
22228
  "totalCount": {
22117
22229
  "type": "integer",
22118
22230
  "format": "int32",
@@ -22127,6 +22239,13 @@
22127
22239
  "type": "integer",
22128
22240
  "format": "int32",
22129
22241
  "nullable": true
22242
+ },
22243
+ "records": {
22244
+ "type": "array",
22245
+ "items": {
22246
+ "$ref": "#/components/schemas/AppEnrollmentModel"
22247
+ },
22248
+ "nullable": true
22130
22249
  }
22131
22250
  },
22132
22251
  "additionalProperties": false
@@ -22307,13 +22426,6 @@
22307
22426
  "ApplicationModelFetchResult": {
22308
22427
  "type": "object",
22309
22428
  "properties": {
22310
- "records": {
22311
- "type": "array",
22312
- "items": {
22313
- "$ref": "#/components/schemas/ApplicationModel"
22314
- },
22315
- "nullable": true
22316
- },
22317
22429
  "totalCount": {
22318
22430
  "type": "integer",
22319
22431
  "format": "int32",
@@ -22328,6 +22440,13 @@
22328
22440
  "type": "integer",
22329
22441
  "format": "int32",
22330
22442
  "nullable": true
22443
+ },
22444
+ "records": {
22445
+ "type": "array",
22446
+ "items": {
22447
+ "$ref": "#/components/schemas/ApplicationModel"
22448
+ },
22449
+ "nullable": true
22331
22450
  }
22332
22451
  },
22333
22452
  "additionalProperties": false
@@ -22677,13 +22796,6 @@
22677
22796
  "AtRiskInvoiceSummaryModelFetchResult": {
22678
22797
  "type": "object",
22679
22798
  "properties": {
22680
- "records": {
22681
- "type": "array",
22682
- "items": {
22683
- "$ref": "#/components/schemas/AtRiskInvoiceSummaryModel"
22684
- },
22685
- "nullable": true
22686
- },
22687
22799
  "totalCount": {
22688
22800
  "type": "integer",
22689
22801
  "format": "int32",
@@ -22698,6 +22810,13 @@
22698
22810
  "type": "integer",
22699
22811
  "format": "int32",
22700
22812
  "nullable": true
22813
+ },
22814
+ "records": {
22815
+ "type": "array",
22816
+ "items": {
22817
+ "$ref": "#/components/schemas/AtRiskInvoiceSummaryModel"
22818
+ },
22819
+ "nullable": true
22701
22820
  }
22702
22821
  },
22703
22822
  "additionalProperties": false
@@ -22780,13 +22899,6 @@
22780
22899
  "AttachmentLinkModelFetchResult": {
22781
22900
  "type": "object",
22782
22901
  "properties": {
22783
- "records": {
22784
- "type": "array",
22785
- "items": {
22786
- "$ref": "#/components/schemas/AttachmentLinkModel"
22787
- },
22788
- "nullable": true
22789
- },
22790
22902
  "totalCount": {
22791
22903
  "type": "integer",
22792
22904
  "format": "int32",
@@ -22801,6 +22913,13 @@
22801
22913
  "type": "integer",
22802
22914
  "format": "int32",
22803
22915
  "nullable": true
22916
+ },
22917
+ "records": {
22918
+ "type": "array",
22919
+ "items": {
22920
+ "$ref": "#/components/schemas/AttachmentLinkModel"
22921
+ },
22922
+ "nullable": true
22804
22923
  }
22805
22924
  },
22806
22925
  "additionalProperties": false
@@ -22897,13 +23016,6 @@
22897
23016
  "AttachmentModelFetchResult": {
22898
23017
  "type": "object",
22899
23018
  "properties": {
22900
- "records": {
22901
- "type": "array",
22902
- "items": {
22903
- "$ref": "#/components/schemas/AttachmentModel"
22904
- },
22905
- "nullable": true
22906
- },
22907
23019
  "totalCount": {
22908
23020
  "type": "integer",
22909
23021
  "format": "int32",
@@ -22918,6 +23030,13 @@
22918
23030
  "type": "integer",
22919
23031
  "format": "int32",
22920
23032
  "nullable": true
23033
+ },
23034
+ "records": {
23035
+ "type": "array",
23036
+ "items": {
23037
+ "$ref": "#/components/schemas/AttachmentModel"
23038
+ },
23039
+ "nullable": true
22921
23040
  }
22922
23041
  },
22923
23042
  "additionalProperties": false
@@ -23194,13 +23313,6 @@
23194
23313
  "CodeDefinitionModelFetchResult": {
23195
23314
  "type": "object",
23196
23315
  "properties": {
23197
- "records": {
23198
- "type": "array",
23199
- "items": {
23200
- "$ref": "#/components/schemas/CodeDefinitionModel"
23201
- },
23202
- "nullable": true
23203
- },
23204
23316
  "totalCount": {
23205
23317
  "type": "integer",
23206
23318
  "format": "int32",
@@ -23215,6 +23327,13 @@
23215
23327
  "type": "integer",
23216
23328
  "format": "int32",
23217
23329
  "nullable": true
23330
+ },
23331
+ "records": {
23332
+ "type": "array",
23333
+ "items": {
23334
+ "$ref": "#/components/schemas/CodeDefinitionModel"
23335
+ },
23336
+ "nullable": true
23218
23337
  }
23219
23338
  },
23220
23339
  "additionalProperties": false
@@ -23432,7 +23551,7 @@
23432
23551
  "maxLength": 20,
23433
23552
  "minLength": 0,
23434
23553
  "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.",
23554
+ "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
23555
  "nullable": true
23437
23556
  },
23438
23557
  "parentCompanyId": {
@@ -23730,8 +23849,15 @@
23730
23849
  "description": "A unique identification number assigned to the company by the national registration office.",
23731
23850
  "nullable": true
23732
23851
  },
23733
- "notes": {
23734
- "type": "array",
23852
+ "profileReferenceId": {
23853
+ "type": "string",
23854
+ "description": "An optional reference to a real company, making this a profile.",
23855
+ "format": "uuid",
23856
+ "nullable": true,
23857
+ "readOnly": true
23858
+ },
23859
+ "notes": {
23860
+ "type": "array",
23735
23861
  "items": {
23736
23862
  "$ref": "#/components/schemas/NoteModel"
23737
23863
  },
@@ -23799,13 +23925,6 @@
23799
23925
  "CompanyModelFetchResult": {
23800
23926
  "type": "object",
23801
23927
  "properties": {
23802
- "records": {
23803
- "type": "array",
23804
- "items": {
23805
- "$ref": "#/components/schemas/CompanyModel"
23806
- },
23807
- "nullable": true
23808
- },
23809
23928
  "totalCount": {
23810
23929
  "type": "integer",
23811
23930
  "format": "int32",
@@ -23820,6 +23939,13 @@
23820
23939
  "type": "integer",
23821
23940
  "format": "int32",
23822
23941
  "nullable": true
23942
+ },
23943
+ "records": {
23944
+ "type": "array",
23945
+ "items": {
23946
+ "$ref": "#/components/schemas/CompanyModel"
23947
+ },
23948
+ "nullable": true
23823
23949
  }
23824
23950
  },
23825
23951
  "additionalProperties": false
@@ -24282,13 +24408,6 @@
24282
24408
  "ContactModelFetchResult": {
24283
24409
  "type": "object",
24284
24410
  "properties": {
24285
- "records": {
24286
- "type": "array",
24287
- "items": {
24288
- "$ref": "#/components/schemas/ContactModel"
24289
- },
24290
- "nullable": true
24291
- },
24292
24411
  "totalCount": {
24293
24412
  "type": "integer",
24294
24413
  "format": "int32",
@@ -24303,6 +24422,13 @@
24303
24422
  "type": "integer",
24304
24423
  "format": "int32",
24305
24424
  "nullable": true
24425
+ },
24426
+ "records": {
24427
+ "type": "array",
24428
+ "items": {
24429
+ "$ref": "#/components/schemas/ContactModel"
24430
+ },
24431
+ "nullable": true
24306
24432
  }
24307
24433
  },
24308
24434
  "additionalProperties": false
@@ -24515,13 +24641,6 @@
24515
24641
  "CountryModelFetchResult": {
24516
24642
  "type": "object",
24517
24643
  "properties": {
24518
- "records": {
24519
- "type": "array",
24520
- "items": {
24521
- "$ref": "#/components/schemas/CountryModel"
24522
- },
24523
- "nullable": true
24524
- },
24525
24644
  "totalCount": {
24526
24645
  "type": "integer",
24527
24646
  "format": "int32",
@@ -24536,6 +24655,13 @@
24536
24655
  "type": "integer",
24537
24656
  "format": "int32",
24538
24657
  "nullable": true
24658
+ },
24659
+ "records": {
24660
+ "type": "array",
24661
+ "items": {
24662
+ "$ref": "#/components/schemas/CountryModel"
24663
+ },
24664
+ "nullable": true
24539
24665
  }
24540
24666
  },
24541
24667
  "additionalProperties": false
@@ -24702,13 +24828,6 @@
24702
24828
  "CreditMemoAppliedModelFetchResult": {
24703
24829
  "type": "object",
24704
24830
  "properties": {
24705
- "records": {
24706
- "type": "array",
24707
- "items": {
24708
- "$ref": "#/components/schemas/CreditMemoAppliedModel"
24709
- },
24710
- "nullable": true
24711
- },
24712
24831
  "totalCount": {
24713
24832
  "type": "integer",
24714
24833
  "format": "int32",
@@ -24723,6 +24842,13 @@
24723
24842
  "type": "integer",
24724
24843
  "format": "int32",
24725
24844
  "nullable": true
24845
+ },
24846
+ "records": {
24847
+ "type": "array",
24848
+ "items": {
24849
+ "$ref": "#/components/schemas/CreditMemoAppliedModel"
24850
+ },
24851
+ "nullable": true
24726
24852
  }
24727
24853
  },
24728
24854
  "additionalProperties": false
@@ -24966,13 +25092,6 @@
24966
25092
  "CurrencyModelFetchResult": {
24967
25093
  "type": "object",
24968
25094
  "properties": {
24969
- "records": {
24970
- "type": "array",
24971
- "items": {
24972
- "$ref": "#/components/schemas/CurrencyModel"
24973
- },
24974
- "nullable": true
24975
- },
24976
25095
  "totalCount": {
24977
25096
  "type": "integer",
24978
25097
  "format": "int32",
@@ -24987,6 +25106,13 @@
24987
25106
  "type": "integer",
24988
25107
  "format": "int32",
24989
25108
  "nullable": true
25109
+ },
25110
+ "records": {
25111
+ "type": "array",
25112
+ "items": {
25113
+ "$ref": "#/components/schemas/CurrencyModel"
25114
+ },
25115
+ "nullable": true
24990
25116
  }
24991
25117
  },
24992
25118
  "additionalProperties": false
@@ -25479,13 +25605,6 @@
25479
25605
  "CustomerSummaryModelFetchResult": {
25480
25606
  "type": "object",
25481
25607
  "properties": {
25482
- "records": {
25483
- "type": "array",
25484
- "items": {
25485
- "$ref": "#/components/schemas/CustomerSummaryModel"
25486
- },
25487
- "nullable": true
25488
- },
25489
25608
  "totalCount": {
25490
25609
  "type": "integer",
25491
25610
  "format": "int32",
@@ -25500,6 +25619,13 @@
25500
25619
  "type": "integer",
25501
25620
  "format": "int32",
25502
25621
  "nullable": true
25622
+ },
25623
+ "records": {
25624
+ "type": "array",
25625
+ "items": {
25626
+ "$ref": "#/components/schemas/CustomerSummaryModel"
25627
+ },
25628
+ "nullable": true
25503
25629
  }
25504
25630
  },
25505
25631
  "additionalProperties": false
@@ -26250,13 +26376,6 @@
26250
26376
  "FinancialAccountModelFetchResult": {
26251
26377
  "type": "object",
26252
26378
  "properties": {
26253
- "records": {
26254
- "type": "array",
26255
- "items": {
26256
- "$ref": "#/components/schemas/FinancialAccountModel"
26257
- },
26258
- "nullable": true
26259
- },
26260
26379
  "totalCount": {
26261
26380
  "type": "integer",
26262
26381
  "format": "int32",
@@ -26271,6 +26390,13 @@
26271
26390
  "type": "integer",
26272
26391
  "format": "int32",
26273
26392
  "nullable": true
26393
+ },
26394
+ "records": {
26395
+ "type": "array",
26396
+ "items": {
26397
+ "$ref": "#/components/schemas/FinancialAccountModel"
26398
+ },
26399
+ "nullable": true
26274
26400
  }
26275
26401
  },
26276
26402
  "additionalProperties": false
@@ -27397,13 +27523,6 @@
27397
27523
  "InvoiceLineModelFetchResult": {
27398
27524
  "type": "object",
27399
27525
  "properties": {
27400
- "records": {
27401
- "type": "array",
27402
- "items": {
27403
- "$ref": "#/components/schemas/InvoiceLineModel"
27404
- },
27405
- "nullable": true
27406
- },
27407
27526
  "totalCount": {
27408
27527
  "type": "integer",
27409
27528
  "format": "int32",
@@ -27418,6 +27537,13 @@
27418
27537
  "type": "integer",
27419
27538
  "format": "int32",
27420
27539
  "nullable": true
27540
+ },
27541
+ "records": {
27542
+ "type": "array",
27543
+ "items": {
27544
+ "$ref": "#/components/schemas/InvoiceLineModel"
27545
+ },
27546
+ "nullable": true
27421
27547
  }
27422
27548
  },
27423
27549
  "additionalProperties": false
@@ -28026,12 +28152,6 @@
28026
28152
  "InvoiceModelFetchResult": {
28027
28153
  "type": "object",
28028
28154
  "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
28155
  "totalCount": {
28036
28156
  "type": "integer",
28037
28157
  "format": "int32",
@@ -28046,6 +28166,12 @@
28046
28166
  "type": "integer",
28047
28167
  "format": "int32",
28048
28168
  "nullable": true
28169
+ },
28170
+ "records": {
28171
+ "type": "array",
28172
+ "items": { },
28173
+ "description": " For more information on Invoices, see [InvoiceModel](https://developer.lockstep.io/reference/get_api-v1-invoices-id).",
28174
+ "nullable": true
28049
28175
  }
28050
28176
  },
28051
28177
  "additionalProperties": false
@@ -28295,13 +28421,6 @@
28295
28421
  "InvoiceSummaryModelInvoiceSummaryTotalsModelSummaryFetchResult": {
28296
28422
  "type": "object",
28297
28423
  "properties": {
28298
- "records": {
28299
- "type": "array",
28300
- "items": {
28301
- "$ref": "#/components/schemas/InvoiceSummaryModel"
28302
- },
28303
- "nullable": true
28304
- },
28305
28424
  "totalCount": {
28306
28425
  "type": "integer",
28307
28426
  "format": "int32",
@@ -28317,6 +28436,13 @@
28317
28436
  "format": "int32",
28318
28437
  "nullable": true
28319
28438
  },
28439
+ "records": {
28440
+ "type": "array",
28441
+ "items": {
28442
+ "$ref": "#/components/schemas/InvoiceSummaryModel"
28443
+ },
28444
+ "nullable": true
28445
+ },
28320
28446
  "summary": {
28321
28447
  "allOf": [
28322
28448
  {
@@ -28838,13 +28964,6 @@
28838
28964
  "MagicLinkModelFetchResult": {
28839
28965
  "type": "object",
28840
28966
  "properties": {
28841
- "records": {
28842
- "type": "array",
28843
- "items": {
28844
- "$ref": "#/components/schemas/MagicLinkModel"
28845
- },
28846
- "nullable": true
28847
- },
28848
28967
  "totalCount": {
28849
28968
  "type": "integer",
28850
28969
  "format": "int32",
@@ -28859,6 +28978,13 @@
28859
28978
  "type": "integer",
28860
28979
  "format": "int32",
28861
28980
  "nullable": true
28981
+ },
28982
+ "records": {
28983
+ "type": "array",
28984
+ "items": {
28985
+ "$ref": "#/components/schemas/MagicLinkModel"
28986
+ },
28987
+ "nullable": true
28862
28988
  }
28863
28989
  },
28864
28990
  "additionalProperties": false
@@ -28941,13 +29067,15 @@
28941
29067
  "maxLength": 40,
28942
29068
  "minLength": 1,
28943
29069
  "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)."
29070
+ "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).",
29071
+ "readOnly": true
28945
29072
  },
28946
29073
  "objectKey": {
28947
29074
  "minLength": 1,
28948
29075
  "type": "string",
28949
29076
  "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"
29077
+ "format": "uuid",
29078
+ "readOnly": true
28951
29079
  },
28952
29080
  "noteText": {
28953
29081
  "maxLength": 1000,
@@ -28978,6 +29106,18 @@
28978
29106
  "format": "uuid",
28979
29107
  "readOnly": true
28980
29108
  },
29109
+ "modified": {
29110
+ "type": "string",
29111
+ "description": "The date this note was last modified",
29112
+ "format": "date-time",
29113
+ "readOnly": true
29114
+ },
29115
+ "modifiedUserId": {
29116
+ "type": "string",
29117
+ "description": "The ID of the user who last modified this note",
29118
+ "format": "uuid",
29119
+ "readOnly": true
29120
+ },
28981
29121
  "createdUserName": {
28982
29122
  "type": "string",
28983
29123
  "description": "The name of the user who created the note",
@@ -29004,13 +29144,6 @@
29004
29144
  "NoteModelFetchResult": {
29005
29145
  "type": "object",
29006
29146
  "properties": {
29007
- "records": {
29008
- "type": "array",
29009
- "items": {
29010
- "$ref": "#/components/schemas/NoteModel"
29011
- },
29012
- "nullable": true
29013
- },
29014
29147
  "totalCount": {
29015
29148
  "type": "integer",
29016
29149
  "format": "int32",
@@ -29025,6 +29158,13 @@
29025
29158
  "type": "integer",
29026
29159
  "format": "int32",
29027
29160
  "nullable": true
29161
+ },
29162
+ "records": {
29163
+ "type": "array",
29164
+ "items": {
29165
+ "$ref": "#/components/schemas/NoteModel"
29166
+ },
29167
+ "nullable": true
29028
29168
  }
29029
29169
  },
29030
29170
  "additionalProperties": false
@@ -29389,13 +29529,6 @@
29389
29529
  "PaymentAppliedModelFetchResult": {
29390
29530
  "type": "object",
29391
29531
  "properties": {
29392
- "records": {
29393
- "type": "array",
29394
- "items": {
29395
- "$ref": "#/components/schemas/PaymentAppliedModel"
29396
- },
29397
- "nullable": true
29398
- },
29399
29532
  "totalCount": {
29400
29533
  "type": "integer",
29401
29534
  "format": "int32",
@@ -29410,6 +29543,13 @@
29410
29543
  "type": "integer",
29411
29544
  "format": "int32",
29412
29545
  "nullable": true
29546
+ },
29547
+ "records": {
29548
+ "type": "array",
29549
+ "items": {
29550
+ "$ref": "#/components/schemas/PaymentAppliedModel"
29551
+ },
29552
+ "nullable": true
29413
29553
  }
29414
29554
  },
29415
29555
  "additionalProperties": false
@@ -29691,13 +29831,6 @@
29691
29831
  "PaymentDetailModelFetchResult": {
29692
29832
  "type": "object",
29693
29833
  "properties": {
29694
- "records": {
29695
- "type": "array",
29696
- "items": {
29697
- "$ref": "#/components/schemas/PaymentDetailModel"
29698
- },
29699
- "nullable": true
29700
- },
29701
29834
  "totalCount": {
29702
29835
  "type": "integer",
29703
29836
  "format": "int32",
@@ -29712,6 +29845,13 @@
29712
29845
  "type": "integer",
29713
29846
  "format": "int32",
29714
29847
  "nullable": true
29848
+ },
29849
+ "records": {
29850
+ "type": "array",
29851
+ "items": {
29852
+ "$ref": "#/components/schemas/PaymentDetailModel"
29853
+ },
29854
+ "nullable": true
29715
29855
  }
29716
29856
  },
29717
29857
  "additionalProperties": false
@@ -30031,13 +30171,6 @@
30031
30171
  "PaymentModelFetchResult": {
30032
30172
  "type": "object",
30033
30173
  "properties": {
30034
- "records": {
30035
- "type": "array",
30036
- "items": {
30037
- "$ref": "#/components/schemas/PaymentModel"
30038
- },
30039
- "nullable": true
30040
- },
30041
30174
  "totalCount": {
30042
30175
  "type": "integer",
30043
30176
  "format": "int32",
@@ -30052,6 +30185,13 @@
30052
30185
  "type": "integer",
30053
30186
  "format": "int32",
30054
30187
  "nullable": true
30188
+ },
30189
+ "records": {
30190
+ "type": "array",
30191
+ "items": {
30192
+ "$ref": "#/components/schemas/PaymentModel"
30193
+ },
30194
+ "nullable": true
30055
30195
  }
30056
30196
  },
30057
30197
  "additionalProperties": false
@@ -30387,13 +30527,6 @@
30387
30527
  "PaymentSummaryModelPaymentSummaryTotalsModelSummaryFetchResult": {
30388
30528
  "type": "object",
30389
30529
  "properties": {
30390
- "records": {
30391
- "type": "array",
30392
- "items": {
30393
- "$ref": "#/components/schemas/PaymentSummaryModel"
30394
- },
30395
- "nullable": true
30396
- },
30397
30530
  "totalCount": {
30398
30531
  "type": "integer",
30399
30532
  "format": "int32",
@@ -30409,6 +30542,13 @@
30409
30542
  "format": "int32",
30410
30543
  "nullable": true
30411
30544
  },
30545
+ "records": {
30546
+ "type": "array",
30547
+ "items": {
30548
+ "$ref": "#/components/schemas/PaymentSummaryModel"
30549
+ },
30550
+ "nullable": true
30551
+ },
30412
30552
  "summary": {
30413
30553
  "allOf": [
30414
30554
  {
@@ -32364,13 +32504,6 @@
32364
32504
  "SyncRequestModelFetchResult": {
32365
32505
  "type": "object",
32366
32506
  "properties": {
32367
- "records": {
32368
- "type": "array",
32369
- "items": {
32370
- "$ref": "#/components/schemas/SyncRequestModel"
32371
- },
32372
- "nullable": true
32373
- },
32374
32507
  "totalCount": {
32375
32508
  "type": "integer",
32376
32509
  "format": "int32",
@@ -32385,6 +32518,13 @@
32385
32518
  "type": "integer",
32386
32519
  "format": "int32",
32387
32520
  "nullable": true
32521
+ },
32522
+ "records": {
32523
+ "type": "array",
32524
+ "items": {
32525
+ "$ref": "#/components/schemas/SyncRequestModel"
32526
+ },
32527
+ "nullable": true
32388
32528
  }
32389
32529
  },
32390
32530
  "additionalProperties": false
@@ -32601,13 +32741,6 @@
32601
32741
  "TransactionModelTransactionSummaryTotalModelSummaryFetchResult": {
32602
32742
  "type": "object",
32603
32743
  "properties": {
32604
- "records": {
32605
- "type": "array",
32606
- "items": {
32607
- "$ref": "#/components/schemas/TransactionModel"
32608
- },
32609
- "nullable": true
32610
- },
32611
32744
  "totalCount": {
32612
32745
  "type": "integer",
32613
32746
  "format": "int32",
@@ -32623,6 +32756,13 @@
32623
32756
  "format": "int32",
32624
32757
  "nullable": true
32625
32758
  },
32759
+ "records": {
32760
+ "type": "array",
32761
+ "items": {
32762
+ "$ref": "#/components/schemas/TransactionModel"
32763
+ },
32764
+ "nullable": true
32765
+ },
32626
32766
  "summary": {
32627
32767
  "allOf": [
32628
32768
  {
@@ -33250,13 +33390,6 @@
33250
33390
  "UserAccountModelFetchResult": {
33251
33391
  "type": "object",
33252
33392
  "properties": {
33253
- "records": {
33254
- "type": "array",
33255
- "items": {
33256
- "$ref": "#/components/schemas/UserAccountModel"
33257
- },
33258
- "nullable": true
33259
- },
33260
33393
  "totalCount": {
33261
33394
  "type": "integer",
33262
33395
  "format": "int32",
@@ -33271,6 +33404,13 @@
33271
33404
  "type": "integer",
33272
33405
  "format": "int32",
33273
33406
  "nullable": true
33407
+ },
33408
+ "records": {
33409
+ "type": "array",
33410
+ "items": {
33411
+ "$ref": "#/components/schemas/UserAccountModel"
33412
+ },
33413
+ "nullable": true
33274
33414
  }
33275
33415
  },
33276
33416
  "additionalProperties": false
@@ -33379,13 +33519,6 @@
33379
33519
  "UserRoleModelFetchResult": {
33380
33520
  "type": "object",
33381
33521
  "properties": {
33382
- "records": {
33383
- "type": "array",
33384
- "items": {
33385
- "$ref": "#/components/schemas/UserRoleModel"
33386
- },
33387
- "nullable": true
33388
- },
33389
33522
  "totalCount": {
33390
33523
  "type": "integer",
33391
33524
  "format": "int32",
@@ -33400,6 +33533,13 @@
33400
33533
  "type": "integer",
33401
33534
  "format": "int32",
33402
33535
  "nullable": true
33536
+ },
33537
+ "records": {
33538
+ "type": "array",
33539
+ "items": {
33540
+ "$ref": "#/components/schemas/UserRoleModel"
33541
+ },
33542
+ "nullable": true
33403
33543
  }
33404
33544
  },
33405
33545
  "additionalProperties": false
@@ -33565,13 +33705,6 @@
33565
33705
  "VendorSummaryModelFetchResult": {
33566
33706
  "type": "object",
33567
33707
  "properties": {
33568
- "records": {
33569
- "type": "array",
33570
- "items": {
33571
- "$ref": "#/components/schemas/VendorSummaryModel"
33572
- },
33573
- "nullable": true
33574
- },
33575
33708
  "totalCount": {
33576
33709
  "type": "integer",
33577
33710
  "format": "int32",
@@ -33586,6 +33719,13 @@
33586
33719
  "type": "integer",
33587
33720
  "format": "int32",
33588
33721
  "nullable": true
33722
+ },
33723
+ "records": {
33724
+ "type": "array",
33725
+ "items": {
33726
+ "$ref": "#/components/schemas/VendorSummaryModel"
33727
+ },
33728
+ "nullable": true
33589
33729
  }
33590
33730
  },
33591
33731
  "additionalProperties": false
@@ -1,4 +1,4 @@
1
1
  module LockstepRails
2
- VERSION = '0.3.67'
2
+ VERSION = '0.3.68'
3
3
  end
4
4
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: lockstep_rails
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.67
4
+ version: 0.3.68
5
5
  platform: ruby
6
6
  authors:
7
7
  - Vivek AG
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-07-03 00:00:00.000000000 Z
11
+ date: 2023-08-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rails