diff --git a/Gemfile.lock b/Gemfile.lock index 7e9b4bb..8006357 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - lockstep_rails (0.3.89) + lockstep_rails (0.3.90) rails GEM diff --git a/app/models/lockstep/custom_field_value.rb b/app/models/lockstep/custom_field_value.rb index 2ff8a65..bf4c370 100644 --- a/app/models/lockstep/custom_field_value.rb +++ b/app/models/lockstep/custom_field_value.rb @@ -2,4 +2,16 @@ class Lockstep::CustomFieldValue < Lockstep::ApiRecord self.model_name_uri = 'v1/CustomFieldValues' self.id_ref = 'custom_field_definition_id' load_schema(Schema::CustomFieldValue) + + def update(attributes = {}) + attributes = HashWithIndifferentAccess.new(attributes) + + @unsaved_attributes.merge!(attributes) + attrs = attributes_for_saving.transform_keys { |key| key.camelize(:lower) } + + # Label with CustomerLocale to be updated from here + resp = resource.patch("CustomerLocale/#{attributes[:record_key]}", body: attrs) + post_result(resp) + end + end diff --git a/app/platform_api/schema/api_key.rb b/app/platform_api/schema/api_key.rb index cb443ff..83c4ba9 100644 --- a/app/platform_api/schema/api_key.rb +++ b/app/platform_api/schema/api_key.rb @@ -10,7 +10,7 @@ def self.id_ref # @format: uuid field :api_key_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/app_enrollment.rb b/app/platform_api/schema/app_enrollment.rb index e62c411..c7df385 100644 --- a/app/platform_api/schema/app_enrollment.rb +++ b/app/platform_api/schema/app_enrollment.rb @@ -6,7 +6,7 @@ def self.id_ref end # The unique ID of this record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # @type: string # @format: uuid field :app_enrollment_id @@ -17,7 +17,7 @@ def self.id_ref # @format: uuid field :app_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -58,7 +58,7 @@ def self.id_ref # @type: boolean field :sync_schedule_is_active - # Flag indicating if the App Enrollment is currently being deleted from the Platform. + # Flag indicating if the App Enrollment is currently being deleted from the Network. # @type: boolean field :is_deleted diff --git a/app/platform_api/schema/app_enrollment_custom_field.rb b/app/platform_api/schema/app_enrollment_custom_field.rb index 099db21..3861b2f 100644 --- a/app/platform_api/schema/app_enrollment_custom_field.rb +++ b/app/platform_api/schema/app_enrollment_custom_field.rb @@ -23,7 +23,7 @@ def self.id_ref # @type: string field :app_type - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/app_enrollment_reconnect_info.rb b/app/platform_api/schema/app_enrollment_reconnect_info.rb index e5b1534..9af37ad 100644 --- a/app/platform_api/schema/app_enrollment_reconnect_info.rb +++ b/app/platform_api/schema/app_enrollment_reconnect_info.rb @@ -5,10 +5,6 @@ def self.id_ref nil end - # The OAuth authentication code. - # @type: string - field :auth_code - # The username for the web services account with access permissions. # @type: string field :username @@ -21,18 +17,6 @@ def self.id_ref # @type: string field :realm_id - # The access token id for the connector enrollment. - # @type: string - field :token_id - - # The access token secret for the connector enrollment. - # @type: string - field :token_secret - - # The OAuth redirect uri. - # @type: string - field :redirect_uri - end \ No newline at end of file diff --git a/app/platform_api/schema/application.rb b/app/platform_api/schema/application.rb index 635fbf5..fa9d22e 100644 --- a/app/platform_api/schema/application.rb +++ b/app/platform_api/schema/application.rb @@ -59,7 +59,7 @@ def self.id_ref # @type: boolean field :is_active - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/attachment.rb b/app/platform_api/schema/attachment.rb index a2d7843..a713f0b 100644 --- a/app/platform_api/schema/attachment.rb +++ b/app/platform_api/schema/attachment.rb @@ -6,12 +6,12 @@ def self.id_ref end # The unique ID of this record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # @type: string # @format: uuid field :attachment_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -19,22 +19,22 @@ def self.id_ref # @format: uuid field :group_key - # An Attachment is connected to an existing item within the ADS Platform by the fields `TableKey` and + # An Attachment is connected to an existing item within the Accounting Data Service by the fields `TableKey` and # `ObjectKey`. For example, an Attachment connected to Invoice 12345 would have a `TableKey` value of # `Invoice` and an `ObjectKey` value of `12345`. # - # The `TableKey` value contains the name of the table within the ADS Platform to which this Attachment + # The `TableKey` value contains the name of the table within the Accounting Data Service to which this Attachment # is connected. # # For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object). # @type: string field :table_key - # An Attachment is connected to an existing item within the ADS Platform by the fields `TableKey` and + # An Attachment is connected to an existing item within the Accounting Data Service by the fields `TableKey` and # `ObjectKey`. For example, an Attachment connected to Invoice 12345 would have a `TableKey` value of # `Invoice` and an `ObjectKey` value of `12345`. # - # The `ObjectKey` value contains the primary key of the record within the ADS Platform to which this + # The `ObjectKey` value contains the primary key of the record within the Accounting Data Service to which this # Attachment is connected. # # For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object). @@ -42,12 +42,12 @@ def self.id_ref # @format: uuid field :object_key - # An Attachment represents a file that was uploaded to the ADS Platform. This field contains the original + # An Attachment represents a file that was uploaded to the Accounting Data Service. This field contains the original # name of the file on disk, without its extension. # @type: string field :file_name - # An Attachment represents a file that was uploaded to the ADS Platform. This field contains the original + # An Attachment represents a file that was uploaded to the Accounting Data Service. This field contains the original # extension name of the file on disk. # @type: string field :file_ext diff --git a/app/platform_api/schema/attachment_link.rb b/app/platform_api/schema/attachment_link.rb index 421c346..483768e 100644 --- a/app/platform_api/schema/attachment_link.rb +++ b/app/platform_api/schema/attachment_link.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -14,16 +14,16 @@ def self.id_ref field :group_key # The unique ID of an attachment record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # @type: string # @format: uuid field :attachment_id - # An Attachment is connected to an existing item within the ADS Platform by the fields `TableKey` and + # An Attachment is connected to an existing item within the Accounting Data Service by the fields `TableKey` and # `ObjectKey`. For example, an Attachment connected to Invoice 12345 would have a `TableKey` value of # `Invoice` and an `ObjectKey` value of `12345`. # - # The `ObjectKey` value contains the primary key of the record within the ADS Platform to which this + # The `ObjectKey` value contains the primary key of the record within the Accounting Data Service to which this # Attachment is connected. # # For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object). @@ -31,11 +31,11 @@ def self.id_ref # @format: uuid field :object_key - # An Attachment is connected to an existing item within the ADS Platform by the fields `TableKey` and + # An Attachment is connected to an existing item within the Accounting Data Service by the fields `TableKey` and # `ObjectKey`. For example, an Attachment connected to Invoice 12345 would have a `TableKey` value of # `Invoice` and an `ObjectKey` value of `12345`. # - # The `TableKey` value contains the name of the table within the ADS Platform to which this Attachment + # The `TableKey` value contains the name of the table within the Accounting Data Service to which this Attachment # is connected. # # For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object). diff --git a/app/platform_api/schema/code_definition.rb b/app/platform_api/schema/code_definition.rb index 7a6bc48..5424ff7 100644 --- a/app/platform_api/schema/code_definition.rb +++ b/app/platform_api/schema/code_definition.rb @@ -6,12 +6,12 @@ def self.id_ref end # The unique ID of this record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # @type: string # @format: uuid field :code_definition_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/company.rb b/app/platform_api/schema/company.rb index 66541ec..dcf903c 100644 --- a/app/platform_api/schema/company.rb +++ b/app/platform_api/schema/company.rb @@ -6,7 +6,7 @@ def self.id_ref end # The unique ID of this record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # # For the ID of this record in its originating financial system, see `ErpKey`. # @type: string @@ -55,7 +55,7 @@ def self.id_ref # @format: uuid field :enterprise_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -82,7 +82,7 @@ def self.id_ref # The scan status of the company's logo, if it exists field :company_logo_status - # The ADS Platform `ContactId` of the primary contact for this company. + # The Accounting Data Service `ContactId` of the primary contact for this company. This contact must belong to this company. # @type: string # @format: uuid field :primary_contact_id @@ -159,16 +159,6 @@ def self.id_ref # @type: string field :duns_number - # AP (Accounts Payable) Email Address - # @type: string - # @format: email - field :ap_email_address - - # AR (Accounts Receivable) Email Address - # @type: string - # @format: email - field :ar_email_address - # Indicates the preferred invoice delivery method. Examples include Print, Email, Fax # @type: string field :preferred_delivery_method @@ -256,6 +246,10 @@ def self.id_ref # @format: uuid field :profile_reference_id + # A reference code for this company. This code is used to identify this company in external ERP systems. + # @type: string + field :reference_code + # All invoices attached to this company. # # 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). diff --git a/app/platform_api/schema/company_details.rb b/app/platform_api/schema/company_details.rb index 85b6d7a..a362bc0 100644 --- a/app/platform_api/schema/company_details.rb +++ b/app/platform_api/schema/company_details.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/company_details_payment.rb b/app/platform_api/schema/company_details_payment.rb index 4c681c3..82f1ced 100644 --- a/app/platform_api/schema/company_details_payment.rb +++ b/app/platform_api/schema/company_details_payment.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/company_magic_link_summary.rb b/app/platform_api/schema/company_magic_link_summary.rb index c3801f3..2a6f4b0 100644 --- a/app/platform_api/schema/company_magic_link_summary.rb +++ b/app/platform_api/schema/company_magic_link_summary.rb @@ -28,7 +28,7 @@ def self.id_ref # @type: string field :company_type - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/company_sync.rb b/app/platform_api/schema/company_sync.rb index 385867c..c6e4531 100644 --- a/app/platform_api/schema/company_sync.rb +++ b/app/platform_api/schema/company_sync.rb @@ -8,7 +8,7 @@ def self.id_ref # Indicates what action to take when an existing object has been found during the sync process. field :on_match_action - # The unique identifier of this object in the Sage Network platform. + # The unique identifier of this object in the Accounting Data Service. # @type: string # @format: uuid field :network_id @@ -20,9 +20,6 @@ def self.id_ref # Example: If you store your company records in a database, whatever the primary key for the company table is # in the database should be the `ErpKey`. # - # Example: If you use a financial system such as QuickBooks or Xero, look for the primary ID number of the - # company record within that financial system. - # # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns). # @type: string field :erp_key @@ -145,16 +142,6 @@ def self.id_ref # @type: string field :duns_number - # If you know the AP (accounts payable) email address of this company, fill it in here. This is the email - # address where you would send questions to the company if the company owed you money. - # @type: string - field :ap_email_address - - # If you know the AR (accounts receivable) email address of this company, fill it in here. This is the email - # address where you would send questions to the company if you owed this company money. - # @type: string - field :ar_email_address - # Indicates the preferred invoice delivery method. Examples include Print, Email, Fax # @type: string field :preferred_delivery_method @@ -175,6 +162,10 @@ def self.id_ref # @type: string field :company_identifiers + # A reference code for the Company. This code is used to identify this company in external ERP systems. + # @type: string + field :reference_code + end \ No newline at end of file diff --git a/app/platform_api/schema/connector_info.rb b/app/platform_api/schema/connector_info.rb index ebae572..43e18ba 100644 --- a/app/platform_api/schema/connector_info.rb +++ b/app/platform_api/schema/connector_info.rb @@ -5,35 +5,10 @@ def self.id_ref nil end - # The authorization code returned from the first step of the OAuth2 flow - # https://oauth.net/2/grant-types/authorization-code/ - # @type: string - field :auth_code - - # The access token id for the connector enrollment. - # @type: string - field :token_id - - # The access token secret for the connector enrollment. - # @type: string - field :token_secret - # The realm id of the account being granted permissions to access # @type: string field :realm_id - # The subsidiary id that corresponds to a legal entity. - # @type: string - field :subsidiary_id - - # The redirect uri used for step one of the OAuth2.0 flow. - # @type: string - field :redirect_uri - - # The email an email connection is being created for. - # @type: string - field :email - # The username of the web services account with access permissions. # @type: string field :username @@ -42,31 +17,6 @@ def self.id_ref # @type: string field :password - # The server name a connection is being created for. - # @type: string - field :server_name - - # The port number of the server a connection is being created for. - # @type: integer - # @format: int32 - field :server_port - - # The Client Id for the connection being created. - # @type: string - field :client_id - - # The Secret for the connection being created. - # @type: string - field :client_secret - - # The TenantId for the connection being created. - # @type: string - field :tenant - - # The AuthToken for the connection being created. - # @type: string - field :auth_token - end \ No newline at end of file diff --git a/app/platform_api/schema/contact.rb b/app/platform_api/schema/contact.rb index 4d457b0..6d49c6d 100644 --- a/app/platform_api/schema/contact.rb +++ b/app/platform_api/schema/contact.rb @@ -6,7 +6,7 @@ def self.id_ref end # The unique ID of this record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # # For the ID of this record in its originating financial system, see `ErpKey`. # @type: string @@ -18,7 +18,7 @@ def self.id_ref # @format: uuid field :company_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/contact_sync.rb b/app/platform_api/schema/contact_sync.rb index 9323913..acb6b58 100644 --- a/app/platform_api/schema/contact_sync.rb +++ b/app/platform_api/schema/contact_sync.rb @@ -8,7 +8,7 @@ def self.id_ref # Indicates what action to take when an existing object has been found during the sync process. field :on_match_action - # The unique identifier of this object in the Sage Network platform. + # The unique identifier of this object in the Accounting Data Service. # @type: string # @format: uuid field :network_id diff --git a/app/platform_api/schema/credit_memo_applied.rb b/app/platform_api/schema/credit_memo_applied.rb index 7f611ce..2220228 100644 --- a/app/platform_api/schema/credit_memo_applied.rb +++ b/app/platform_api/schema/credit_memo_applied.rb @@ -6,14 +6,14 @@ def self.id_ref end # The unique ID of this record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # # For the ID of this record in its originating financial system, see `ErpKey`. # @type: string # @format: uuid field :credit_memo_applied_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -21,21 +21,21 @@ def self.id_ref # @format: uuid field :group_key - # The ADS Platform ID of the Invoice to which this credit memo was applied. This Invoice's outstanding balance + # The Accounting Data Service ID of the Invoice to which this credit memo was applied. This Invoice's outstanding balance # was reduced by the value of the field `CreditMemoAppliedAmount` on the date `ApplyToInvoiceDate`. # # Example: Company ABC received a credit memo, CM000123 for $500. Company ABC then chooses to apply this - # credit memo to reduce the balance of the invoice PO1000578. The `InvoiceErpKey` is the ADS Platform + # credit memo to reduce the balance of the invoice PO1000578. The `InvoiceErpKey` is the Accounting Data Service # ID number of Invoice `PO1000578`. # @type: string # @format: uuid field :invoice_id - # The ADS Platform ID of the Invoice of type "Credit Memo" that was consumed in this payment application event. + # The Accounting Data Service ID of the Invoice of type "Credit Memo" that was consumed in this payment application event. # # Example: Company ABC received a credit memo, CM000123 for $500. Company ABC then chooses to apply this # credit memo to reduce the balance of the invoice PO1000578. The `CreditMemoInvoiceId` is the ADS - # Platform ID number of Invoice `CM000123`. + # Network Id number of Invoice `CM000123`. # @type: string # @format: uuid field :credit_memo_invoice_id diff --git a/app/platform_api/schema/credit_memo_applied_sync.rb b/app/platform_api/schema/credit_memo_applied_sync.rb index 85f8c7c..b41a0b7 100644 --- a/app/platform_api/schema/credit_memo_applied_sync.rb +++ b/app/platform_api/schema/credit_memo_applied_sync.rb @@ -8,7 +8,7 @@ def self.id_ref # Indicates what action to take when an existing object has been found during the sync process. field :on_match_action - # The unique identifier of this object in the Sage Network platform. + # The unique identifier of this object in the Accounting Data Service. # @type: string # @format: uuid field :network_id diff --git a/app/platform_api/schema/credit_memo_invoice.rb b/app/platform_api/schema/credit_memo_invoice.rb index 50e3109..1f8ca4d 100644 --- a/app/platform_api/schema/credit_memo_invoice.rb +++ b/app/platform_api/schema/credit_memo_invoice.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -22,7 +22,7 @@ def self.id_ref field :currency_code # The unique ID of this record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # @type: string # @format: uuid field :credit_memo_applied_id @@ -91,6 +91,12 @@ def self.id_ref # @format: double field :base_currency_outstanding_balance_amount + # Possible statuses for a record that supports ERP Update. + field :erp_update_status + + # Possible actions for a record that supports ERP Update. + field :erp_update_action + belongs_to :company, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"} belongs_to :account, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"} belongs_to :customer, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"} diff --git a/app/platform_api/schema/custom_field_definition.rb b/app/platform_api/schema/custom_field_definition.rb index 164d18f..479a06f 100644 --- a/app/platform_api/schema/custom_field_definition.rb +++ b/app/platform_api/schema/custom_field_definition.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -14,7 +14,7 @@ def self.id_ref field :group_key # The unique ID of this record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # @type: string # @format: uuid field :custom_field_definition_id diff --git a/app/platform_api/schema/custom_field_value.rb b/app/platform_api/schema/custom_field_value.rb index 8d3201b..0282616 100644 --- a/app/platform_api/schema/custom_field_value.rb +++ b/app/platform_api/schema/custom_field_value.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -14,7 +14,7 @@ def self.id_ref field :group_key # The unique ID of this record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # @type: string # @format: uuid field :custom_field_definition_id diff --git a/app/platform_api/schema/customer_summary.rb b/app/platform_api/schema/customer_summary.rb index 39d00c0..8bfd55f 100644 --- a/app/platform_api/schema/customer_summary.rb +++ b/app/platform_api/schema/customer_summary.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/financial_account.rb b/app/platform_api/schema/financial_account.rb index 5514144..dc1b21d 100644 --- a/app/platform_api/schema/financial_account.rb +++ b/app/platform_api/schema/financial_account.rb @@ -10,7 +10,7 @@ def self.id_ref # @format: uuid field :financial_account_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/financial_account_balance_history.rb b/app/platform_api/schema/financial_account_balance_history.rb index 2aafa50..0a5aa8a 100644 --- a/app/platform_api/schema/financial_account_balance_history.rb +++ b/app/platform_api/schema/financial_account_balance_history.rb @@ -6,12 +6,12 @@ def self.id_ref end # The unique ID of this record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # @type: string # @format: uuid field :financial_account_balance_history_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/financial_account_balance_history_sync.rb b/app/platform_api/schema/financial_account_balance_history_sync.rb index e406315..1e539bd 100644 --- a/app/platform_api/schema/financial_account_balance_history_sync.rb +++ b/app/platform_api/schema/financial_account_balance_history_sync.rb @@ -14,9 +14,7 @@ def self.id_ref # identifying number is in the originating system. Search for a unique, non-changing number within the # originating financial system for this record. # Example: If you store your company records in a database, whatever the primary key for the company table is - # in the database should be the ErpKey. - # Example: If you use a financial system such as QuickBooks or Xero, look for the primary ID number of the - # company record within that financial system. + # in the database should be the ErpKey. # @type: string field :financial_account_erp_key diff --git a/app/platform_api/schema/financial_institution_account.rb b/app/platform_api/schema/financial_institution_account.rb index a2ba75e..0294a60 100644 --- a/app/platform_api/schema/financial_institution_account.rb +++ b/app/platform_api/schema/financial_institution_account.rb @@ -10,7 +10,7 @@ def self.id_ref # @format: uuid field :financial_institution_account_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/financial_year_setting.rb b/app/platform_api/schema/financial_year_setting.rb index df78917..444de7b 100644 --- a/app/platform_api/schema/financial_year_setting.rb +++ b/app/platform_api/schema/financial_year_setting.rb @@ -6,12 +6,12 @@ def self.id_ref end # The unique ID of this record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # @type: string # @format: uuid field :financial_year_setting_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/group_account.rb b/app/platform_api/schema/group_account.rb index f35a203..e7639f0 100644 --- a/app/platform_api/schema/group_account.rb +++ b/app/platform_api/schema/group_account.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -63,6 +63,11 @@ def self.id_ref # @type: string field :country_code + # Workflow status when ERP sync is started for e-Invoices + # @type: string + # @format: uuid + field :e_invoice_sync_workflow_status + belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"} belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"} diff --git a/app/platform_api/schema/invoice.rb b/app/platform_api/schema/invoice.rb index 4943159..083494c 100644 --- a/app/platform_api/schema/invoice.rb +++ b/app/platform_api/schema/invoice.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -14,7 +14,7 @@ def self.id_ref field :group_key # The unique ID of this record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # # For the ID of this record in its originating financial system, see `ErpKey`. # @type: string @@ -171,6 +171,11 @@ def self.id_ref # @format: date field :payment_due_date + # The date when payment is planned in Connect. + # @type: string + # @format: date + field :planned_payment_date + # The date and time when this record was imported from the user's ERP or accounting system. # @type: string # @format: date-time @@ -321,6 +326,16 @@ def self.id_ref # @type: string field :jurisdiction + # The ID of the sync task that created this Invoice. + # @type: string + # @format: uuid + field :created_sync_id + + # The ID of the sync task that modified this Invoice. + # @type: string + # @format: uuid + field :modified_sync_id + belongs_to :company, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"} belongs_to :account, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"} belongs_to :customer, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"} diff --git a/app/platform_api/schema/invoice_address.rb b/app/platform_api/schema/invoice_address.rb index d7b89d9..abc4e45 100644 --- a/app/platform_api/schema/invoice_address.rb +++ b/app/platform_api/schema/invoice_address.rb @@ -6,12 +6,12 @@ def self.id_ref end # The unique ID of this record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # @type: string # @format: uuid field :invoice_address_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/invoice_line.rb b/app/platform_api/schema/invoice_line.rb index 22381ad..1db8000 100644 --- a/app/platform_api/schema/invoice_line.rb +++ b/app/platform_api/schema/invoice_line.rb @@ -6,14 +6,14 @@ def self.id_ref end # The unique ID of this record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # # For the ID of this record in its originating financial system, see `ErpKey`. # @type: string # @format: uuid field :invoice_line_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -131,21 +131,6 @@ def self.id_ref # @format: date field :reporting_date - # An optional ID number for the line's origin address. - # @type: string - # @format: uuid - field :override_origin_address_id - - # An optional ID number for the line's bill to address. - # @type: string - # @format: uuid - field :override_bill_to_address_id - - # An optional ID number for the line's ship to address. - # @type: string - # @format: uuid - field :override_ship_to_address_id - # The date on which this line was created. # @type: string # @format: date-time diff --git a/app/platform_api/schema/invoice_line_sync.rb b/app/platform_api/schema/invoice_line_sync.rb index 2430df2..40c1e98 100644 --- a/app/platform_api/schema/invoice_line_sync.rb +++ b/app/platform_api/schema/invoice_line_sync.rb @@ -8,7 +8,7 @@ def self.id_ref # Indicates what action to take when an existing object has been found during the sync process. field :on_match_action - # The unique identifier of this object in the Sage Network platform. + # The unique identifier of this object in the Accounting Data Service. # @type: string # @format: uuid field :network_id @@ -129,120 +129,6 @@ def self.id_ref # @format: date-time field :reporting_date, Types::Params::DateTime - # Origination address for this invoice line, if this line item was originated from a different address - # @type: string - field :origin_address_line1 - - # Origination address for this invoice line, if this line item was originated from a different address - # @type: string - field :origin_address_line2 - - # Origination address for this invoice line, if this line item was originated from a different address - # @type: string - field :origin_address_line3 - - # Origination address for this invoice line, if this line item was originated from a different address - # @type: string - field :origin_address_city - - # Origination address for this invoice line, if this line item was originated from a different address - # @type: string - field :origin_address_region - - # Origination address for this invoice line, if this line item was originated from a different address - # @type: string - field :origin_address_postal_code - - # Origination address for this invoice line, if this line item was originated from a different address - # @type: string - field :origin_address_country - - # Origination address for this invoice line, if this line item was originated from a different address - # @type: number - # @format: float - field :origin_address_latitude - - # Origination address for this invoice line, if this line item was originated from a different address - # @type: number - # @format: float - field :origin_address_longitude - - # Billing address for this invoice line, if this line item is to be billed to a different address - # @type: string - field :bill_to_address_line1 - - # Billing address for this invoice line, if this line item is to be billed to a different address - # @type: string - field :bill_to_address_line2 - - # Billing address for this invoice line, if this line item is to be billed to a different address - # @type: string - field :bill_to_address_line3 - - # Billing address for this invoice line, if this line item is to be billed to a different address - # @type: string - field :bill_to_address_city - - # Billing address for this invoice line, if this line item is to be billed to a different address - # @type: string - field :bill_to_address_region - - # Billing address for this invoice line, if this line item is to be billed to a different address - # @type: string - field :bill_to_address_postal_code - - # Billing address for this invoice line, if this line item is to be billed to a different address - # @type: string - field :bill_to_address_country - - # Billing address for this invoice line, if this line item is to be billed to a different address - # @type: number - # @format: float - field :bill_to_address_latitude - - # Billing address for this invoice line, if this line item is to be billed to a different address - # @type: number - # @format: float - field :bill_to_address_longitude - - # Shipping address for this invoice line, if this line item is to be shipped to a different address - # @type: string - field :ship_to_address_line1 - - # Shipping address for this invoice line, if this line item is to be shipped to a different address - # @type: string - field :ship_to_address_line2 - - # Shipping address for this invoice line, if this line item is to be shipped to a different address - # @type: string - field :ship_to_address_line3 - - # Shipping address for this invoice line, if this line item is to be shipped to a different address - # @type: string - field :ship_to_address_city - - # Shipping address for this invoice line, if this line item is to be shipped to a different address - # @type: string - field :ship_to_address_region - - # Shipping address for this invoice line, if this line item is to be shipped to a different address - # @type: string - field :ship_to_address_postal_code - - # Shipping address for this invoice line, if this line item is to be shipped to a different address - # @type: string - field :ship_to_address_country - - # Shipping address for this invoice line, if this line item is to be shipped to a different address - # @type: number - # @format: float - field :ship_to_address_latitude - - # Shipping address for this invoice line, if this line item is to be shipped to a different address - # @type: number - # @format: float - field :ship_to_address_longitude - # If known, the date when this record was created according to the originating financial system # in which this record is maintained. If the originating financial system does not maintain a # created-date, leave this field null. diff --git a/app/platform_api/schema/invoice_payment_detail.rb b/app/platform_api/schema/invoice_payment_detail.rb index b4427de..6935278 100644 --- a/app/platform_api/schema/invoice_payment_detail.rb +++ b/app/platform_api/schema/invoice_payment_detail.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -81,6 +81,12 @@ def self.id_ref # @format: double field :base_currency_unapplied_amount + # Possible statuses for a record that supports ERP Update. + field :erp_update_status + + # Possible actions for a record that supports ERP Update. + field :erp_update_action + belongs_to :company, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"} belongs_to :account, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"} diff --git a/app/platform_api/schema/invoice_summary.rb b/app/platform_api/schema/invoice_summary.rb index 4709af0..3f02fc8 100644 --- a/app/platform_api/schema/invoice_summary.rb +++ b/app/platform_api/schema/invoice_summary.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/invoice_sync.rb b/app/platform_api/schema/invoice_sync.rb index 27d0785..6ab2dbf 100644 --- a/app/platform_api/schema/invoice_sync.rb +++ b/app/platform_api/schema/invoice_sync.rb @@ -8,7 +8,7 @@ def self.id_ref # Indicates what action to take when an existing object has been found during the sync process. field :on_match_action - # The unique identifier of this object in the Sage Network platform. + # The unique identifier of this object in the Accounting Data Service. # @type: string # @format: uuid field :network_id @@ -163,6 +163,10 @@ def self.id_ref # @format: date-time field :payment_due_date, Types::Params::DateTime + # The date when payment is planned in Connect. + # @type: string + field :planned_payment_date + # The date and time when this record was imported from the user's ERP or accounting system. # @type: string # @format: date-time diff --git a/app/platform_api/schema/invoice_workflow_status_history.rb b/app/platform_api/schema/invoice_workflow_status_history.rb index 75e075f..836ecd2 100644 --- a/app/platform_api/schema/invoice_workflow_status_history.rb +++ b/app/platform_api/schema/invoice_workflow_status_history.rb @@ -5,8 +5,8 @@ def self.id_ref nil end - # The unique ID of this record, automatically assigned by ADS Platform when this record is - # added to the Accounting Data Services platform. + # The unique ID of this record, automatically assigned by Accounting Data Service when this record is + # added to the Accounting Data Services network. # @type: string # @format: uuid field :invoice_workflow_status_history_id @@ -30,7 +30,7 @@ def self.id_ref # @format: uuid field :workflow_transition_id - # The GroupKey uniquely identifies a single Accounting Data Services Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Services Network account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -58,6 +58,14 @@ def self.id_ref # @format: uuid field :created_user_id + # The TraceId of the call made to create the invoice workflow status history. + # @type: string + field :trace_id + + # The span id of the parent call to create the invoice workflow status history. + # @type: string + field :trace_parent + belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"} diff --git a/app/platform_api/schema/magic_link.rb b/app/platform_api/schema/magic_link.rb index c15e046..4dfee97 100644 --- a/app/platform_api/schema/magic_link.rb +++ b/app/platform_api/schema/magic_link.rb @@ -6,12 +6,12 @@ def self.id_ref end # The unique ID of this record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # @type: string # @format: uuid field :magic_link_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # @type: string # @format: uuid diff --git a/app/platform_api/schema/note.rb b/app/platform_api/schema/note.rb index 3a1c735..1e798fa 100644 --- a/app/platform_api/schema/note.rb +++ b/app/platform_api/schema/note.rb @@ -6,12 +6,12 @@ def self.id_ref end # The unique ID of this record, automatically assigned by ADS when this record is - # added to the ADS Platform. + # added to the Accounting Data Service. # @type: string # @format: uuid field :note_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -19,22 +19,22 @@ def self.id_ref # @format: uuid field :group_key - # A Note is connected to an existing item within the ADS Platform by the fields `TableKey` and + # A Note is connected to an existing item within the Accounting Data Service by the fields `TableKey` and # `ObjectKey`. For example, a Note connected to Invoice 12345 would have a `TableKey` value of # `Invoice` and an `ObjectKey` value of `12345`. # - # The `TableKey` value contains the name of the table within the ADS Platform to which this metadata + # The `TableKey` value contains the name of the table within the Accounting Data Service to which this metadata # is connected. # # For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object). # @type: string field :table_key - # A Note is connected to an existing item within the ADS Platform by the fields `TableKey` and + # A Note is connected to an existing item within the Accounting Data Service by the fields `TableKey` and # `ObjectKey`. For example, a Note connected to Invoice 12345 would have a `TableKey` value of # `Invoice` and an `ObjectKey` value of `12345`. # - # The `ObjectKey` value contains the primary key of the record within the ADS Platform to which this + # The `ObjectKey` value contains the primary key of the record within the Accounting Data Service to which this # metadata is connected. # # For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object). diff --git a/app/platform_api/schema/object_event.rb b/app/platform_api/schema/object_event.rb new file mode 100644 index 0000000..2d9f157 --- /dev/null +++ b/app/platform_api/schema/object_event.rb @@ -0,0 +1,69 @@ +class Schema::ObjectEvent < Lockstep::ApiRecord + +# ApiRecord will crash unless `id_ref` is defined +def self.id_ref + nil +end + + # Identifier for event + # @type: string + field :id + + # Identifies the context in which this event happened + # @type: string + field :source + + # Version of the CloudEvents specification which the event uses + # @type: string + field :spec_version + + # Value describing the type of even relating to the originating occurrence + # NOTE: Type format should be {entity type}.{event action} + # @type: string + field :type + + # Contains trace information such as version, trace ID, span ID and trace options + # @type: string + field :trace_parent + + # Comma-delimited list of trace key value pairs + # @type: string + field :trace_state + + # Content type of data value + # @type: string + field :data_content_type + + # Identifies the schema the data value adheres to + # @type: string + field :data_schema + + # Identifies the subject of the event in the context of the even producer (identified by source) + # @type: string + field :subject + + # Timestamp of when the occurrence happened + # @type: string + # @format: date-time + field :time, Types::Params::DateTime + + # Subscription id related to the notification + # @type: string + field :subscription_id + + # Account id related to the notification + # @type: string + field :account_id + + # Dataset related to the notification + # @type: string + # @format: uuid + field :dataset_id + + # Source domain-specific information about the occurrence to be deserialized based on the information in DataContentType + # or DataSchema or by default content type - application/json + field :data + + + +end \ No newline at end of file diff --git a/app/platform_api/schema/payment.rb b/app/platform_api/schema/payment.rb index ff08e7c..a2ab72d 100644 --- a/app/platform_api/schema/payment.rb +++ b/app/platform_api/schema/payment.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -13,8 +13,8 @@ def self.id_ref # @format: uuid field :group_key - # The unique ID of this record, automatically assigned by ADS Platform when this record is - # added to the ADS Platform. + # The unique ID of this record, automatically assigned by Accounting Data Service when this record is + # added to the Accounting Data Service. # # For the ID of this record in its originating financial system, see `ErpKey`. # @type: string @@ -173,6 +173,18 @@ def self.id_ref # @format: date-time field :source_modified_date, Types::Params::DateTime + # The tax code of this payment. + # @type: string + field :tax_code + + # The financial account code of this payment. + # @type: string + field :financial_account_code + + # Optional field to indicate if the payment has a PDF attached to it. + # @type: boolean + field :has_pdf + # Additional attributes that may be required by the source system. # @type: object field :erp_system_attributes diff --git a/app/platform_api/schema/payment_applied.rb b/app/platform_api/schema/payment_applied.rb index 3f8337e..a9f4690 100644 --- a/app/platform_api/schema/payment_applied.rb +++ b/app/platform_api/schema/payment_applied.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -13,8 +13,8 @@ def self.id_ref # @format: uuid field :group_key - # The unique ID of this record, automatically assigned by ADS Platform when this record is - # added to the ADS Platform. + # The unique ID of this record, automatically assigned by Accounting Data Service when this record is + # added to the Accounting Data Service. # # For the ID of this record in its originating financial system, see `ErpKey`. # @type: string diff --git a/app/platform_api/schema/payment_applied_sync.rb b/app/platform_api/schema/payment_applied_sync.rb index 972a8cd..0e7f864 100644 --- a/app/platform_api/schema/payment_applied_sync.rb +++ b/app/platform_api/schema/payment_applied_sync.rb @@ -8,7 +8,7 @@ def self.id_ref # Indicates what action to take when an existing object has been found during the sync process. field :on_match_action - # The unique identifier of this object in the Sage Network platform. + # The unique identifier of this object in the Accounting Data Service. # @type: string # @format: uuid field :network_id diff --git a/app/platform_api/schema/payment_detail.rb b/app/platform_api/schema/payment_detail.rb index a29d6b6..8df1bac 100644 --- a/app/platform_api/schema/payment_detail.rb +++ b/app/platform_api/schema/payment_detail.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -43,7 +43,7 @@ def self.id_ref # @type: string field :email - # Possible statuses for a record that supports ERP write. + # Possible statuses for a record that supports ERP Update. field :erp_write_status # The name of the ErpWriteStatus for this payment diff --git a/app/platform_api/schema/payment_summary.rb b/app/platform_api/schema/payment_summary.rb index 4b90f6e..747439b 100644 --- a/app/platform_api/schema/payment_summary.rb +++ b/app/platform_api/schema/payment_summary.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/payment_sync.rb b/app/platform_api/schema/payment_sync.rb index dc8a6f5..0e3a8e1 100644 --- a/app/platform_api/schema/payment_sync.rb +++ b/app/platform_api/schema/payment_sync.rb @@ -8,7 +8,7 @@ def self.id_ref # Indicates what action to take when an existing object has been found during the sync process. field :on_match_action - # The unique identifier of this object in the Sage Network platform. + # The unique identifier of this object in the Accounting Data Service. # @type: string # @format: uuid field :network_id @@ -140,6 +140,14 @@ def self.id_ref # @type: string field :bank_account_id + # The tax code of this payment. + # @type: string + field :tax_code + + # The financial account code of this payment. + # @type: string + field :financial_account_code + end \ No newline at end of file diff --git a/app/platform_api/schema/status.rb b/app/platform_api/schema/status.rb index 723c0df..0e9d8fd 100644 --- a/app/platform_api/schema/status.rb +++ b/app/platform_api/schema/status.rb @@ -91,10 +91,10 @@ def self.id_ref # Magic link information about the user field :magic_link - # Information allowing ADS Platform to offer direct support to the user + # Information allowing Accounting Data Service to offer direct support to the user field :support_access - # True if the user is being impersonated by the ADS Platform support team. + # True if the user is being impersonated by the Accounting Data Service support team. # @type: boolean field :is_impersonated diff --git a/app/platform_api/schema/sync_request.rb b/app/platform_api/schema/sync_request.rb index 0c211c1..c1f6aea 100644 --- a/app/platform_api/schema/sync_request.rb +++ b/app/platform_api/schema/sync_request.rb @@ -5,13 +5,13 @@ def self.id_ref nil end - # The unique ID of this record, automatically assigned by ADS Platform when this record is - # added to the ADS Platform. + # The unique ID of this record, automatically assigned by Accounting Data Service when this record is + # added to the Accounting Data Service. # @type: string # @format: uuid field :sync_request_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -99,6 +99,10 @@ def self.id_ref # @format: int32 field :total_batches + # An optional trace parent for the sync request + # @type: string + field :trace_parent + belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"} diff --git a/app/platform_api/schema/user_account.rb b/app/platform_api/schema/user_account.rb index 1aec992..0765fe9 100644 --- a/app/platform_api/schema/user_account.rb +++ b/app/platform_api/schema/user_account.rb @@ -5,15 +5,15 @@ def self.id_ref nil end - # The unique ID of this record, automatically assigned by ADS Platform when this record is - # added to the ADS Platform. + # The unique ID of this record, automatically assigned by Accounting Data Service when this record is + # added to the Accounting Data Service. # # This record provides a link to the user's Azure AD B2C OID. # @type: string # @format: uuid field :user_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/user_data_response.rb b/app/platform_api/schema/user_data_response.rb index 01c9a1d..1bac303 100644 --- a/app/platform_api/schema/user_data_response.rb +++ b/app/platform_api/schema/user_data_response.rb @@ -9,7 +9,7 @@ def self.id_ref # @type: object field :data - # The ADS Platform ID of the user + # The Accounting Data Service ID of the user # @type: string # @format: uuid field :user_id diff --git a/app/platform_api/schema/user_group.rb b/app/platform_api/schema/user_group.rb index ef23e37..1572706 100644 --- a/app/platform_api/schema/user_group.rb +++ b/app/platform_api/schema/user_group.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/user_role.rb b/app/platform_api/schema/user_role.rb index a612cc6..ce2557c 100644 --- a/app/platform_api/schema/user_role.rb +++ b/app/platform_api/schema/user_role.rb @@ -5,13 +5,13 @@ def self.id_ref nil end - # The unique ID of this record, automatically assigned by ADS Platform when this record is - # added to the ADS Platform. + # The unique ID of this record, automatically assigned by Accounting Data Service when this record is + # added to the Accounting Data Service. # @type: string # @format: uuid field :user_role_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/vendor_summary.rb b/app/platform_api/schema/vendor_summary.rb index 152cbda..553a786 100644 --- a/app/platform_api/schema/vendor_summary.rb +++ b/app/platform_api/schema/vendor_summary.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). diff --git a/app/platform_api/schema/webhook.rb b/app/platform_api/schema/webhook.rb index 179d9fa..a7ebca8 100644 --- a/app/platform_api/schema/webhook.rb +++ b/app/platform_api/schema/webhook.rb @@ -5,13 +5,13 @@ def self.id_ref nil end - # The unique ID of this record, automatically assigned by ADS Platform when this record is - # added to the ADS Platform. + # The unique ID of this record, automatically assigned by Accounting Data Service when this record is + # added to the Accounting Data Service. # @type: string # @format: uuid field :webhook_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -32,7 +32,7 @@ def self.id_ref field :status_message # An secret set during webhook creation that can be used to verify that the notification - # is coming from the ADS Platform API. + # is coming from the Accounting Data Service API. # @type: string field :client_secret @@ -46,7 +46,7 @@ def self.id_ref # The URL where the notification will be sent via the method set in CallbackHttpMethod. # - # When creating a webhook, the ADS Platform API will make a call to this url via the method + # When creating a webhook, the Accounting Data Service API will make a call to this url via the method # set in the CallbackHttpMethod property with a query parameter of "code" set to an encoded # string. To successfully create the webhook, the call must return a successful status code # with the query parameter's value as the plain text content. diff --git a/app/platform_api/schema/webhook_history_table_storage.rb b/app/platform_api/schema/webhook_history_table_storage.rb index 72def9a..7abd88a 100644 --- a/app/platform_api/schema/webhook_history_table_storage.rb +++ b/app/platform_api/schema/webhook_history_table_storage.rb @@ -5,7 +5,7 @@ def self.id_ref nil end - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -18,8 +18,8 @@ def self.id_ref # @format: uuid field :webhook_id - # The unique ID of this record, automatically assigned by ADS Platform when this record is - # added to the ADS Platform. + # The unique ID of this record, automatically assigned by Accounting Data Service when this record is + # added to the Accounting Data Service. # @type: string # @format: uuid field :webhook_history_id diff --git a/app/platform_api/schema/webhook_rule.rb b/app/platform_api/schema/webhook_rule.rb index a8545d1..473b5f6 100644 --- a/app/platform_api/schema/webhook_rule.rb +++ b/app/platform_api/schema/webhook_rule.rb @@ -5,8 +5,8 @@ def self.id_ref nil end - # The unique ID of this record, automatically assigned by ADS Platform when this record is - # added to the ADS Platform. + # The unique ID of this record, automatically assigned by Accounting Data Service when this record is + # added to the Accounting Data Service. # @type: string # @format: uuid field :webhook_rule_id @@ -16,7 +16,7 @@ def self.id_ref # @format: uuid field :webhook_id - # The GroupKey uniquely identifies a single ADS Platform account. All records for this + # The GroupKey uniquely identifies a single Accounting Data Service account. All records for this # account will share the same GroupKey value. GroupKey values cannot be changed once created. # # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys). @@ -28,7 +28,7 @@ def self.id_ref # For example, a Webhook setup for when an Invoice is Created would have a `TableKey` value of # `Invoice` and an `EventType` value of `I` (Insert). # - # The `TableKey` value contains the name of the table within the ADS Platform to which this metadata + # The `TableKey` value contains the name of the table within the Accounting Data Service to which this metadata # is connected. # # For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object). diff --git a/app/platform_api/schema/workflow_status.rb b/app/platform_api/schema/workflow_status.rb index 2018240..60edbbe 100644 --- a/app/platform_api/schema/workflow_status.rb +++ b/app/platform_api/schema/workflow_status.rb @@ -5,8 +5,8 @@ def self.id_ref nil end - # The unique ID of this record, automatically assigned by ADS Platform when this record is - # added to the Accounting Data Services platform. + # The unique ID of this record, automatically assigned by Accounting Data Service when this record is + # added to the Accounting Data Services network. # @type: string # @format: uuid field :id diff --git a/app/platform_api/swagger.json b/app/platform_api/swagger.json index 25efa96..a71902d 100644 --- a/app/platform_api/swagger.json +++ b/app/platform_api/swagger.json @@ -11,7 +11,7 @@ "ApiKeys" ], "summary": "Retrieve API Key", - "description": "Retrieves the API Key with this identifier.\r\n\r\nAn API Key is an authentication token that you may use with the ADS Platform API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the ADS Platform API. When you create an API Key, make sure to save the value in a secure location. ADS Platform cannot retrieve an API Key once it is created.\r\n\r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).\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.", + "description": "Retrieves the API Key with this identifier.\r\n\r\nAn API Key is an authentication token that you may use with the Accounting Data Service API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the Accounting Data Service API. When you create an API Key, make sure to save the value in a secure location. Accounting Data Service cannot retrieve an API Key once it is created.\r\n\r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).\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.", "operationId": "v1_ApiKeys_RetrieveApiKey", "parameters": [ { @@ -36,7 +36,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -59,13 +59,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -74,13 +74,13 @@ "ApiKeys" ], "summary": "Revoke API Key", - "description": "Immediately revokes the API Key with the specified id so it cannot be used to call the API.\r\n\r\nThe ADS Platform guarantees that revocation will be received by all servers within five minutes of revocation. API calls made using this API key after the revocation will fail. A revoked API Key cannot be un-revoked and may be removed 60 days after revocation.\r\n\r\nAn API Key is an authentication token that you may use with the ADS Platform API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the ADS Platform API. When you create an API Key, make sure to save the value in a secure location. ADS Platform cannot retrieve an API Key once it is created.\r\n\r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).\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.", + "description": "Immediately revokes the API Key with the specified id so it cannot be used to call the API.\r\n\r\nThe Accounting Data Service guarantees that revocation will be received by all servers within five minutes of revocation. API calls made using this API key after the revocation will fail. A revoked API Key cannot be un-revoked and may be removed 60 days after revocation.\r\n\r\nAn API Key is an authentication token that you may use with the Accounting Data Service API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the Accounting Data Service API. When you create an API Key, make sure to save the value in a secure location. Accounting Data Service cannot retrieve an API Key once it is created.\r\n\r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).\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.", "operationId": "v1_ApiKeys_RevokeApiKey", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this API Key", + "description": "The unique Accounting Data Service ID number of this API Key", "required": true, "schema": { "type": "string", @@ -90,7 +90,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -143,13 +143,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -160,7 +160,7 @@ "ApiKeys" ], "summary": "Create API Key", - "description": "Creates an API key with the specified name.\r\n\r\nAn API Key is an authentication token that you may use with the ADS Platform API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the ADS Platform API. When you create an API Key, make sure to save the value in a secure location. ADS Platform cannot retrieve an API Key once it is created.\r\n\r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).\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.", + "description": "Creates an API key with the specified name.\r\n\r\nAn API Key is an authentication token that you may use with the Accounting Data Service API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the Accounting Data Service API. When you create an API Key, make sure to save the value in a secure location. Accounting Data Service cannot retrieve an API Key once it is created.\r\n\r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).\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.", "operationId": "v1_ApiKeys_CreateApiKey", "requestBody": { "description": "Metadata about the API Key to create.", @@ -172,7 +172,7 @@ "$ref": "#/components/schemas/ApiKeyModel" } ], - "description": "An API Key is an authentication token that you may use with the ADS Platform API. Because API Keys\r\ndo not have an expiration date, they are well suited for unattended processes. Each API Key\r\nis associated with a user, and may be revoked to prevent it from accessing the ADS Platform API.\r\nWhen you create an API Key, make sure to save the value in a secure location. ADS Platform cannot\r\nretrieve an API Key once it is created.\r\n \r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys)." + "description": "An API Key is an authentication token that you may use with the Accounting Data Service API. Because API Keys\r\ndo not have an expiration date, they are well suited for unattended processes. Each API Key\r\nis associated with a user, and may be revoked to prevent it from accessing the Accounting Data Service API.\r\nWhen you create an API Key, make sure to save the value in a secure location. Accounting Data Service cannot\r\nretrieve an API Key once it is created.\r\n \r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys)." } }, "text/json": { @@ -182,7 +182,7 @@ "$ref": "#/components/schemas/ApiKeyModel" } ], - "description": "An API Key is an authentication token that you may use with the ADS Platform API. Because API Keys\r\ndo not have an expiration date, they are well suited for unattended processes. Each API Key\r\nis associated with a user, and may be revoked to prevent it from accessing the ADS Platform API.\r\nWhen you create an API Key, make sure to save the value in a secure location. ADS Platform cannot\r\nretrieve an API Key once it is created.\r\n \r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys)." + "description": "An API Key is an authentication token that you may use with the Accounting Data Service API. Because API Keys\r\ndo not have an expiration date, they are well suited for unattended processes. Each API Key\r\nis associated with a user, and may be revoked to prevent it from accessing the Accounting Data Service API.\r\nWhen you create an API Key, make sure to save the value in a secure location. Accounting Data Service cannot\r\nretrieve an API Key once it is created.\r\n \r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys)." } }, "application/*+json": { @@ -192,7 +192,7 @@ "$ref": "#/components/schemas/ApiKeyModel" } ], - "description": "An API Key is an authentication token that you may use with the ADS Platform API. Because API Keys\r\ndo not have an expiration date, they are well suited for unattended processes. Each API Key\r\nis associated with a user, and may be revoked to prevent it from accessing the ADS Platform API.\r\nWhen you create an API Key, make sure to save the value in a secure location. ADS Platform cannot\r\nretrieve an API Key once it is created.\r\n \r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys)." + "description": "An API Key is an authentication token that you may use with the Accounting Data Service API. Because API Keys\r\ndo not have an expiration date, they are well suited for unattended processes. Each API Key\r\nis associated with a user, and may be revoked to prevent it from accessing the Accounting Data Service API.\r\nWhen you create an API Key, make sure to save the value in a secure location. Accounting Data Service cannot\r\nretrieve an API Key once it is created.\r\n \r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys)." } } } @@ -237,13 +237,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -254,7 +254,7 @@ "ApiKeys" ], "summary": "Query API Keys", - "description": "Queries API Keys for this user using the specified filtering, sorting, nested fetch, and pagination rules requested.\r\n\r\nAn API Key is an authentication token that you may use with the ADS Platform API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the ADS Platform API. When you create an API Key, make sure to save the value in a secure location. ADS Platform cannot retrieve an API Key once it is created.\r\n\r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).\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.", + "description": "Queries API Keys for this user using the specified filtering, sorting, nested fetch, and pagination rules requested.\r\n\r\nAn API Key is an authentication token that you may use with the Accounting Data Service API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the Accounting Data Service API. When you create an API Key, make sure to save the value in a secure location. Accounting Data Service cannot retrieve an API Key once it is created.\r\n\r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).\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.", "operationId": "v1_ApiKeys_QueryApiKeys", "parameters": [ { @@ -302,7 +302,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -340,13 +340,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -357,7 +357,7 @@ "AppEnrollments" ], "summary": "Retrieve App Enrollment", - "description": "Retrieves the App Enrollment with this identifier.\r\n\r\nAn App Enrollment represents an app that has been enrolled to the current account. When you sign up for an app using the ADS Platform, you obtain an enrollment record for that app. Example types of apps include connectors and feature enhancement apps. The App Enrollment object contains information about this app, its configuration, and settings.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", + "description": "Retrieves the App Enrollment with this identifier.\r\n\r\nAn App Enrollment represents an app that has been enrolled to the current account. When you sign up for an app using the Accounting Data Service, you obtain an enrollment record for that app. Example types of apps include connectors and feature enhancement apps. The App Enrollment object contains information about this app, its configuration, and settings.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", "operationId": "v1_AppEnrollments_RetrieveAppEnrollment", "parameters": [ { @@ -381,7 +381,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -419,13 +419,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -434,7 +434,7 @@ "AppEnrollments" ], "summary": "Update App Enrollment", - "description": "Updates an existing App Enrollment with the information supplied to this PATCH call.\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. For example, you can provide the field name \"IsActive\" and specify the new value \"False\"; this API will then change the value of IsActive to false.\r\n\r\nAn App Enrollment represents an app that has been enrolled to the current account. When you sign up for an app using the ADS Platform, you obtain an enrollment record for that app. Example types of apps include connectors and feature enhancement apps. The App Enrollment object contains information about this app, its configuration, and settings.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", + "description": "Updates an existing App Enrollment with the information supplied to this PATCH call.\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. For example, you can provide the field name \"IsActive\" and specify the new value \"False\"; this API will then change the value of IsActive to false.\r\n\r\nAn App Enrollment represents an app that has been enrolled to the current account. When you sign up for an app using the Accounting Data Service, you obtain an enrollment record for that app. Example types of apps include connectors and feature enhancement apps. The App Enrollment object contains information about this app, its configuration, and settings.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", "operationId": "v1_AppEnrollments_UpdateAppEnrollment", "parameters": [ { @@ -454,19 +454,19 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -503,7 +503,7 @@ } }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -526,13 +526,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -541,7 +541,7 @@ "AppEnrollments" ], "summary": "Delete App Enrollment", - "description": "Deletes the App Enrollment referred to by this unique identifier. An App Enrollment represents an app that has been enrolled to the current account. When you sign up for an app using the ADS Platform, you obtain an enrollment record for that app. Example types of apps include connectors and feature enhancement apps. The App Enrollment object contains information about this app, its configuration, and settings.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", + "description": "Deletes the App Enrollment referred to by this unique identifier. An App Enrollment represents an app that has been enrolled to the current account. When you sign up for an app using the Accounting Data Service, you obtain an enrollment record for that app. Example types of apps include connectors and feature enhancement apps. The App Enrollment object contains information about this app, its configuration, and settings.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", "operationId": "v1_AppEnrollments_DeleteAppEnrollment", "parameters": [ { @@ -566,7 +566,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -619,13 +619,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -636,7 +636,7 @@ "AppEnrollments" ], "summary": "Create App Enrollments", - "description": "Creates one or more App Enrollments within this account and returns the records as created.\r\n\r\nAn App Enrollment represents an app that has been enrolled to the current account. When you sign up for an app using the ADS Platform, you obtain an enrollment record for that app. Example types of apps include connectors and feature enhancement apps. The App Enrollment object contains information about this app, its configuration, and settings.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", + "description": "Creates one or more App Enrollments within this account and returns the records as created.\r\n\r\nAn App Enrollment represents an app that has been enrolled to the current account. When you sign up for an app using the Accounting Data Service, you obtain an enrollment record for that app. Example types of apps include connectors and feature enhancement apps. The App Enrollment object contains information about this app, its configuration, and settings.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", "operationId": "v1_AppEnrollments_CreateAppEnrollments", "parameters": [ { @@ -724,13 +724,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -822,7 +822,7 @@ } }, "424": { - "description": "Client Error", + "description": "Failed Dependency", "content": { "application/json": { "schema": { @@ -837,7 +837,7 @@ } }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -866,13 +866,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -883,7 +883,7 @@ "AppEnrollments" ], "summary": "Query App Enrollments", - "description": "Queries App Enrollments 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 ADS Platform Developer website.\r\n\r\nAn App Enrollment represents an app that has been enrolled to the current account. When you sign up for an app using the ADS Platform, you obtain an enrollment record for that app. Example types of apps include connectors and feature enhancement apps. The App Enrollment object contains information about this app, its configuration, and settings.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", + "description": "Queries App Enrollments 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 Accounting Data Service Developer website.\r\n\r\nAn App Enrollment represents an app that has been enrolled to the current account. When you sign up for an app using the Accounting Data Service, you obtain an enrollment record for that app. Example types of apps include connectors and feature enhancement apps. The App Enrollment object contains information about this app, its configuration, and settings.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", "operationId": "v1_AppEnrollments_QueryAppEnrollments", "parameters": [ { @@ -931,7 +931,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -954,13 +954,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -971,7 +971,7 @@ "AppEnrollments" ], "summary": "Query Enrollment Fields", - "description": "Queries custom fields settings for app enrollment within the ADS Platform 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 ADS Platform Developer website.\r\n\r\nAn App Enrollment represents an app that has been enrolled to the current account. When you sign up for an app using the ADS Platform, you obtain an enrollment record for that app. Example types of apps include connectors and feature enhancement apps. The App Enrollment object contains information about this app, its configuration, and settings.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", + "description": "Queries custom fields settings for app enrollment within the Accounting Data Service 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 Accounting Data Service Developer website.\r\n\r\nAn App Enrollment represents an app that has been enrolled to the current account. When you sign up for an app using the Accounting Data Service, you obtain an enrollment record for that app. Example types of apps include connectors and feature enhancement apps. The App Enrollment object contains information about this app, its configuration, and settings.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", "operationId": "v1_AppEnrollments_RetrieveAppEnrollmentCustomFields", "parameters": [ { @@ -987,7 +987,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -1025,13 +1025,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -1042,7 +1042,7 @@ "Applications" ], "summary": "Retrieve Application", - "description": "Retrieves the Application with this identifier.\r\n\r\nAn Application represents a feature available to customers within the ADS Platform. You can create Applications by working with your ADS Platform business development manager and publish them on the platform so that customers can browse and find your Application on the ADS Platform Marketplace. When a customer adds an Application to their account, they obtain an AppEnrollment which represents that customer's instance of this Application. The customer-specific AppEnrollment contains a customer's configuration data for the Application, which is not customer-specific.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", + "description": "Retrieves the Application with this identifier.\r\n\r\nAn Application represents a feature available to customers within the Accounting Data Service. You can create Applications by working with your Accounting Data Service business development manager and publish them on the network so that customers can browse and find your Application on the Accounting Data Service Marketplace. When a customer adds an Application to their account, they obtain an AppEnrollment which represents that customer's instance of this Application. The customer-specific AppEnrollment contains a customer's configuration data for the Application, which is not customer-specific.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", "operationId": "v1_Applications_RetrieveApplication", "parameters": [ { @@ -1067,7 +1067,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -1105,13 +1105,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -1120,7 +1120,7 @@ "Applications" ], "summary": "Update Application", - "description": "Updates an existing Application with the information supplied to this PATCH call.\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. For example, you can provide the field name \"IsActive\" and specify the new value \"False\"; this API will then change the value of IsActive to false.\r\n\r\nAn Application represents a feature available to customers within the ADS Platform. You can create Applications by working with your ADS Platform business development manager and publish them on the platform so that customers can browse and find your Application on the ADS Platform Marketplace. When a customer adds an Application to their account, they obtain an AppEnrollment which represents that customer's instance of this Application. The customer-specific AppEnrollment contains a customer's configuration data for the Application, which is not customer-specific.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", + "description": "Updates an existing Application with the information supplied to this PATCH call.\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. For example, you can provide the field name \"IsActive\" and specify the new value \"False\"; this API will then change the value of IsActive to false.\r\n\r\nAn Application represents a feature available to customers within the Accounting Data Service. You can create Applications by working with your Accounting Data Service business development manager and publish them on the network so that customers can browse and find your Application on the Accounting Data Service Marketplace. When a customer adds an Application to their account, they obtain an AppEnrollment which represents that customer's instance of this Application. The customer-specific AppEnrollment contains a customer's configuration data for the Application, which is not customer-specific.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", "operationId": "v1_Applications_UpdateApplication", "parameters": [ { @@ -1140,26 +1140,26 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -1210,15 +1210,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -1227,7 +1228,7 @@ "Applications" ], "summary": "Delete Application", - "description": "Deletes the Application referred to by this unique identifier. Information about this Application is retained but after the DELETE call, this Application is no longer available for use on the ADS Platform.\r\n\r\nAn Application represents a feature available to customers within the ADS Platform. You can create Applications by working with your ADS Platform business development manager and publish them on the platform so that customers can browse and find your Application on the ADS Platform Marketplace. When a customer adds an Application to their account, they obtain an AppEnrollment which represents that customer's instance of this Application. The customer-specific AppEnrollment contains a customer's configuration data for the Application, which is not customer-specific.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", + "description": "Deletes the Application referred to by this unique identifier. Information about this Application is retained but after the DELETE call, this Application is no longer available for use on the ADS Platform.\r\n\r\nAn Application represents a feature available to customers within the Accounting Data Service. You can create Applications by working with your Accounting Data Service business development manager and publish them on the network so that customers can browse and find your Application on the Accounting Data Service Marketplace. When a customer adds an Application to their account, they obtain an AppEnrollment which represents that customer's instance of this Application. The customer-specific AppEnrollment contains a customer's configuration data for the Application, which is not customer-specific.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", "operationId": "v1_Applications_DeleteApplication", "parameters": [ { @@ -1243,7 +1244,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -1279,15 +1280,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -1298,7 +1300,7 @@ "Applications" ], "summary": "Create Applications", - "description": "Creates one or more Applications and returns the records as created. Applications are universal and available across all accounts.\r\n\r\nAn Application represents a feature available to customers within the ADS Platform. You can create Applications by working with your ADS Platform business development manager and publish them on the platform so that customers can browse and find your Application on the ADS Platform Marketplace. When a customer adds an Application to their account, they obtain an AppEnrollment which represents that customer's instance of this Application. The customer-specific AppEnrollment contains a customer's configuration data for the Application, which is not customer-specific.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", + "description": "Creates one or more Applications and returns the records as created. Applications are universal and available across all accounts.\r\n\r\nAn Application represents a feature available to customers within the Accounting Data Service. You can create Applications by working with your Accounting Data Service business development manager and publish them on the network so that customers can browse and find your Application on the Accounting Data Service Marketplace. When a customer adds an Application to their account, they obtain an AppEnrollment which represents that customer's instance of this Application. The customer-specific AppEnrollment contains a customer's configuration data for the Application, which is not customer-specific.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", "operationId": "v1_Applications_CreateApplication", "requestBody": { "description": "The Applications to create", @@ -1331,7 +1333,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -1358,15 +1360,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -1377,7 +1380,7 @@ "Applications" ], "summary": "Query Applications", - "description": "Queries Applications on the ADS Platform 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 ADS Platform Developer website.\r\n\r\nAn Application represents a feature available to customers within the ADS Platform. You can create Applications by working with your ADS Platform business development manager and publish them on the platform so that customers can browse and find your Application on the ADS Platform Marketplace. When a customer adds an Application to their account, they obtain an AppEnrollment which represents that customer's instance of this Application. The customer-specific AppEnrollment contains a customer's configuration data for the Application, which is not customer-specific.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", + "description": "Queries Applications on the Accounting Data Service 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 Accounting Data Service Developer website.\r\n\r\nAn Application represents a feature available to customers within the Accounting Data Service. You can create Applications by working with your Accounting Data Service business development manager and publish them on the network so that customers can browse and find your Application on the Accounting Data Service Marketplace. When a customer adds an Application to their account, they obtain an AppEnrollment which represents that customer's instance of this Application. The customer-specific AppEnrollment contains a customer's configuration data for the Application, which is not customer-specific.\r\n\r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) 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.", "operationId": "v1_Applications_QueryApplications", "parameters": [ { @@ -1425,7 +1428,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -1448,13 +1451,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -1465,7 +1468,7 @@ "AttachmentLinks" ], "summary": "Retrieve Attachment Link", - "description": "Retrieves the Attachment Link with the provided Attachment Link identifier.\r\n\r\nAn Attachment Link is a link that associates one Attachment with one object within ADS Platform.\r\n\r\nThis route has been deprecated, use /Attachments\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Retrieves the Attachment Link with the provided Attachment Link identifier.\r\n\r\nAn Attachment Link is a link that associates one Attachment with one object within Accounting Data Service.\r\n\r\nThis route has been deprecated, use /Attachments\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_AttachmentLinks_RetrieveAttachmentLink", "parameters": [ { @@ -1500,7 +1503,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -1539,13 +1542,13 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -1554,7 +1557,7 @@ "AttachmentLinks" ], "summary": "Upload Attachment", - "description": "Creates one Attachment Link from the provided arguments.\r\n\r\nAn Attachment Link is a link that associates one Attachment with one object within ADS Platform.\r\n\r\nThis route has been deprecated, use /Attachments\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.", + "description": "Creates one Attachment Link from the provided arguments.\r\n\r\nAn Attachment Link is a link that associates one Attachment with one object within Accounting Data Service.\r\n\r\nThis route has been deprecated, use /Attachments\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.", "operationId": "v1_AttachmentLinks_CreateAttachmentLink", "requestBody": { "content": { @@ -1587,7 +1590,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -1632,13 +1635,13 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -1647,7 +1650,7 @@ "AttachmentLinks" ], "summary": "Delete Attachment Link", - "description": "Delete the specified link between an object and its attachment.\r\n\r\nAn Attachment Link is a link that associates one Attachment with one object within ADS Platform.\r\n\r\nThis route has been deprecated, use /Attachments\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.", + "description": "Delete the specified link between an object and its attachment.\r\n\r\nAn Attachment Link is a link that associates one Attachment with one object within Accounting Data Service.\r\n\r\nThis route has been deprecated, use /Attachments\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.", "operationId": "v1_AttachmentLinks_DeleteAttachmentLink", "parameters": [ { @@ -1679,7 +1682,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -1718,13 +1721,13 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -1735,7 +1738,7 @@ "AttachmentLinks" ], "summary": "Query Attachment Links", - "description": "Queries Attachment Links 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 ADS Platform Developer website.\r\n\r\nAn Attachment Link is a link that associates one Attachment with one object within ADS Platform.\r\n\r\nThis route has been deprecated, use /Attachments\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Queries Attachment Links 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 Accounting Data Service Developer website.\r\n\r\nAn Attachment Link is a link that associates one Attachment with one object within Accounting Data Service.\r\n\r\nThis route has been deprecated, use /Attachments\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_AttachmentLinks_QueryAttachments", "parameters": [ { @@ -1783,7 +1786,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -1807,13 +1810,13 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -1824,7 +1827,7 @@ "Attachments" ], "summary": "Retrieve Attachment", - "description": "Retrieves the Attachment with the provided Attachment identifier.\r\n\r\nAn Attachment is a file that can be attached to various account attributes within ADS Platform. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Retrieves the Attachment with the provided Attachment identifier.\r\n\r\nAn Attachment is a file that can be attached to various account attributes within Accounting Data Service. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_Attachments_RetrieveAttachment", "parameters": [ { @@ -1849,7 +1852,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -1887,13 +1890,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -1902,13 +1905,13 @@ "Attachments" ], "summary": "Update Attachment", - "description": "Updates an existing Attachment with the information supplied to this PATCH call.\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\nAn Attachment is a file that can be attached to various account attributes within ADS Platform. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.\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.", + "description": "Updates an existing Attachment with the information supplied to this PATCH call.\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\nAn Attachment is a file that can be attached to various account attributes within Accounting Data Service. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.\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.", "operationId": "v1_Attachments_UpdateAttachment", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the attachment to update", + "description": "The unique Accounting Data Service ID number of the attachment to update", "required": true, "schema": { "type": "string", @@ -1922,19 +1925,19 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -1971,7 +1974,7 @@ } }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -1994,13 +1997,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -2009,7 +2012,7 @@ "Attachments" ], "summary": "Archive Attachment", - "description": "Flag this attachment as archived, which can distinguish between attachments currently active and attachments not intended for active use. This is similar to deletion but preserves information about the record's existence.\r\n\r\nAn Attachment is a file that can be attached to various account attributes within ADS Platform. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.\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.", + "description": "Flag this attachment as archived, which can distinguish between attachments currently active and attachments not intended for active use. This is similar to deletion but preserves information about the record's existence.\r\n\r\nAn Attachment is a file that can be attached to various account attributes within Accounting Data Service. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.\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.", "operationId": "v1_Attachments_ArchiveAttachment", "parameters": [ { @@ -2025,7 +2028,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -2063,13 +2066,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -2080,7 +2083,7 @@ "Attachments" ], "summary": "Download Attachment URL", - "description": "Returns a URI for the Attachment file to be downloaded, based on the ID provided.\r\n\r\nAn Attachment is a file that can be attached to various account attributes within ADS Platform. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Returns a URI for the Attachment file to be downloaded, based on the ID provided.\r\n\r\nAn Attachment is a file that can be attached to various account attributes within Accounting Data Service. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_Attachments_DownloadAttachmentUrl", "parameters": [ { @@ -2096,7 +2099,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -2134,13 +2137,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -2151,7 +2154,7 @@ "Attachments" ], "summary": "Download Attachment File", - "description": "Returns the Attachment file to be downloaded, based on the ID provided.\r\n\r\nAn Attachment is a file that can be attached to various account attributes within ADS Platform. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "This API is deprecated. Use the download-url API.\r\n\r\nReturns the Attachment file to be downloaded, based on the ID provided.\r\n\r\nAn Attachment is a file that can be attached to various account attributes within Accounting Data Service. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_Attachments_DownloadAttachmentFile", "parameters": [ { @@ -2167,7 +2170,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -2205,15 +2208,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -2224,7 +2228,7 @@ "Attachments" ], "summary": "Upload Attachment", - "description": "Uploads and creates one or more Attachments from the provided arguments.\r\n\r\nAn Attachment is a file that can be attached to various account attributes within ADS Platform. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.\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.", + "description": "Uploads and creates one or more Attachments from the provided arguments.\r\n\r\nAn Attachment is a file that can be attached to various account attributes within Accounting Data Service. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.\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.", "operationId": "v1_Attachments_CreateAttachment", "parameters": [ { @@ -2268,7 +2272,8 @@ "items": { "type": "string", "format": "binary" - } + }, + "description": "The file or files to be attached to the specified item" } } }, @@ -2282,7 +2287,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -2341,13 +2346,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -2358,7 +2363,7 @@ "Attachments" ], "summary": "Query Attachments", - "description": "Queries Attachments 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 ADS Platform Developer website.\r\n\r\nAn Attachment is a file that can be attached to various account attributes within ADS Platform. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Queries Attachments 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 Accounting Data Service Developer website.\r\n\r\nAn Attachment is a file that can be attached to various account attributes within Accounting Data Service. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_Attachments_QueryAttachments", "parameters": [ { @@ -2406,7 +2411,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -2429,13 +2434,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -2452,7 +2457,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this CodeDefinition", + "description": "The unique Accounting Data Service ID number of this CodeDefinition", "required": true, "schema": { "type": "string", @@ -2471,7 +2476,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -2524,13 +2529,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -2541,7 +2546,7 @@ "CodeDefinitions" ], "summary": "Query CodeDefinitions", - "description": "Queries CodeDefinitions 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 ADS Platform Developer website.\r\n\r\nA CodeDefinition contains information around system code values and their definitions.\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.", + "description": "Queries CodeDefinitions 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 Accounting Data Service Developer website.\r\n\r\nA CodeDefinition contains information around system code values and their definitions.\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.", "operationId": "v1_CodeDefinitions_QueryCodeDefinitions", "parameters": [ { @@ -2589,7 +2594,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -2612,13 +2617,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -2635,7 +2640,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this Company; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this Company; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -2669,7 +2674,7 @@ } }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -2692,13 +2697,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -2713,7 +2718,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this Company; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this Company; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -2727,19 +2732,19 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -2761,7 +2766,7 @@ } }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -2812,13 +2817,13 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -2833,7 +2838,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this Company; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this Company; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -2843,7 +2848,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -2897,13 +2902,13 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -2962,7 +2967,7 @@ } }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -2992,13 +2997,13 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -3010,7 +3015,7 @@ "description": "Delete the Companies referred to by these unique identifiers.\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\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.", "operationId": "v1_Companies_DeleteCompanies", "requestBody": { - "description": "The unique ADS Platform ID numbers of the Companies to delete; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID numbers of the Companies to delete; NOT the customer's ERP key", "content": { "application/json": { "schema": { @@ -3046,7 +3051,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -3100,13 +3105,13 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -3117,7 +3122,7 @@ "Companies" ], "summary": "Query Companies", - "description": "Queries Companies 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 ADS Platform Developer website.\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\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Queries Companies 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 Accounting Data Service Developer website.\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\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_Companies_QueryCompanies", "parameters": [ { @@ -3165,7 +3170,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -3203,13 +3208,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -3220,7 +3225,7 @@ "Companies" ], "summary": "Query Customer Summary", - "description": "Queries Customer Summaries 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 ADS Platform Developer website.\r\n\r\nThe Customer Summary View represents a slightly different view of the data and includes some extra fields that might be useful. For more information, see the data format of the Customer Summary Model.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Queries Customer Summaries 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 Accounting Data Service Developer website.\r\n\r\nThe Customer Summary View represents a slightly different view of the data and includes some extra fields that might be useful. For more information, see the data format of the Customer Summary Model.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_Companies_QueryCustomerSummaries", "parameters": [ { @@ -3277,7 +3282,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -3313,15 +3318,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -3332,7 +3338,7 @@ "Companies" ], "summary": "Query Vendor Summary", - "description": "Queries Vendor Summaries 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 ADS Platform Developer website.\r\n\r\nThe Vendor Summary View represents a slightly different view of the data and includes some extra fields that might be useful. For more information, see the data format of the Vendor Summary Model.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Queries Vendor Summaries 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 Accounting Data Service Developer website.\r\n\r\nThe Vendor Summary View represents a slightly different view of the data and includes some extra fields that might be useful. For more information, see the data format of the Vendor Summary Model.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_Companies_QueryVendorSummaries", "parameters": [ { @@ -3389,7 +3395,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -3425,15 +3431,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -3501,7 +3508,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -3539,13 +3546,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -3562,7 +3569,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this Company; NOT the company's ERP key", + "description": "The unique Accounting Data Service ID number of this Company; NOT the company's ERP key", "required": true, "schema": { "type": "string", @@ -3572,7 +3579,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -3608,15 +3615,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -3627,13 +3635,13 @@ "Companies" ], "summary": "Set Company Logo", - "description": "Sets the logo for specified company. The logo will be stored in the ADS 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. JFIF and EXIF are not supported. If you upload a JPEG and get an error, verify the file is not one of these formats.\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. \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.", + "description": "Sets the logo for specified company. The logo will be stored in the Accounting Data Service 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. JFIF and EXIF are not supported. If you upload a JPEG and get an error, verify the file is not one of these formats.\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. \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.", "operationId": "v1_Companies_SetCompanyLogo", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this Company; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this Company; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -3685,6 +3693,7 @@ "properties": { "file": { "type": "string", + "description": "", "format": "binary" } } @@ -3699,7 +3708,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -3723,13 +3732,13 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -3746,7 +3755,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this Company; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this Company; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -3791,7 +3800,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -3815,13 +3824,13 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -3838,7 +3847,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this Contact; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this Contact; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -3857,7 +3866,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -3895,13 +3904,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -3916,7 +3925,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the Contact to update; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of the Contact to update; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -3930,19 +3939,19 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -3979,7 +3988,7 @@ } }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -4003,13 +4012,13 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -4024,7 +4033,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the Contact to delete; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of the Contact to delete; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -4034,7 +4043,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -4088,13 +4097,13 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -4138,7 +4147,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -4164,13 +4173,13 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -4185,13 +4194,13 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -4203,7 +4212,7 @@ "description": "Delete the Contacts referred to by these unique identifiers.\r\n\r\nA Contact contains information about a person or role within a Company. You can use Contacts to track information about who is responsible for a specific project, who handles invoices, or information about which role at a particular customer or vendor you should speak with about invoices.\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.", "operationId": "v1_Contacts_DeleteContacts", "requestBody": { - "description": "The unique ADS Platform ID numbers of the Contacts to delete; NOT the customer's ERP keys", + "description": "The unique Accounting Data Service ID numbers of the Contacts to delete; NOT the customer's ERP keys", "content": { "application/json": { "schema": { @@ -4239,7 +4248,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -4293,13 +4302,13 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -4310,7 +4319,7 @@ "Contacts" ], "summary": "Query Contacts", - "description": "Queries Contacts 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 ADS Platform Developer website.\r\n\r\nA Contact contains information about a person or role within a Company. You can use Contacts to track information about who is responsible for a specific project, who handles invoices, or information about which role at a particular customer or vendor you should speak with about invoices.\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.", + "description": "Queries Contacts 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 Accounting Data Service Developer website.\r\n\r\nA Contact contains information about a person or role within a Company. You can use Contacts to track information about who is responsible for a specific project, who handles invoices, or information about which role at a particular customer or vendor you should speak with about invoices.\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.", "operationId": "v1_Contacts_QueryContacts", "parameters": [ { @@ -4358,7 +4367,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -4381,13 +4390,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -4398,13 +4407,13 @@ "CreditMemosApplied" ], "summary": "Retrieve Credit Memo Applied", - "description": "Retrieves the Credit Memo Applied specified by this unique identifier, optionally including nested data sets.\r\n\r\nCredit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, ADS Platform creates a Credit Memo Applied record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Applied records to track which Invoices were paid using this Credit.\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.", + "description": "Retrieves the Credit Memo Applied specified by this unique identifier, optionally including nested data sets.\r\n\r\nCredit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Accounting Data Service creates a Credit Memo Applied record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Applied records to track which Invoices were paid using this Credit.\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.", "operationId": "v1_CreditMemosApplied_RetrieveCreditMemosApplied", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this Credit Memo Applied; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this Credit Memo Applied; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -4423,7 +4432,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -4461,13 +4470,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -4476,13 +4485,13 @@ "CreditMemosApplied" ], "summary": "Update Credit Memos Applied", - "description": "Updates an existing Credit Memo Applied with the information supplied to this PATCH call.\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\nCredit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, ADS Platform creates a Credit Memo Applied record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Applied records to track which Invoices were paid using this Credit.\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.", + "description": "Updates an existing Credit Memo Applied with the information supplied to this PATCH call.\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\nCredit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Accounting Data Service creates a Credit Memo Applied record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Applied records to track which Invoices were paid using this Credit.\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.", "operationId": "v1_CreditMemosApplied_UpdateCreditMemosApplied", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the Credit Memo Applied to update; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of the Credit Memo Applied to update; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -4496,26 +4505,26 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -4568,13 +4577,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -4583,13 +4592,13 @@ "CreditMemosApplied" ], "summary": "Delete Credit Memo Applied", - "description": "Deletes the Credit Memo Applied referred to by this unique identifier.\r\n\r\nCredit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, ADS Platform creates a Credit Memo Applied record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Applied records to track which Invoices were paid using this Credit.\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.", + "description": "Deletes the Credit Memo Applied referred to by this unique identifier.\r\n\r\nCredit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Accounting Data Service creates a Credit Memo Applied record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Applied records to track which Invoices were paid using this Credit.\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.", "operationId": "v1_CreditMemosApplied_DeleteCreditMemosApplied", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the Credit Memo Applied to delete; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of the Credit Memo Applied to delete; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -4599,7 +4608,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -4637,13 +4646,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -4654,7 +4663,7 @@ "CreditMemosApplied" ], "summary": "Create Credit Memos Applied", - "description": "Creates one or more Credit Memos Applied within this account and returns the records as created.\r\n\r\nCredit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, ADS Platform creates a Credit Memo Applied record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Applied records to track which Invoices were paid using this Credit.\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.", + "description": "Creates one or more Credit Memos Applied within this account and returns the records as created.\r\n\r\nCredit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Accounting Data Service creates a Credit Memo Applied record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Applied records to track which Invoices were paid using this Credit.\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.", "operationId": "v1_CreditMemosApplied_CreateCreditMemosApplied", "requestBody": { "description": "The Credit Memos Applied to create", @@ -4687,7 +4696,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -4731,13 +4740,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -4748,7 +4757,7 @@ "CreditMemosApplied" ], "summary": "Query Credit Memos Applied", - "description": "Queries Credit Memos Applied 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 ADS Platform Developer website.\r\n\r\nCredit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, ADS Platform creates a Credit Memo Applied record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Applied records to track which Invoices were paid using this Credit.\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.", + "description": "Queries Credit Memos Applied 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 Accounting Data Service Developer website.\r\n\r\nCredit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Accounting Data Service creates a Credit Memo Applied record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Applied records to track which Invoices were paid using this Credit.\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.", "operationId": "v1_CreditMemosApplied_QueryCreditMemosApplied", "parameters": [ { @@ -4796,7 +4805,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -4819,251 +4828,13 @@ }, "security": [ { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/Currencies/{sourceCurrency}/{destinationCurrency}": { - "get": { - "tags": [ - "Currencies" - ], - "summary": "Retrieve currency rate", - "description": "Retrieve a currency conversation rate from one currency to another as of the specified date. Optionally, you can specify which currency data provider to use.\r\n\r\n The currency rate model contains all of the information used to make the API call, plus the rate to use for the conversion.\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.", - "operationId": "v1_Currencies_RetrieveCurrencyRate", - "parameters": [ - { - "name": "sourceCurrency", - "in": "path", - "description": "The ISO 4217 currency code of the origin currency.\r\nFor a list of currency codes, call List Currencies.", - "required": true, - "schema": { - "type": "string", - "description": " This will be validated by the /api/v1/definitions/currencies data set" - } - }, - { - "name": "destinationCurrency", - "in": "path", - "description": "The ISO 4217 currency code of the target currency.\r\nFor a list of currency codes, call List Currencies.", - "required": true, - "schema": { - "type": "string", - "description": " This will be validated by the /api/v1/definitions/currencies data set" - } - }, - { - "name": "date", - "in": "query", - "description": "The date for which we should cto use for this currency conversion.", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataProvider", - "in": "query", - "description": "Optionally, you can specify a data provider.", - "schema": { - "type": "string", - "default": "default" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CurrencyRateModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/CurrencyRateModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/Currencies/bulk": { - "post": { - "tags": [ - "Currencies" - ], - "summary": "Bulk currency data", - "description": "Receives an array of dates and currencies and a destination currency and returns an array of the corresponding currency rates to the given destination currency (Limit X).\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.", - "operationId": "v1_Currencies_CreateBulkCurrencyConversion", - "parameters": [ - { - "name": "destinationCurrency", - "in": "query", - "description": "The currency to convert to.", - "schema": { - "type": "string", - "description": " This will be validated by the /api/v1/definitions/currencies data set" - } - } - ], - "requestBody": { - "description": "A list of dates and source currencies.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BulkCurrencyConversionModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BulkCurrencyConversionModel" - } - } - }, - "application/*+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BulkCurrencyConversionModel" - } - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CurrencyRateModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CurrencyRateModel" - } - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -5074,13 +4845,13 @@ "CustomFieldDefinitions" ], "summary": "Retrieve Field Definition", - "description": "Retrieves the Custom Field Definition specified by this unique identifier.\r\n\r\nA Custom Field represents metadata added to an object within the ADS Platform. ADS Platform provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Retrieves the Custom Field Definition specified by this unique identifier.\r\n\r\nA Custom Field represents metadata added to an object within the Accounting Data Service. Accounting Data Service provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_CustomFieldDefinitions_RetrieveDefinition", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this Custom Field Definition", + "description": "The unique Accounting Data Service ID number of this Custom Field Definition", "required": true, "schema": { "type": "string", @@ -5099,7 +4870,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -5137,13 +4908,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -5152,13 +4923,13 @@ "CustomFieldDefinitions" ], "summary": "Update Field Definition", - "description": "Updates an existing Custom Field Definition with the information supplied to this PATCH call.\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 Custom Field represents metadata added to an object within the ADS Platform. ADS Platform provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Updates an existing Custom Field Definition with the information supplied to this PATCH call.\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 Custom Field represents metadata added to an object within the Accounting Data Service. Accounting Data Service provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_CustomFieldDefinitions_UpdateDefinition", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the Custom Field Definition to update", + "description": "The unique Accounting Data Service ID number of the Custom Field Definition to update", "required": true, "schema": { "type": "string", @@ -5172,19 +4943,19 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -5206,7 +4977,7 @@ } }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -5229,13 +5000,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -5244,13 +5015,13 @@ "CustomFieldDefinitions" ], "summary": "Delete Field Definition", - "description": "Deletes the Custom Field Definition referred to by this unique identifier.\r\n\r\nA Custom Field represents metadata added to an object within the ADS Platform. ADS Platform provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Deletes the Custom Field Definition referred to by this unique identifier.\r\n\r\nA Custom Field represents metadata added to an object within the Accounting Data Service. Accounting Data Service provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_CustomFieldDefinitions_DeleteDefinition", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the Custom Field Definition to delete", + "description": "The unique Accounting Data Service ID number of the Custom Field Definition to delete", "required": true, "schema": { "type": "string", @@ -5260,7 +5031,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -5298,13 +5069,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -5315,7 +5086,7 @@ "CustomFieldDefinitions" ], "summary": "Create Field Definitions", - "description": "Creates one or more Custom Field Definitions and returns the records as created.\r\n\r\nA Custom Field represents metadata added to an object within the ADS Platform. ADS Platform provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Creates one or more Custom Field Definitions and returns the records as created.\r\n\r\nA Custom Field represents metadata added to an object within the Accounting Data Service. Accounting Data Service provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_CustomFieldDefinitions_CreateDefinitions", "requestBody": { "description": "The Custom Field Definitions to create", @@ -5348,7 +5119,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -5392,13 +5163,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -5409,7 +5180,7 @@ "CustomFieldDefinitions" ], "summary": "Query Field Definitions", - "description": "Queries Custom Field Definitions within the ADS Platform 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 ADS Platform Developer website.\r\n\r\nA Custom Field represents metadata added to an object within the ADS Platform. ADS Platform provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Queries Custom Field Definitions within the Accounting Data Service 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 Accounting Data Service Developer website.\r\n\r\nA Custom Field represents metadata added to an object within the Accounting Data Service. Accounting Data Service provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_CustomFieldDefinitions_QueryDefinitions", "parameters": [ { @@ -5457,7 +5228,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -5480,13 +5251,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -5497,13 +5268,13 @@ "CustomFieldValues" ], "summary": "Retrieve Field", - "description": "Retrieves all Custom Field Definitions.\r\n\r\nA Custom Field represents metadata added to an object within the ADS Platform. ADS Platform provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", - "operationId": "v1_CustomFieldValues_RetrieveValue", + "description": "Retrieves the Custom Field referred to by this unique identifier.\r\n\r\nA Custom Field represents metadata added to an object within the Accounting Data Service. Accounting Data Service provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "operationId": "RetrieveValueByDefinitionId", "parameters": [ { "name": "definitionId", "in": "path", - "description": "The unique ADS Platform ID number of the Custom Field Definition for the Custom Field Value to retrieve.", + "description": "The unique Accounting Data Service ID number of the Custom Field Definition for the Custom Field Value to retrieve.", "required": true, "schema": { "type": "string", @@ -5513,7 +5284,7 @@ { "name": "recordKey", "in": "path", - "description": "The unique ADS Platform ID number of the ADS Platform object the Custom Field Value is attached to.", + "description": "The unique Accounting Data Service ID number of the Accounting Data Service object the Custom Field Value is attached to.", "required": true, "schema": { "type": "string", @@ -5532,7 +5303,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -5570,13 +5341,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -5585,13 +5356,13 @@ "CustomFieldValues" ], "summary": "Update Field", - "description": "Updates an existing Custom Field with the information supplied to this PATCH call.\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 Custom Field represents metadata added to an object within the ADS Platform. ADS Platform provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", - "operationId": "v1_CustomFieldValues_UpdateValue", + "description": "Updates an existing Custom Field with the information supplied to this PATCH call.\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 Custom Field represents metadata added to an object within the Accounting Data Service. Accounting Data Service provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "operationId": "UpdateValueByDefinitionId", "parameters": [ { "name": "definitionId", "in": "path", - "description": "The unique ADS Platform ID number of the Custom Field Definition for the Custom Field Value to retrieve.", + "description": "The unique Accounting Data Service ID number of the Custom Field Definition for the Custom Field Value to retrieve.", "required": true, "schema": { "type": "string", @@ -5601,7 +5372,7 @@ { "name": "recordKey", "in": "path", - "description": "The unique ADS Platform ID number of the ADS Platform object the Custom Field Value is attached to.", + "description": "The unique Accounting Data Service ID number of the Accounting Data Service object the Custom Field Value is attached to.", "required": true, "schema": { "type": "string", @@ -5615,19 +5386,19 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -5649,7 +5420,7 @@ } }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -5672,13 +5443,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -5687,13 +5458,13 @@ "CustomFieldValues" ], "summary": "Delete Field", - "description": "Deletes the Custom Field referred to by this unique identifier.\r\n\r\nA Custom Field represents metadata added to an object within the ADS Platform. ADS Platform provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", - "operationId": "v1_CustomFieldValues_DeleteValue", + "description": "Deletes the Custom Field referred to by this unique identifier.\r\n\r\nA Custom Field represents metadata added to an object within the Accounting Data Service. Accounting Data Service provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "operationId": "DeleteValueByDefinitionId", "parameters": [ { "name": "definitionId", "in": "path", - "description": "The unique ADS Platform ID number of the Custom Field Definition for the Custom Field Value to retrieve.", + "description": "The unique Accounting Data Service ID number of the Custom Field Definition for the Custom Field Value to retrieve.", "required": true, "schema": { "type": "string", @@ -5703,7 +5474,7 @@ { "name": "recordKey", "in": "path", - "description": "The unique ADS Platform ID number of the ADS Platform object the Custom Field Value is attached to.", + "description": "The unique Accounting Data Service ID number of the Accounting Data Service object the Custom Field Value is attached to.", "required": true, "schema": { "type": "string", @@ -5713,7 +5484,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -5751,45 +5522,313 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/CustomFieldValues": { - "post": { + "/api/v1/CustomFieldValues/{label}/{recordKey}": { + "get": { "tags": [ "CustomFieldValues" ], - "summary": "Create Fields", - "description": "Creates one or more Custom Fields and returns the records as created.\r\n\r\nA Custom Field represents metadata added to an object within the ADS Platform. ADS Platform provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", - "operationId": "v1_CustomFieldValues_CreateValues", - "requestBody": { - "description": "The Custom Fields to create", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { + "summary": "Retrieve Field", + "description": "Retrieves the Custom Field referred to by this unique identifier.\r\n\r\nA Custom Field represents metadata added to an object within the Accounting Data Service. Accounting Data Service provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "operationId": "RetrieveValueByLabel", + "parameters": [ + { + "name": "label", + "in": "path", + "description": "The label of the Custom Field Value to retrieve.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "recordKey", + "in": "path", + "description": "The unique Accounting Data Service ID number of the Accounting Data Service object the Custom Field Value is attached to.", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "include", + "in": "query", + "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: CustomFieldDefinition", + "schema": { + "type": "string", + "default": "" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/CustomFieldValueModel" } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { + }, + "text/json": { + "schema": { "$ref": "#/components/schemas/CustomFieldValueModel" } } - }, - "application/*+json": { + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + }, + "security": [ + { + "oauth2": [ ] + }, + { + "bearer_token": [ ] + }, + { + "api_key": [ ] + } + ] + }, + "patch": { + "tags": [ + "CustomFieldValues" + ], + "summary": "Update Field", + "description": "Updates an existing Custom Field with the information supplied to this PATCH call.\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 Custom Field represents metadata added to an object within the Accounting Data Service. Accounting Data Service provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "operationId": "UpdateValueByLabel", + "parameters": [ + { + "name": "label", + "in": "path", + "description": "The label of the Custom Field Value to update.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "recordKey", + "in": "path", + "description": "The unique Accounting Data Service ID number of the Accounting Data Service object the Custom Field Value is attached to.", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "description": "A list of changes to apply to this Custom Field", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { } + } + }, + "text/json": { + "schema": { + "type": "object", + "additionalProperties": { } + } + }, + "application/*+json": { + "schema": { + "type": "object", + "additionalProperties": { } + } + } + } + }, + "responses": { + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomFieldValueModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/CustomFieldValueModel" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + }, + "security": [ + { + "oauth2": [ ] + }, + { + "bearer_token": [ ] + }, + { + "api_key": [ ] + } + ] + }, + "delete": { + "tags": [ + "CustomFieldValues" + ], + "summary": "Delete Field", + "description": "Deletes the Custom Field referred to by this unique identifier.\r\n\r\nA Custom Field represents metadata added to an object within the Accounting Data Service. Accounting Data Service provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "operationId": "DeleteValueByLabel", + "parameters": [ + { + "name": "label", + "in": "path", + "description": "The label of the Custom Field Value to retrieve.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "recordKey", + "in": "path", + "description": "The unique Accounting Data Service ID number of the Accounting Data Service object the Custom Field Value is attached to.", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActionResultModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ActionResultModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + }, + "security": [ + { + "oauth2": [ ] + }, + { + "bearer_token": [ ] + }, + { + "api_key": [ ] + } + ] + } + }, + "/api/v1/CustomFieldValues": { + "post": { + "tags": [ + "CustomFieldValues" + ], + "summary": "Create Fields", + "description": "Creates one or more Custom Fields and returns the records as created.\r\n\r\nA Custom Field represents metadata added to an object within the Accounting Data Service. Accounting Data Service provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "operationId": "v1_CustomFieldValues_CreateValues", + "requestBody": { + "description": "The Custom Fields to create", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldValueModel" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldValueModel" + } + } + }, + "application/*+json": { "schema": { "type": "array", "items": { @@ -5801,7 +5840,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -5845,13 +5884,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -5862,7 +5901,7 @@ "CustomFieldValues" ], "summary": "Query Fields", - "description": "Queries Custom Fields within the ADS Platform 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 ADS Platform Developer website.\r\n\r\nA Custom Field represents metadata added to an object within the ADS Platform. ADS Platform provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Queries Custom Fields within the Accounting Data Service 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 Accounting Data Service Developer website.\r\n\r\nA Custom Field represents metadata added to an object within the Accounting Data Service. Accounting Data Service provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_CustomFieldValues_QueryValues", "parameters": [ { @@ -5910,7 +5949,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -5933,13 +5972,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -5950,7 +5989,7 @@ "Definitions" ], "summary": "Query Countries", - "description": "Queries the ISO3166 List of Countries 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 ADS Platform Developer website.\r\n\r\nYour program may want to show a list of countries. The ISO maintains a list of countries called [ISO3166](https://www.iso.org/iso-3166-country-codes.html). For convenience, this list is available in the API.", + "description": "Queries the ISO3166 List of Countries 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 Accounting Data Service Developer website.\r\n\r\nYour program may want to show a list of countries. The ISO maintains a list of countries called [ISO3166](https://www.iso.org/iso-3166-country-codes.html). For convenience, this list is available in the API.", "operationId": "v1_Definitions_QueryCountries", "parameters": [ { @@ -5998,7 +6037,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -6021,7 +6060,7 @@ "Definitions" ], "summary": "Query Currencies", - "description": "Queries Currencies on the ADS Platform 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 ADS Platform Developer website.\r\n\r\nYour app may wish to make use of a reference list that contains names and attributes for all ISO-4217 defined currency codes. This information is provided via a query endpoint so that you can use this API to provide a user selection screen.", + "description": "Queries Currencies on the Accounting Data Service 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 Accounting Data Service Developer website.\r\n\r\nYour app may wish to make use of a reference list that contains names and attributes for all ISO-4217 defined currency codes. This information is provided via a query endpoint so that you can use this API to provide a user selection screen.", "operationId": "v1_Definitions_QueryCurrencies", "parameters": [ { @@ -6069,7 +6108,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -6092,7 +6131,7 @@ "Definitions" ], "summary": "Query States", - "description": "Queries the list of States in the United States 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 ADS Platform Developer website.\r\n\r\nYour app may wish to make use of a reference list that contains names and codes for all states in the United States. This information is provided for the United States since many financial systems require mailing addresses that use codes for states.", + "description": "Queries the list of States in the United States 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 Accounting Data Service Developer website.\r\n\r\nYour app may wish to make use of a reference list that contains names and codes for all states in the United States. This information is provided for the United States since many financial systems require mailing addresses that use codes for states.", "operationId": "v1_Definitions_QueryStates", "parameters": [ { @@ -6140,7 +6179,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -6157,97 +6196,10 @@ } } }, - "/api/v1/Definitions/financialsystems": { - "get": { + "/api/v1/feature-flags": { + "post": { "tags": [ - "Definitions" - ], - "summary": "Query Financial Systems", - "description": "Queries a list of financial systems 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 ADS Platform Developer website.\r\n\r\nADS Platform provides a list of financial systems that may be useful as a selection screen that allows customers to select from a list. You can query these items by name or attributes and use this data source to help users complete a selection.\r\n\r\nThis endpoint is deprecated and will be removed in a future release.", - "operationId": "v1_Definitions_QueryFinancialSystems", - "parameters": [ - { - "name": "filter", - "in": "query", - "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "include", - "in": "query", - "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.", - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "in": "query", - "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageNumber", - "in": "query", - "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErpModelFetchResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ErpModelFetchResult" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - }, - "deprecated": true - } - }, - "/api/v1/feature-flags": { - "post": { - "tags": [ - "FeatureFlags" + "FeatureFlags" ], "summary": "Retrieve Feature Flags", "description": "Retrieves the specified feature flags. True if they are enabled, false otherwise.\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.", @@ -6289,7 +6241,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -6325,15 +6277,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -6415,13 +6368,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -6438,7 +6391,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this Account; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this Account; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -6448,7 +6401,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -6486,13 +6439,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -6507,7 +6460,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the Account to update; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of the Account to update; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -6521,19 +6474,19 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -6570,7 +6523,7 @@ } }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -6593,13 +6546,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -6614,7 +6567,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the Financial Account to disable; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of the Financial Account to disable; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -6624,7 +6577,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -6662,13 +6615,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -6727,7 +6680,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -6750,13 +6703,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -6773,7 +6726,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this Financial Account Balance History", + "description": "The unique Accounting Data Service ID number of this Financial Account Balance History", "required": true, "schema": { "type": "string", @@ -6783,7 +6736,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -6821,13 +6774,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -6842,7 +6795,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the Financial Account Balance History to update", + "description": "The unique Accounting Data Service ID number of the Financial Account Balance History to update", "required": true, "schema": { "type": "string", @@ -6856,19 +6809,19 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -6890,7 +6843,7 @@ } }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -6913,13 +6866,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -6934,7 +6887,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the Financial Account Balance History to disable", + "description": "The unique Accounting Data Service ID number of the Financial Account Balance History to disable", "required": true, "schema": { "type": "string", @@ -6944,7 +6897,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -6982,13 +6935,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -7032,7 +6985,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -7058,13 +7011,13 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -7078,13 +7031,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -7095,7 +7048,7 @@ "FinancialAccountBalanceHistory" ], "summary": "Query Balance History", - "description": "Queries Financial Account Balance History for this account using the specified filtering, sorting, 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 ADS Platform Developer website.\r\n\r\nA Financial Account Balance History records either the current or end of period balance for a corresponding financial account.\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.", + "description": "Queries Financial Account Balance History for this account using the specified filtering, sorting, 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 Accounting Data Service Developer website.\r\n\r\nA Financial Account Balance History records either the current or end of period balance for a corresponding financial account.\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.", "operationId": "v1_FinancialAccountBalanceHistory_QueryFinancialAccountBalanceHistory", "parameters": [ { @@ -7135,7 +7088,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -7158,13 +7111,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -7181,7 +7134,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this institution account; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this institution account; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -7191,7 +7144,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -7227,15 +7180,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -7294,7 +7248,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -7315,15 +7269,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -7340,7 +7295,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this Financial Year Setting", + "description": "The unique Accounting Data Service ID number of this Financial Year Setting", "required": true, "schema": { "type": "string", @@ -7350,7 +7305,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -7388,13 +7343,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -7409,7 +7364,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the Financial Year Setting to update", + "description": "The unique Accounting Data Service ID number of the Financial Year Setting to update", "required": true, "schema": { "type": "string", @@ -7423,19 +7378,19 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -7472,7 +7427,7 @@ } }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -7495,13 +7450,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -7516,7 +7471,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the Financial Year Setting to disable", + "description": "The unique Accounting Data Service ID number of the Financial Year Setting to disable", "required": true, "schema": { "type": "string", @@ -7526,7 +7481,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -7564,13 +7519,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -7620,7 +7575,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -7640,13 +7595,13 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -7660,13 +7615,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -7677,7 +7632,7 @@ "FinancialYearSettings" ], "summary": "Query Financial Year Settings", - "description": "Queries Financial Year Settings for this account using the specified filtering, sorting, 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 ADS Platform Developer website.\r\n\r\nA Financial Year Setting is used to to set the type, beginning, end, and number of periods of a year used to calculate accounting reports. The financial setting can either be for a specific app enrollment id via a sync or, when the financial year setting is manually created, will cover all account data without an app enrollment 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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Queries Financial Year Settings for this account using the specified filtering, sorting, 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 Accounting Data Service Developer website.\r\n\r\nA Financial Year Setting is used to to set the type, beginning, end, and number of periods of a year used to calculate accounting reports. The financial setting can either be for a specific app enrollment id via a sync or, when the financial year setting is manually created, will cover all account data without an app enrollment 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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_FinancialYearSettings_QueryFinancialYearSettings", "parameters": [ { @@ -7717,7 +7672,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -7740,13 +7695,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -7761,7 +7716,7 @@ "operationId": "v1_GroupAccounts_RetrieveGroup", "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -7785,13 +7740,13 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -7822,19 +7777,19 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -7846,19 +7801,19 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -7894,13 +7849,13 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -7936,7 +7891,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -7974,13 +7929,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -8005,7 +7960,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -8043,13 +7998,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -8078,26 +8033,26 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -8150,13 +8105,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -8226,13 +8181,13 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -8246,13 +8201,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -8263,7 +8218,7 @@ "InvoiceAddresses" ], "summary": "Query Invoice Addresses", - "description": "Queries Invoice Addresses 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 ADS Platform 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.", + "description": "Queries Invoice Addresses 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 Accounting Data Service 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.", "operationId": "v1_InvoiceAddresses_QueryInvoiceAddresses", "parameters": [ { @@ -8311,7 +8266,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -8334,13 +8289,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -8398,7 +8353,7 @@ } }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -8427,13 +8382,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -8445,7 +8400,7 @@ "description": "\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.", "operationId": "v1_InvoiceLines_DeleteInvoiceLines", "requestBody": { - "description": "The unique ADS Platform ID numbers of the Invoice Lines to delete; NOT the customer's ERP keys", + "description": "The unique Accounting Data Service ID numbers of the Invoice Lines to delete; NOT the customer's ERP keys", "content": { "application/json": { "schema": { @@ -8481,7 +8436,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -8534,13 +8489,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -8597,7 +8552,7 @@ } }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -8620,13 +8575,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -8655,26 +8610,26 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -8727,13 +8682,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -8758,7 +8713,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -8796,13 +8751,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -8813,7 +8768,7 @@ "InvoiceLines" ], "summary": "Query Invoice Lines", - "description": "Queries Invoice Lines for the account using specified filtering More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the ADS Platform 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.", + "description": "Queries Invoice Lines for the account using specified filtering More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Accounting Data Service 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.", "operationId": "v1_InvoiceLines_QueryInvoiceLines", "parameters": [ { @@ -8861,7 +8816,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -8884,13 +8839,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -8901,13 +8856,13 @@ "Invoices" ], "summary": "Retrieve Invoice", - "description": "Retrieves the Invoice specified by this unique identifier, optionally including nested data sets.\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 ADS 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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Retrieves the Invoice specified by this unique identifier, optionally including nested data sets.\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 Accounting Data Service 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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_Invoices_RetrieveInvoice", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this invoice; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this invoice; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -8925,7 +8880,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -8963,13 +8918,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -8978,13 +8933,13 @@ "Invoices" ], "summary": "Update Invoice", - "description": "Updates an existing Invoice with the information supplied to this PATCH call.\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\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 ADS 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.", + "description": "Updates an existing Invoice with the information supplied to this PATCH call.\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\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 Accounting Data Service 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.", "operationId": "v1_Invoices_UpdateInvoice", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the invoice to update; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of the invoice to update; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -8998,19 +8953,19 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -9047,7 +9002,7 @@ } }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -9070,13 +9025,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -9085,13 +9040,13 @@ "Invoices" ], "summary": "Delete Invoice", - "description": "Deletes the Invoice referred to by this unique identifier. An 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 ADS 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.", + "description": "Deletes the Invoice referred to by this unique identifier. An 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 Accounting Data Service 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.", "operationId": "v1_Invoices_DeleteInvoice", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the invoice to delete; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of the invoice to delete; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -9101,7 +9056,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -9139,13 +9094,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -9162,7 +9117,7 @@ { "name": "id", "in": "path", - "description": "The unique Accounting Data Service Platform ID number of the Invoice.", + "description": "The unique Accounting Data Service Id of the Invoice.", "required": true, "schema": { "type": "string", @@ -9172,7 +9127,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -9216,13 +9171,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -9233,7 +9188,7 @@ "Invoices" ], "summary": "Create Invoices", - "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 ADS 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.", + "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 Accounting Data Service 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.", "operationId": "v1_Invoices_CreateInvoices", "parameters": [ { @@ -9284,7 +9239,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -9313,13 +9268,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -9328,10 +9283,10 @@ "Invoices" ], "summary": "Delete Invoices", - "description": "Delete the Invoices referred to by these unique identifiers.\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 ADS 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.", + "description": "Delete the Invoices referred to by these unique identifiers.\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 Accounting Data Service 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.", "operationId": "v1_Invoices_DeleteInvoices", "requestBody": { - "description": "The unique ADS Platform ID numbers of the Invoices to delete; NOT the customer's ERP keys", + "description": "The unique Accounting Data Service ID numbers of the Invoices to delete; NOT the customer's ERP keys", "content": { "application/json": { "schema": { @@ -9367,7 +9322,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -9420,13 +9375,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -9437,7 +9392,7 @@ "Invoices" ], "summary": "Query Invoices", - "description": "Queries Invoices 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 ADS Platform Developer website.\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 ADS 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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "description": "Queries Invoices 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 Accounting Data Service Developer website.\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 Accounting Data Service 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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", "operationId": "v1_Invoices_QueryInvoices", "parameters": [ { @@ -9485,7 +9440,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -9508,13 +9463,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -9531,7 +9486,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this invoice; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this invoice; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -9541,7 +9496,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -9596,13 +9551,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -9617,7 +9572,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this invoice; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this invoice; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -9627,7 +9582,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -9667,13 +9622,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -9684,7 +9639,7 @@ "Invoices" ], "summary": "Query Invoice Summary View", - "description": "Queries Invoices for this account using the specified filtering, sorting, nested fetch, and pagination rules requested. Display the results using the Invoice Summary View format.\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 ADS Platform Developer website.\r\n\r\nThe Invoice Summary View represents a slightly different view of the data and includes some extra fields that might be useful. For more information, see the data format of the Invoice Summary Model.\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.", + "description": "Queries Invoices for this account using the specified filtering, sorting, nested fetch, and pagination rules requested. Display the results using the Invoice Summary View format.\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 Accounting Data Service Developer website.\r\n\r\nThe Invoice Summary View represents a slightly different view of the data and includes some extra fields that might be useful. For more information, see the data format of the Invoice Summary Model.\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.", "operationId": "v1_Invoices_QueryInvoiceSummaries", "parameters": [ { @@ -9732,7 +9687,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -9753,15 +9708,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -9778,7 +9734,7 @@ { "name": "id", "in": "path", - "description": "The unique Lockstep Platform ID number of this invoice; NOT the customer's ERP key", + "description": "The unique Lockstep Network Id number of this invoice; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -9841,7 +9797,7 @@ } }, "424": { - "description": "Client Error", + "description": "Failed Dependency", "content": { "application/json": { "schema": { @@ -9864,30 +9820,30 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/journal-entries/{id}": { + "/api/v1/useraccounts/magic-links/{id}": { "get": { "tags": [ - "JournalEntries" + "MagicLinks" ], - "summary": "Retrieve Journal Entry", - "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.", - "operationId": "v1_JournalEntries_RetrieveJournalEntry", + "summary": "Retrieve Magic Link", + "description": "Retrieves the Magic Link 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.", + "operationId": "v1_MagicLinks_RetrieveMagicLink", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this journal entry; NOT the customer's ERP key", + "description": "The id of the Magic Link", "required": true, "schema": { "type": "string", @@ -9897,7 +9853,7 @@ { "name": "include", "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Lines, Attachments", + "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: User, CustomFields, Notes", "schema": { "type": "string" } @@ -9905,16 +9861,16 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JournalEntryModel" + "$ref": "#/components/schemas/MagicLinkModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/JournalEntryModel" + "$ref": "#/components/schemas/MagicLinkModel" } } } @@ -9943,160 +9899,62 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - } - }, - "/api/v1/journal-entries": { - "post": { + }, + "delete": { "tags": [ - "JournalEntries" + "MagicLinks" ], - "summary": "Create Journal Entries", - "description": "Creates one or more Journal Entries within this account and returns the records as created.\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.", - "operationId": "v1_JournalEntries_CreateJournalEntries", - "requestBody": { - "description": "The Journal Entries to create", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JournalEntryModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JournalEntryModel" - } - } - }, - "application/*+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JournalEntryModel" - } - } + "summary": "Revoke Magic Link", + "description": "Revokes the 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.", + "operationId": "v1_MagicLinks_RevokeMagicLink", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The unique Accounting Data Service ID number of this magic link", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } - }, + ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JournalEntryModel" - } + "$ref": "#/components/schemas/ActionResultModel" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JournalEntryModel" - } + "$ref": "#/components/schemas/ActionResultModel" } } } }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/journal-entries/query": { - "get": { - "tags": [ - "JournalEntries" - ], - "summary": "Query Journal Entries", - "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 ADS Platform 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.", - "operationId": "v1_JournalEntries_QueryJournalEntries", - "parameters": [ - { - "name": "filter", - "in": "query", - "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "include", - "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Lines, Attachments", - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "in": "query", - "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageNumber", - "in": "query", - "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Success", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JournalEntryModelFetchResult" + "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/JournalEntryModelFetchResult" + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -10110,57 +9968,49 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/journal-entry-lines/{id}": { - "get": { + "/api/v1/useraccounts/magic-links/{id}/bounced": { + "delete": { "tags": [ - "JournalEntryLines" + "MagicLinks" ], - "summary": "Retrieve Journal Entry Line", - "description": "Retrieves the Journal Entry Line 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.", - "operationId": "v1_JournalEntryLines_RetrieveJournalEntryLine", + "summary": "Revoke Bounced Magic Link", + "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.", + "operationId": "v1_MagicLinks_RevokeBouncedMagicLink", "parameters": [ { "name": "id", "in": "path", - "description": "The unique Sage Network Platform ID number of this journal entry line; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this magic link", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "include", - "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: JournalEntry", - "schema": { - "type": "string" - } } ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JournalEntryLineModel" + "$ref": "#/components/schemas/ActionResultModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/JournalEntryLineModel" + "$ref": "#/components/schemas/ActionResultModel" } } } @@ -10189,30 +10039,30 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/journal-entry-lines/query": { + "/api/v1/useraccounts/magic-links/query": { "get": { "tags": [ - "JournalEntryLines" + "MagicLinks" ], - "summary": "Query Journal Entry Lines", - "description": "Queries Journal Entry Lines 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 ADS Platform 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.", - "operationId": "v1_JournalEntryLines_QueryJournalEntryLines", + "summary": "Query Magic Links", + "description": "Queries Magic Links for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.\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.", + "operationId": "v1_MagicLinks_QueryMagicLinks", "parameters": [ { "name": "filter", "in": "query", - "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "description": "The filter for this query.\r\nSee [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { "type": "string" } @@ -10220,7 +10070,7 @@ { "name": "include", "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: JournalEntry", + "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\nAvailable collections: User, CustomFields, Notes", "schema": { "type": "string" } @@ -10228,7 +10078,7 @@ { "name": "order", "in": "query", - "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "description": "The sort order for the results, in the [Searchlight order\r\nsyntax](https://github.com/tspence/csharp-searchlight).", "schema": { "type": "string" } @@ -10236,7 +10086,7 @@ { "name": "pageSize", "in": "query", - "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "description": "The page size for results (default 250, maximum of 500)", "schema": { "type": "integer", "format": "int32" @@ -10245,7 +10095,7 @@ { "name": "pageNumber", "in": "query", - "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "description": "The page number for results (default 0)", "schema": { "type": "integer", "format": "int32" @@ -10254,16 +10104,16 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JournalEntryLineModelFetchResult" + "$ref": "#/components/schemas/MagicLinkModelFetchResult" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/JournalEntryLineModelFetchResult" + "$ref": "#/components/schemas/MagicLinkModelFetchResult" } } } @@ -10277,72 +10127,57 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/useraccounts/magic-links/{id}": { + "/api/v1/useraccounts/magic-links/summary": { "get": { "tags": [ "MagicLinks" ], - "summary": "Retrieve Magic Link", - "description": "Retrieves the Magic Link 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.", - "operationId": "v1_MagicLinks_RetrieveMagicLink", + "summary": "Magic Link Summary", + "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.", + "operationId": "v1_MagicLinks_GetMagicLinkSummary", "parameters": [ { - "name": "id", - "in": "path", - "description": "The id of the Magic Link", - "required": true, + "name": "from", + "in": "query", + "description": "The date that the summary starts from (default one year ago from today)", "schema": { "type": "string", - "format": "uuid" + "format": "date-time" } }, { - "name": "include", + "name": "to", "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: User, CustomFields, Notes", + "description": "The date that the summary ends at (default today)", "schema": { - "type": "string" + "type": "string", + "format": "date-time" } } ], "responses": { "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MagicLinkModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/MagicLinkModel" - } - } - } - }, - "404": { - "description": "Not Found", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/MagicLinkSummaryModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/MagicLinkSummaryModel" } } } @@ -10356,47 +10191,58 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - }, - "delete": { + } + }, + "/api/v1/Notes/{id}": { + "get": { "tags": [ - "MagicLinks" + "Notes" ], - "summary": "Revoke Magic Link", - "description": "Revokes the 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.", - "operationId": "v1_MagicLinks_RevokeMagicLink", + "summary": "Retrieve Note", + "description": "Retrieves the note with the specified note identifier.\r\n\r\nA note is a customizable text string that can be attached to various account attributes within Accounting Data Service. 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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "operationId": "v1_Notes_RetrieveNote", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this magic link", + "description": "The unique ID number of the Note to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "include", + "in": "query", + "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", + "schema": { + "type": "string", + "default": "" + } } ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActionResultModel" + "$ref": "#/components/schemas/NoteModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ActionResultModel" + "$ref": "#/components/schemas/NoteModel" } } } @@ -10425,30 +10271,147 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - } - }, - "/api/v1/useraccounts/magic-links/{id}/bounced": { + }, + "patch": { + "tags": [ + "Notes" + ], + "summary": "Update Note", + "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 Accounting Data Service. 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.", + "operationId": "v1_Notes_UpdateNote", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Note id to be updated", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "description": "A list of changes to apply to this Note", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { } + } + }, + "text/json": { + "schema": { + "type": "object", + "additionalProperties": { } + } + }, + "application/*+json": { + "schema": { + "type": "object", + "additionalProperties": { } + } + } + } + }, + "responses": { + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NoteModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/NoteModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized" + } + }, + "security": [ + { + "oauth2": [ ] + }, + { + "bearer_token": [ ] + }, + { + "api_key": [ ] + } + ] + }, "delete": { "tags": [ - "MagicLinks" + "Notes" ], - "summary": "Revoke Bounced Magic Link", - "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.", - "operationId": "v1_MagicLinks_RevokeBouncedMagicLink", + "summary": "Archive Note", + "description": "Archives 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 Accounting Data Service. 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.", + "operationId": "v1_Notes_ArchiveNote", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this magic link", + "description": "Note id to be archived", "required": true, "schema": { "type": "string", @@ -10458,7 +10421,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -10496,30 +10459,124 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/useraccounts/magic-links/query": { + "/api/v1/Notes": { + "post": { + "tags": [ + "Notes" + ], + "summary": "Create Notes", + "description": "Creates one or more notes from the specified array of Note Models\r\n\r\nA note is a customizable text string that can be attached to various account attributes within Accounting Data Service. 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.", + "operationId": "v1_Notes_CreateNotes", + "requestBody": { + "description": "The array of notes to be created", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NoteModel" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NoteModel" + } + } + }, + "application/*+json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NoteModel" + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NoteModel" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NoteModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + }, + "security": [ + { + "oauth2": [ ] + }, + { + "bearer_token": [ ] + }, + { + "api_key": [ ] + } + ] + } + }, + "/api/v1/Notes/query": { "get": { "tags": [ - "MagicLinks" + "Notes" ], - "summary": "Query Magic Links", - "description": "Queries Magic Links for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.\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.", - "operationId": "v1_MagicLinks_QueryMagicLinks", + "summary": "Query Notes", + "description": "Queries Notes on the Accounting Data Service 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 Accounting Data Service Developer website.\r\n\r\nA note is a customizable text string that can be attached to various account attributes within Accounting Data Service. 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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "operationId": "v1_Notes_QueryNotes", "parameters": [ { "name": "filter", "in": "query", - "description": "The filter for this query.\r\nSee [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "description": "The filter to use to select from the list of available applications, in the [Searchlight query\r\nsyntax](https://github.com/tspence/csharp-searchlight).", "schema": { "type": "string" } @@ -10527,7 +10584,7 @@ { "name": "include", "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\nAvailable collections: User, CustomFields, Notes", + "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\nNo collections are currently available but may be offered in the future", "schema": { "type": "string" } @@ -10561,16 +10618,16 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MagicLinkModelFetchResult" + "$ref": "#/components/schemas/NoteModelFetchResult" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/MagicLinkModelFetchResult" + "$ref": "#/components/schemas/NoteModelFetchResult" } } } @@ -10584,57 +10641,97 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/useraccounts/magic-links/summary": { - "get": { + "/api/v1/notification-events": { + "post": { "tags": [ - "MagicLinks" + "NotificationEvents" ], - "summary": "Magic Link Summary", - "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.", - "operationId": "v1_MagicLinks_GetMagicLinkSummary", + "summary": "Accepting Notification Events", + "description": "Accepts notification events from internal services to be actioned on.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "operationId": "v1_NotificationEvents_AcceptNotificationEvent", "parameters": [ { - "name": "from", - "in": "query", - "description": "The date that the summary starts from (default one year ago from today)", - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "to", + "name": "validationToken", "in": "query", - "description": "The date that the summary ends at (default today)", + "description": "Token to validate subscription request from Notification Service.", "schema": { - "type": "string", - "format": "date-time" + "type": "string" } } ], + "requestBody": { + "description": "The notification event model of updates in an internal service based on the CloudEvent spec.\r\n \r\nMore information on CloudEvents can be found on the [CloudEvents](https://github.com/cloudevents/spec) GitHub page.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ObjectEventModel" + } + ], + "description": "Data record expressing an occurrence and its context" + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ObjectEventModel" + } + ], + "description": "Data record expressing an occurrence and its context" + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ObjectEventModel" + } + ], + "description": "Data record expressing an occurrence and its context" + } + } + } + }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MagicLinkSummaryModel" + "$ref": "#/components/schemas/ActionResult" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/MagicLinkSummaryModel" + "$ref": "#/components/schemas/ActionResult" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -10648,30 +10745,30 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Notes/{id}": { + "/api/v1/Payments/{id}": { "get": { "tags": [ - "Notes" + "Payments" ], - "summary": "Retrieve Note", - "description": "Retrieves the note with the specified note identifier.\r\n\r\nA note is a customizable text string that can be attached to various account attributes within ADS Platform. 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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", - "operationId": "v1_Notes_RetrieveNote", + "summary": "Retrieve Payment", + "description": "Retrieves the Payment specified by this unique identifier, optionally including nested data sets.\r\n\r\nA Payment represents money sent from one company to another. A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit. The creator of the Payment is identified by the `CustomerId` field, and the recipient of the Payment is identified by the `CompanyId` field. Most Payments are uniquely identified both by a Accounting Data Service ID number and a customer ERP \"key\" that was generated by the system that originated the Payment. Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which represents a deposit that has been paid and not yet applied to an Invoice.\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.", + "operationId": "v1_Payments_RetrievePayment", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ID number of the Note to retrieve", + "description": "The unique Accounting Data Service ID number of this Payment; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -10681,7 +10778,7 @@ { "name": "include", "in": "query", - "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", + "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Applications, Notes, Attachments, CustomFields\r\n \r\nNote: Including PDFSupport will populate the property HasPdf", "schema": { "type": "string", "default": "" @@ -10690,16 +10787,16 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NoteModel" + "$ref": "#/components/schemas/PaymentModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/NoteModel" + "$ref": "#/components/schemas/PaymentModel" } } } @@ -10728,28 +10825,28 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, "patch": { "tags": [ - "Notes" + "Payments" ], - "summary": "Update Note", - "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 ADS Platform. 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.", - "operationId": "v1_Notes_UpdateNote", + "summary": "Update Payment", + "description": "Updates an existing Payment with the information supplied to this PATCH call.\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 Payment represents money sent from one company to another. A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit. The creator of the Payment is identified by the `CustomerId` field, and the recipient of the Payment is identified by the `CompanyId` field. Most Payments are uniquely identified both by a Accounting Data Service ID number and a customer ERP \"key\" that was generated by the system that originated the Payment. Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which represents a deposit that has been paid and not yet applied to an Invoice.\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.", + "operationId": "v1_Payments_UpdatePayment", "parameters": [ { "name": "id", "in": "path", - "description": "Note id to be updated", + "description": "The unique Accounting Data Service ID number of the Payment to update; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -10758,24 +10855,24 @@ } ], "requestBody": { - "description": "A list of changes to apply to this Note", + "description": "A list of changes to apply to this Payment", "content": { "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -10796,79 +10893,69 @@ } } }, - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NoteModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/NoteModel" - } - } - } - }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "object", + "additionalProperties": { } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "object", + "additionalProperties": { } } } } }, - "403": { - "description": "Forbidden", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/PaymentModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/PaymentModel" } } } }, "401": { "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" } }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, "delete": { "tags": [ - "Notes" + "Payments" ], - "summary": "Archive Note", - "description": "Archives 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 ADS Platform. 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.", - "operationId": "v1_Notes_ArchiveNote", + "summary": "Delete Payment", + "description": "Deletes the Payment referred to by this unique identifier.\r\n\r\nA Payment represents money sent from one company to another. A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit. The creator of the Payment is identified by the `CustomerId` field, and the recipient of the Payment is identified by the `CompanyId` field. Most Payments are uniquely identified both by a Accounting Data Service ID number and a customer ERP \"key\" that was generated by the system that originated the Payment. Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which represents a deposit that has been paid and not yet applied to an Invoice.\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.", + "operationId": "v1_Payments_DeletePayment", "parameters": [ { "name": "id", "in": "path", - "description": "Note id to be archived", + "description": "The unique Accounting Data Service ID number of the Payment to delete; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -10878,7 +10965,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -10916,33 +11003,33 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Notes": { + "/api/v1/Payments": { "post": { "tags": [ - "Notes" + "Payments" ], - "summary": "Create Notes", - "description": "Creates one or more notes from the specified array of Note Models\r\n\r\nA note is a customizable text string that can be attached to various account attributes within ADS Platform. 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.", - "operationId": "v1_Notes_CreateNotes", + "summary": "Create Payments", + "description": "Creates one or more Payments within this account and returns the records as created.\r\n\r\nA Payment represents money sent from one company to another. A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit. The creator of the Payment is identified by the `CustomerId` field, and the recipient of the Payment is identified by the `CompanyId` field. Most Payments are uniquely identified both by a Accounting Data Service ID number and a customer ERP \"key\" that was generated by the system that originated the Payment. Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which represents a deposit that has been paid and not yet applied to an Invoice.\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.", + "operationId": "v1_Payments_CreatePayments", "requestBody": { - "description": "The array of notes to be created", + "description": "The Payments to create", "content": { "application/json": { "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/NoteModel" + "$ref": "#/components/schemas/PaymentModel" } } }, @@ -10950,7 +11037,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/NoteModel" + "$ref": "#/components/schemas/PaymentModel" } } }, @@ -10958,7 +11045,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/NoteModel" + "$ref": "#/components/schemas/PaymentModel" } } } @@ -10966,13 +11053,13 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/NoteModel" + "$ref": "#/components/schemas/PaymentModel" } } }, @@ -10980,7 +11067,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/NoteModel" + "$ref": "#/components/schemas/PaymentModel" } } } @@ -10991,12 +11078,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "object", + "additionalProperties": { } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "object", + "additionalProperties": { } } } } @@ -11010,30 +11099,30 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Notes/query": { + "/api/v1/Payments/query": { "get": { "tags": [ - "Notes" + "Payments" ], - "summary": "Query Notes", - "description": "Queries Notes on the ADS Platform 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 ADS Platform Developer website.\r\n\r\nA note is a customizable text string that can be attached to various account attributes within ADS Platform. 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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", - "operationId": "v1_Notes_QueryNotes", + "summary": "Query Payments", + "description": "Queries Payments 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 Accounting Data Service Developer website.\r\n\r\nA Payment represents money sent from one company to another. A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit. The creator of the Payment is identified by the `CustomerId` field, and the recipient of the Payment is identified by the `CompanyId` field. Most Payments are uniquely identified both by a Accounting Data Service ID number and a customer ERP \"key\" that was generated by the system that originated the Payment. Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which represents a deposit that has been paid and not yet applied to an Invoice.\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.", + "operationId": "v1_Payments_QueryPayments", "parameters": [ { "name": "filter", "in": "query", - "description": "The filter to use to select from the list of available applications, in the [Searchlight query\r\nsyntax](https://github.com/tspence/csharp-searchlight).", + "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { "type": "string" } @@ -11041,7 +11130,7 @@ { "name": "include", "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\nNo collections are currently available but may be offered in the future", + "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Applications, Notes, Attachments, CustomFields\r\n \r\nNote: Including PDFSupport will populate the property HasPdf", "schema": { "type": "string" } @@ -11049,7 +11138,7 @@ { "name": "order", "in": "query", - "description": "The sort order for the results, in the [Searchlight order\r\nsyntax](https://github.com/tspence/csharp-searchlight).", + "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { "type": "string" } @@ -11057,7 +11146,7 @@ { "name": "pageSize", "in": "query", - "description": "The page size for results (default 250, maximum of 500)", + "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { "type": "integer", "format": "int32" @@ -11066,7 +11155,7 @@ { "name": "pageNumber", "in": "query", - "description": "The page number for results (default 0)", + "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { "type": "integer", "format": "int32" @@ -11075,16 +11164,16 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NoteModelFetchResult" + "$ref": "#/components/schemas/PaymentModelFetchResult" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/NoteModelFetchResult" + "$ref": "#/components/schemas/PaymentModelFetchResult" } } } @@ -11098,58 +11187,66 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Payments/{id}": { + "/api/v1/Payments/{id}/pdf": { "get": { "tags": [ "Payments" ], - "summary": "Retrieve Payment", - "description": "Retrieves the Payment specified by this unique identifier, optionally including nested data sets.\r\n\r\nA Payment represents money sent from one company to another. A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit. The creator of the Payment is identified by the `CustomerId` field, and the recipient of the Payment is identified by the `CompanyId` field. Most Payments are uniquely identified both by a ADS Platform ID number and a customer ERP \"key\" that was generated by the system that originated the Payment. Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which represents a deposit that has been paid and not yet applied to an Invoice.\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.", - "operationId": "v1_Payments_RetrievePayment", + "summary": "Retrieve payment PDF", + "description": "Retrieves a PDF file for this payment if it has been synced using an app enrollment to one of the supported apps.\r\n\r\nQuickBooks Online supports AR Payments.\r\n\r\nFor other ERPs, the supported types will depend on the synced data.\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.", + "operationId": "v1_Payments_RetrievePaymentPdf", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this Payment; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this payment; NOT the customer's ERP key", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "include", - "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Applications, Notes, Attachments, CustomFields", - "schema": { - "type": "string", - "default": "" - } } ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaymentModel" + "type": "string", + "format": "binary" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/PaymentModel" + "type": "string", + "format": "binary" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -11178,28 +11275,28 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, - "patch": { + "head": { "tags": [ "Payments" ], - "summary": "Update Payment", - "description": "Updates an existing Payment with the information supplied to this PATCH call.\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 Payment represents money sent from one company to another. A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit. The creator of the Payment is identified by the `CustomerId` field, and the recipient of the Payment is identified by the `CompanyId` field. Most Payments are uniquely identified both by a ADS Platform ID number and a customer ERP \"key\" that was generated by the system that originated the Payment. Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which represents a deposit that has been paid and not yet applied to an Invoice.\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.", - "operationId": "v1_Payments_UpdatePayment", + "summary": "Check payment PDF", + "description": "Checks for whether a PDF file for this payment exists if it has been synced using an app enrollment to one of the supported apps.\r\n\r\nQuickBooks Online supports AR Payments.\r\n\r\nFor other ERPs, the supported types will depend on the synced data.\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.", + "operationId": "v1_Payments_CheckPaymentPdf", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the Payment to update; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this payment; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -11207,73 +11304,35 @@ } } ], - "requestBody": { - "description": "A list of changes to apply to this Payment", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "application/*+json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } - }, "responses": { - "404": { - "description": "Not Found", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "string", + "format": "binary" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "string", + "format": "binary" } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { - "type": "object", - "additionalProperties": {} + "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { - "type": "object", - "additionalProperties": {} - } - } - } - }, - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaymentModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/PaymentModel" + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -11287,158 +11346,81 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - }, - "delete": { + } + }, + "/api/v1/Payments/views/summary": { + "get": { "tags": [ "Payments" ], - "summary": "Delete Payment", - "description": "Deletes the Payment referred to by this unique identifier.\r\n\r\nA Payment represents money sent from one company to another. A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit. The creator of the Payment is identified by the `CustomerId` field, and the recipient of the Payment is identified by the `CompanyId` field. Most Payments are uniquely identified both by a ADS Platform ID number and a customer ERP \"key\" that was generated by the system that originated the Payment. Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which represents a deposit that has been paid and not yet applied to an Invoice.\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.", - "operationId": "v1_Payments_DeletePayment", + "summary": "Query Payment Summary View", + "description": "Queries Payments for this account using the specified filtering, sorting, nested fetch, and pagination rules requested. This query endpoint provides extra data about the summary of payment information.\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 Accounting Data Service Developer website.\r\n\r\nA Payment represents money sent from one company to another. A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit. The creator of the Payment is identified by the `CustomerId` field, and the recipient of the Payment is identified by the `CompanyId` field. Most Payments are uniquely identified both by a Accounting Data Service ID number and a customer ERP \"key\" that was generated by the system that originated the Payment. Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which represents a deposit that has been paid and not yet applied to an Invoice.\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.", + "operationId": "v1_Payments_QueryPaymentSummaries", "parameters": [ { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of the Payment to delete; NOT the customer's ERP key", - "required": true, + "name": "filter", + "in": "query", + "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActionResultModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ActionResultModel" - } - } + "type": "string" } }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + { + "name": "include", + "in": "query", + "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Summary, Aging", + "schema": { + "type": "string" } }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ { - "oauth2": [] + "name": "order", + "in": "query", + "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "schema": { + "type": "string" + } }, { - "bearer_token": [] + "name": "pageSize", + "in": "query", + "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "schema": { + "type": "integer", + "format": "int32" + } }, { - "api_key": [] - } - ] - } - }, - "/api/v1/Payments": { - "post": { - "tags": [ - "Payments" - ], - "summary": "Create Payments", - "description": "Creates one or more Payments within this account and returns the records as created.\r\n\r\nA Payment represents money sent from one company to another. A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit. The creator of the Payment is identified by the `CustomerId` field, and the recipient of the Payment is identified by the `CompanyId` field. Most Payments are uniquely identified both by a ADS Platform ID number and a customer ERP \"key\" that was generated by the system that originated the Payment. Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which represents a deposit that has been paid and not yet applied to an Invoice.\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.", - "operationId": "v1_Payments_CreatePayments", - "requestBody": { - "description": "The Payments to create", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentModel" - } - } - }, - "application/*+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentModel" - } - } + "name": "pageNumber", + "in": "query", + "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "schema": { + "type": "integer", + "format": "int32" } } - }, + ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} + "$ref": "#/components/schemas/PaymentSummaryModelPaymentSummaryTotalsModelSummaryFetchResult" } }, "text/json": { "schema": { - "type": "object", - "additionalProperties": {} + "$ref": "#/components/schemas/PaymentSummaryModelPaymentSummaryTotalsModelSummaryFetchResult" } } } @@ -11450,27 +11432,28 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Payments/query": { + "/api/v1/Payments/views/detail": { "get": { "tags": [ "Payments" ], - "summary": "Query Payments", - "description": "Queries Payments 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 ADS Platform Developer website.\r\n\r\nA Payment represents money sent from one company to another. A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit. The creator of the Payment is identified by the `CustomerId` field, and the recipient of the Payment is identified by the `CompanyId` field. Most Payments are uniquely identified both by a ADS Platform ID number and a customer ERP \"key\" that was generated by the system that originated the Payment. Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which represents a deposit that has been paid and not yet applied to an Invoice.\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.", - "operationId": "v1_Payments_QueryPayments", + "summary": "Query Payment Detail View", + "description": "Queries Payments within the Accounting Data Service 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 Accounting Data Service Developer website. A Payment represents money sent from one company to another. A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit. The creator of the Payment is identified by the CustomerId field, and the recipient of the Payment is identified by the CompanyId field. Most Payments are uniquely identified both by a Accounting Data Service ID number and a customer ERP \"key\" that was generated by the system that originated the Payment. Payments that have not been fully applied have a nonzero UnappliedAmount value, which represents a deposit that has been paid and not yet applied to an Invoice.\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.", + "operationId": "v1_Payments_RetrieveDetails", "parameters": [ { "name": "filter", @@ -11483,7 +11466,7 @@ { "name": "include", "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Applications, Notes, Attachments, CustomFields", + "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", "schema": { "type": "string" } @@ -11517,16 +11500,16 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaymentModelFetchResult" + "$ref": "#/components/schemas/PaymentDetailModelFetchResult" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/PaymentModelFetchResult" + "$ref": "#/components/schemas/PaymentDetailModelFetchResult" } } } @@ -11538,32 +11521,43 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Payments/{id}/pdf": { + "/api/v1/payments-acceptance/customers/{companyId}/{customerId}": { "get": { "tags": [ - "Payments" + "Payments-Acceptance/Customers" ], - "summary": "Retrieve payment PDF", - "description": "Retrieves a PDF file for this payment if it has been synced using an app enrollment to one of the supported apps.\r\n\r\nQuickBooks Online supports AR Payments.\r\n\r\nFor other ERPs, the supported types will depend on the synced data.\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.", - "operationId": "v1_Payments_RetrievePaymentPdf", + "summary": "Retrieve Customer", + "description": "Retrieves the Customer specified by this unique identifier.\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.", + "operationId": "v1_ServiceFabric_RetrieveCustomer", "parameters": [ { - "name": "id", + "name": "companyId", + "in": "path", + "description": "The unique Accounting Data Service ID number of this Company; NOT the Company's Service Fabric ID", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "customerId", "in": "path", - "description": "The unique ADS Platform ID number of this payment; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this Customer; NOT the Customer's Service Fabric ID", "required": true, "schema": { "type": "string", @@ -11573,33 +11567,16 @@ ], "responses": { "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "text/json": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - }, - "400": { - "description": "Bad Request", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/SfCustomerResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/SfCustomerResponse" } } } @@ -11626,30 +11603,33 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - }, - "head": { + } + }, + "/api/v1/payments-acceptance/customers/{companyId}": { + "post": { "tags": [ - "Payments" + "Payments-Acceptance/Customers" ], - "summary": "Check payment PDF", - "description": "Checks for whether a PDF file for this payment exists if it has been synced using an app enrollment to one of the supported apps.\r\n\r\nQuickBooks Online supports AR Payments.\r\n\r\nFor other ERPs, the supported types will depend on the synced data.\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.", - "operationId": "v1_Payments_CheckPaymentPdf", + "summary": "Create Customer", + "description": "Creates a Customer from the given models.\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.", + "operationId": "v1_ServiceFabric_CreateCustomer", "parameters": [ { - "name": "id", + "name": "companyId", "in": "path", - "description": "The unique ADS Platform ID number of this payment; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this Company; NOT the Company's Service Fabric ID", "required": true, "schema": { "type": "string", @@ -11657,211 +11637,70 @@ } } ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "text/json": { - "schema": { - "type": "string", - "format": "binary" - } + "requestBody": { + "description": "The Customer to create in Service Fabric", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SfCustomerRequest" + } + ], + "description": "API version of CustomerRequest" } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SfCustomerRequest" + } + ], + "description": "API version of CustomerRequest" + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SfCustomerRequest" + } + ], + "description": "API version of CustomerRequest" } } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" } }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/Payments/views/summary": { - "get": { - "tags": [ - "Payments" - ], - "summary": "Query Payment Summary View", - "description": "Queries Payments for this account using the specified filtering, sorting, nested fetch, and pagination rules requested. This query endpoint provides extra data about the summary of payment information.\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 ADS Platform Developer website.\r\n\r\nA Payment represents money sent from one company to another. A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit. The creator of the Payment is identified by the `CustomerId` field, and the recipient of the Payment is identified by the `CompanyId` field. Most Payments are uniquely identified both by a ADS Platform ID number and a customer ERP \"key\" that was generated by the system that originated the Payment. Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which represents a deposit that has been paid and not yet applied to an Invoice.\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.", - "operationId": "v1_Payments_QueryPaymentSummaries", - "parameters": [ - { - "name": "filter", - "in": "query", - "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "include", - "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Summary, Aging", - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "in": "query", - "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageNumber", - "in": "query", - "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaymentSummaryModelPaymentSummaryTotalsModelSummaryFetchResult" + "$ref": "#/components/schemas/SfCustomerResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/PaymentSummaryModelPaymentSummaryTotalsModelSummaryFetchResult" + "$ref": "#/components/schemas/SfCustomerResponse" } } } }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/Payments/views/detail": { - "get": { - "tags": [ - "Payments" - ], - "summary": "Query Payment Detail View", - "description": "Queries Payments within the ADS Platform 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 ADS Platform Developer website. A Payment represents money sent from one company to another. A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit. The creator of the Payment is identified by the CustomerId field, and the recipient of the Payment is identified by the CompanyId field. Most Payments are uniquely identified both by a ADS Platform ID number and a customer ERP \"key\" that was generated by the system that originated the Payment. Payments that have not been fully applied have a nonzero UnappliedAmount value, which represents a deposit that has been paid and not yet applied to an Invoice.\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.", - "operationId": "v1_Payments_RetrieveDetails", - "parameters": [ - { - "name": "filter", - "in": "query", - "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "include", - "in": "query", - "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", - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "in": "query", - "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageNumber", - "in": "query", - "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Success", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaymentDetailModelFetchResult" + "type": "object", + "additionalProperties": { } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/PaymentDetailModelFetchResult" + "type": "object", + "additionalProperties": { } } } } @@ -11873,32 +11712,33 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/payments-acceptance/customers/{companyId}/{customerId}": { + "/api/v1/payments-acceptance/payments/{companyId}/{paymentId}": { "get": { "tags": [ - "Payments-Acceptance/Customers" + "Payments-Acceptance/Payments" ], - "summary": "Retrieve Customer", - "description": "Retrieves the Customer specified by this unique identifier.\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.", - "operationId": "v1_ServiceFabric_RetrieveCustomer", + "summary": "Retrieve Payment", + "description": "Retrieves the Payment specified by the unique identifiers.\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.", + "operationId": "v1_ServiceFabric_RetrievePayment", "parameters": [ { "name": "companyId", "in": "path", - "description": "The unique ADS Platform ID number of this Company; NOT the Company's Service Fabric ID", + "description": "The unique Accounting Data Service ID number of this Company; NOT the Company's Service Fabric ID", "required": true, "schema": { "type": "string", @@ -11906,9 +11746,9 @@ } }, { - "name": "customerId", + "name": "paymentId", "in": "path", - "description": "The unique ADS Platform ID number of this Customer; NOT the Customer's Service Fabric ID", + "description": "The Payment ID", "required": true, "schema": { "type": "string", @@ -11918,16 +11758,16 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SfCustomerResponse" + "$ref": "#/components/schemas/SfPaymentResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/SfCustomerResponse" + "$ref": "#/components/schemas/SfPaymentResponse" } } } @@ -11954,32 +11794,33 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/payments-acceptance/customers/{companyId}": { + "/api/v1/payments-acceptance/payments/{companyId}": { "post": { "tags": [ - "Payments-Acceptance/Customers" + "Payments-Acceptance/Payments" ], - "summary": "Create Customer", - "description": "Creates a Customer from the given models.\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.", - "operationId": "v1_ServiceFabric_CreateCustomer", + "summary": "Create Payment", + "description": "Create and prepare Payment to be submitted\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.", + "operationId": "v1_ServiceFabric_CreatePayment", "parameters": [ { "name": "companyId", "in": "path", - "description": "The unique ADS Platform ID number of this Company; NOT the Company's Service Fabric ID", + "description": "The unique Accounting Data Service ID number of this Company; NOT the Company's Service Fabric ID", "required": true, "schema": { "type": "string", @@ -11988,52 +11829,52 @@ } ], "requestBody": { - "description": "The Customer to create in Service Fabric", + "description": "The Payment request body", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/SfCustomerRequest" + "$ref": "#/components/schemas/SfPaymentRequest" } ], - "description": "API version of CustomerRequest" + "description": "API version of PaymentRequest" } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/SfCustomerRequest" + "$ref": "#/components/schemas/SfPaymentRequest" } ], - "description": "API version of CustomerRequest" + "description": "API version of PaymentRequest" } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/SfCustomerRequest" + "$ref": "#/components/schemas/SfPaymentRequest" } ], - "description": "API version of CustomerRequest" + "description": "API version of PaymentRequest" } } } }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SfCustomerResponse" + "$ref": "#/components/schemas/SfPaymentResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/SfCustomerResponse" + "$ref": "#/components/schemas/SfPaymentResponse" } } } @@ -12043,14 +11884,12 @@ "content": { "application/json": { "schema": { - "type": "object", - "additionalProperties": {} + "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { - "type": "object", - "additionalProperties": {} + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -12062,32 +11901,31 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - } - }, - "/api/v1/payments-acceptance/payments/{companyId}/{paymentId}": { + }, "get": { "tags": [ "Payments-Acceptance/Payments" ], - "summary": "Retrieve Payment", - "description": "Retrieves the Payment specified by the unique identifiers.\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.", - "operationId": "v1_ServiceFabric_RetrievePayment", + "summary": "Query Payments", + "description": "Queries Payments for the current Company using the specified filtering rules requested.\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.", + "operationId": "v1_ServiceFabric_QueryPayments", "parameters": [ { "name": "companyId", "in": "path", - "description": "The unique ADS Platform ID number of this Company; NOT the Company's Service Fabric ID", + "description": "The unique Accounting Data Service ID number of a Company; NOT the Company's Service Fabric ID", "required": true, "schema": { "type": "string", @@ -12095,197 +11933,12 @@ } }, { - "name": "paymentId", - "in": "path", - "description": "The Payment ID", - "required": true, + "name": "updateDateTimeSince", + "in": "query", + "description": "From date (inclusive) in ISO 8601 Date format.", "schema": { "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SfPaymentResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/SfPaymentResponse" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/payments-acceptance/payments/{companyId}": { - "post": { - "tags": [ - "Payments-Acceptance/Payments" - ], - "summary": "Create Payment", - "description": "Create and prepare Payment to be submitted\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.", - "operationId": "v1_ServiceFabric_CreatePayment", - "parameters": [ - { - "name": "companyId", - "in": "path", - "description": "The unique ADS Platform ID number of this Company; NOT the Company's Service Fabric ID", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "description": "The Payment request body", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SfPaymentRequest" - } - ], - "description": "API version of PaymentRequest" - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SfPaymentRequest" - } - ], - "description": "API version of PaymentRequest" - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SfPaymentRequest" - } - ], - "description": "API version of PaymentRequest" - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SfPaymentResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/SfPaymentResponse" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - }, - "get": { - "tags": [ - "Payments-Acceptance/Payments" - ], - "summary": "Query Payments", - "description": "Queries Payments for the current Company using the specified filtering rules requested.\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.", - "operationId": "v1_ServiceFabric_QueryPayments", - "parameters": [ - { - "name": "companyId", - "in": "path", - "description": "The unique ADS Platform ID number of a Company; NOT the Company's Service Fabric ID", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "updateDateTimeSince", - "in": "query", - "description": "From date (inclusive) in ISO 8601 Date format.", - "schema": { - "type": "string", - "format": "date-time" + "format": "date-time" } }, { @@ -12308,7 +11961,7 @@ { "name": "customerId", "in": "query", - "description": "The unique ADS Platform ID number of a Customer; NOT the Customer's Service Fabric ID", + "description": "The unique Accounting Data Service ID number of a Customer; NOT the Customer's Service Fabric ID", "schema": { "type": "string" } @@ -12342,7 +11995,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -12363,15 +12016,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -12388,7 +12042,7 @@ { "name": "companyId", "in": "path", - "description": "The unique ADS Platform ID number of this Company; NOT the Company's Service Fabric ID", + "description": "The unique Accounting Data Service ID number of this Company; NOT the Company's Service Fabric ID", "required": true, "schema": { "type": "string", @@ -12408,7 +12062,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -12450,15 +12104,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -12475,7 +12130,7 @@ { "name": "companyId", "in": "path", - "description": "The unique ADS Platform ID number of this Company; NOT the Company's Service Fabric ID", + "description": "The unique Accounting Data Service ID number of this Company; NOT the Company's Service Fabric ID", "required": true, "schema": { "type": "string", @@ -12515,7 +12170,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -12557,15 +12212,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -12582,7 +12238,7 @@ { "name": "companyId", "in": "path", - "description": "The unique ADS Platform ID number of this Company; NOT the Company's Service Fabric ID", + "description": "The unique Accounting Data Service ID number of this Company; NOT the Company's Service Fabric ID", "required": true, "schema": { "type": "string", @@ -12627,7 +12283,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -12663,15 +12319,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -12688,7 +12345,7 @@ { "name": "companyId", "in": "path", - "description": "The unique ADS Platform ID number of this Company; NOT the Company's Service Fabric ID", + "description": "The unique Accounting Data Service ID number of this Company; NOT the Company's Service Fabric ID", "required": true, "schema": { "type": "string", @@ -12698,7 +12355,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -12740,15 +12397,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -12765,7 +12423,7 @@ { "name": "companyId", "in": "path", - "description": "The unique ADS Platform ID number of this Company; NOT the Company's Service Fabric ID", + "description": "The unique Accounting Data Service ID number of this Company; NOT the Company's Service Fabric ID", "required": true, "schema": { "type": "string", @@ -12785,7 +12443,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -12821,15 +12479,16 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -12846,7 +12505,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this Payment Applied; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of this Payment Applied; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -12865,7 +12524,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -12903,13 +12562,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -12924,7 +12583,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the Payment Applied to update; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of the Payment Applied to update; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -12938,26 +12597,26 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -13010,13 +12669,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, @@ -13031,7 +12690,7 @@ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the Payment Applied to delete; NOT the customer's ERP key", + "description": "The unique Accounting Data Service ID number of the Payment Applied to delete; NOT the customer's ERP key", "required": true, "schema": { "type": "string", @@ -13041,7 +12700,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -13079,13 +12738,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -13129,7 +12788,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -13173,13 +12832,13 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } @@ -13190,7 +12849,7 @@ "PaymentsApplied" ], "summary": "Query Payments Applied", - "description": "Queries Payments Applied 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 ADS Platform Developer website.\r\n\r\nA Payment Applied is created by a business who receives a Payment from a customer. A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices. The Payment Applied contains information about which Invoices are connected to which Payments and for which amounts.\r\n\r\nA Payment Applied can also be used to add funds to a Payment by way of a refund Payment. In this scenario the Payment Applied contains information about which Payment is being funded and which refund Payment supplied the funds.\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.", + "description": "Queries Payments Applied 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 Accounting Data Service Developer website.\r\n\r\nA Payment Applied is created by a business who receives a Payment from a customer. A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices. The Payment Applied contains information about which Invoices are connected to which Payments and for which amounts.\r\n\r\nA Payment Applied can also be used to add funds to a Payment by way of a refund Payment. In this scenario the Payment Applied contains information about which Payment is being funded and which refund Payment supplied the funds.\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.", "operationId": "v1_PaymentsApplied_QueryPaymentsApplied", "parameters": [ { @@ -13238,7 +12897,7 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { @@ -13261,180 +12920,137 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/profiles/accounting/{id}": { - "get": { + "/api/v1/Provisioning/free-account": { + "post": { "tags": [ - "Profiles/Accounting" + "Provisioning" ], - "summary": "Retrieve Accounting Profile", - "description": "Retrieves the Accounting Profile specified by this unique identifier, optionally including nested data sets.\r\n\r\nAn Accounting Profile is a child of a Company Profile, and collectively, they comprise the identity and necessary information for an accounting team to work with trading partners, financial institutions, auditors, and others. You can use Accounting Profiles to define an accounting function by what the function does and how to interface with the function.\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.", - "operationId": "v1_AccountingProfiles_RetrieveAccountingProfile", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of this Accounting Profile", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "include", - "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Attachments, CustomFields, Notes", - "schema": { - "type": "string", - "default": "" + "summary": "Provision Free Developer Account", + "description": "Creates a new account for a developer, sending an email with information on how to access the API.", + "operationId": "v1_Provisioning_ProvisionFreeDeveloperAccount", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeveloperAccountSubmitModel" + } + ], + "description": "Model containing information to create a new developer account." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeveloperAccountSubmitModel" + } + ], + "description": "Model containing information to create a new developer account." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeveloperAccountSubmitModel" + } + ], + "description": "Model containing information to create a new developer account." + } } } - ], + }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AccountingProfileModel" + "$ref": "#/components/schemas/ActionResultModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/AccountingProfileModel" + "$ref": "#/components/schemas/ActionResultModel" } } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "object", + "additionalProperties": { } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "object", + "additionalProperties": { } } } } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" } }, - "security": [ + "deprecated": true + } + }, + "/api/v1/Reports/ar/aging": { + "get": { + "tags": [ + "Reports" + ], + "summary": "AR Aging Report", + "description": "Generates an AR Aging Report.\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.", + "operationId": "v1_Reports_GenerateArAging", + "parameters": [ { - "oauth2": [] - }, - { - "bearer_token": [] + "name": "reportDate", + "in": "query", + "description": "The date used for calculation of days overdue. Defaults to current UTC date.", + "schema": { + "type": "string", + "format": "date-time" + } }, { - "api_key": [] - } - ] - }, - "patch": { - "tags": [ - "Profiles/Accounting" - ], - "summary": "Update Accounting Profile", - "description": "Updates an accounting profile 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\nAn Accounting Profile is a child of a Company Profile, and collectively, they comprise the identity and necessary information for an accounting team to work with trading partners, financial institutions, auditors, and others. You can use Accounting Profiles to define an accounting function by what the function does and how to interface with the function.\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.", - "operationId": "v1_AccountingProfiles_UpdateAccountingProfile", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of the Accounting Profile to update", - "required": true, + "name": "companyId", + "in": "query", + "description": "An optional Company ID to filter the aging to a specific company.", "schema": { "type": "string", "format": "uuid" } } ], - "requestBody": { - "description": "A list of changes to apply to this Accounting Profile", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "application/*+json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } - }, "responses": { - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AccountingProfileModel" + "$ref": "#/components/schemas/AgingModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/AccountingProfileModel" + "$ref": "#/components/schemas/AgingModel" } } } @@ -13448,62 +13064,48 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - }, - "delete": { + } + }, + "/api/v1/Reports/ap/aging": { + "get": { "tags": [ - "Profiles/Accounting" + "Reports" ], - "summary": "Delete Accounting Profile", - "description": "Delete the Accounting Profile referred to by this unique identifier.\r\n\r\nAn Accounting Profile is a child of a Company Profile, and collectively, they comprise the identity and necessary information for an accounting team to work with trading partners, financial institutions, auditors, and others. You can use Accounting Profiles to define an accounting function by what the function does and how to interface with the function.\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.", - "operationId": "v1_AccountingProfiles_DeleteAccountingProfile", + "summary": "AP Aging Report", + "description": "Generates an AP Aging Report.\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.", + "operationId": "v1_Reports_GenerateApAging", "parameters": [ { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of the Accounting Profile to disable", - "required": true, + "name": "reportDate", + "in": "query", + "description": "The date used for calculation of days overdue. Defaults to current UTC date.", "schema": { "type": "string", - "format": "uuid" + "format": "date-time" } } ], "responses": { "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActionResultModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ActionResultModel" - } - } - } - }, - "404": { - "description": "Not Found", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/AgingModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/AgingModel" } } } @@ -13517,72 +13119,72 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/profiles/accounting": { + "/api/v1/service-fabric/enroll": { "post": { "tags": [ - "Profiles/Accounting" + "Service-Fabric" ], - "summary": "Create Accounting Profiles", - "description": "Creates one or more accounting profiles from a given model.\r\n\r\nAn Accounting Profile is a child of a Company Profile, and collectively, they comprise the identity and necessary information for an accounting team to work with trading partners, financial institutions, auditors, and others. You can use Accounting Profiles to define an accounting function by what the function does and how to interface with the function.\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.", - "operationId": "v1_AccountingProfiles_CreateAccountingProfiles", + "summary": "Enroll in Service Fabric", + "description": "Creates an Organisation from a given model.\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.", + "operationId": "v1_ServiceFabric_CreateOrganisation", "requestBody": { - "description": "The Accounting Profiles to create", + "description": "The Organisation and Company to create in Service Fabric", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AccountingProfileRequest" - } + "allOf": [ + { + "$ref": "#/components/schemas/SfEnrollRequest" + } + ], + "description": "Service Fabric Enroll Request" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AccountingProfileRequest" - } + "allOf": [ + { + "$ref": "#/components/schemas/SfEnrollRequest" + } + ], + "description": "Service Fabric Enroll Request" } }, "application/*+json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AccountingProfileRequest" - } + "allOf": [ + { + "$ref": "#/components/schemas/SfEnrollRequest" + } + ], + "description": "Service Fabric Enroll Request" } } } }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AccountingProfileModel" - } + "$ref": "#/components/schemas/SfEnrollResponse" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AccountingProfileModel" - } + "$ref": "#/components/schemas/SfEnrollResponse" } } } @@ -13593,13 +13195,13 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -13611,83 +13213,67 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/profiles/accounting/query": { + "/api/v1/service-fabric/companies/{companyId}": { "get": { "tags": [ - "Profiles/Accounting" + "Service-Fabric" ], - "summary": "Query Accounting Profiles", - "description": "Queries Accounting Profiles 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 ADS Platform Developer website.\r\n\r\nAn Accounting Profile is a child of a Company Profile, and collectively, they comprise the identity and necessary information for an accounting team to work with trading partners, financial institutions, auditors, and others. You can use Accounting Profiles to define an accounting function by what the function does and how to interface with the function.\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.", - "operationId": "v1_AccountingProfiles_QueryAccountingProfiles", + "summary": "Retrieve Company", + "description": "Retrieves the Company specified by the unique identifiers.\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.", + "operationId": "v1_ServiceFabric_RetrieveCompany", "parameters": [ { - "name": "filter", - "in": "query", - "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "include", - "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\n Available collections: Attachments, CustomFields, Notes", - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "in": "query", - "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageNumber", - "in": "query", - "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "name": "companyId", + "in": "path", + "description": "The unique Accounting Data Service ID number of this Company; NOT the Company's Service Fabric ID", + "required": true, "schema": { - "type": "integer", - "format": "int32" + "type": "string", + "format": "uuid" } } ], "responses": { "200": { - "description": "Success", + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SfCompanyResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SfCompanyResponse" + } + } + } + }, + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AccountingProfileModelFetchResult" + "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/AccountingProfileModelFetchResult" + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -13699,48 +13285,37 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/profiles/accounting/{id}/contacts/models": { + "/api/v1/service-fabric/companies": { "get": { "tags": [ - "Profiles/Accounting" - ], - "summary": "Retrieve All Accounting Profile Contacts", - "description": "This route is obsolete, please use the query/models route on profiles/accounting/contacts/ instead.\r\n\r\nRetrieves all the Contacts associated with the Accounting Profile by this unique identifier, optionally including nested data sets.\r\n\r\nA Contact has a link to a Contact that is associated with your company's Accounting Profile.\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.", - "operationId": "v1_AccountingProfiles_RetrieveAllContacts", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of this Accounting Profile", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "Service-Fabric" ], + "summary": "Retrieve All Companies in Organisation", + "description": "Retrieves the Companies specified by the unique identifier of the Organisation.\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.", + "operationId": "v1_ServiceFabric_RetrieveAllCompanies", "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/ContactModel" + "$ref": "#/components/schemas/SfCompanyResponse" } } }, @@ -13748,7 +13323,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/ContactModel" + "$ref": "#/components/schemas/SfCompanyResponse" } } } @@ -13779,64 +13354,87 @@ "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - } - }, - "/api/v1/profiles/accounting/contacts/{id}": { - "get": { + }, + "post": { "tags": [ - "Profiles/Accounting/Contacts" - ], - "summary": "Retrieve Accounting Profile Contact", - "description": "Retrieves the Accounting Profile Contact specified by this unique identifier, optionally including nested data sets.\r\n\r\nA Contact has a link to a Contact that is associated with your company's Accounting Profile. A profile has one primary contact and any number of secondary contacts.\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.", - "operationId": "v1_AccountingProfileContacts_RetrieveContact", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of this Accounting Profile Contact", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "Service-Fabric" ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AccountingProfileContactModel" + "summary": "Create Companies", + "description": "Creates a Company from a given model.\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.", + "operationId": "v1_ServiceFabric_CreateCompany", + "requestBody": { + "description": "The Company to create in Service Fabric", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SfCompanyRequest" + } + ], + "description": "API version of CompanyRequest" + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SfCompanyRequest" + } + ], + "description": "API version of CompanyRequest" + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SfCompanyRequest" + } + ], + "description": "API version of CompanyRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SfCompanyResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/AccountingProfileContactModel" + "$ref": "#/components/schemas/SfCompanyResponse" } } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "object", + "additionalProperties": { } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "object", + "additionalProperties": { } } } } @@ -13848,30 +13446,41 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - }, - "delete": { + } + }, + "/api/v1/service-fabric/events/payments/{groupKey}": { + "post": { "tags": [ - "Profiles/Accounting/Contacts" + "Service-Fabric" ], - "summary": "Delete Accounting Profile Contact", - "description": "Delete the Accounting Profile Contact referred to by this unique identifier.\r\n\r\nAn Accounting Profile Contact has a link to a Contact that is associated with your company's Accounting Profile. A profile has one primary contact and any number of secondary contacts.\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.", - "operationId": "v1_AccountingProfileContacts_DeleteContact", + "summary": "Payments Hook", + "description": "Receives SF webhooks", + "operationId": "v1_ServiceFabric_ReceivePaymentWebhook", "parameters": [ { - "name": "id", + "name": "clientState", + "in": "header", + "description": "", + "schema": { + "type": "string" + } + }, + { + "name": "groupKey", "in": "path", - "description": "The unique ADS Platform ID number of the Accounting Profile Contact to delete", + "description": "The GroupKey of the group receiving these notifications", "required": true, "schema": { "type": "string", @@ -13879,48 +13488,101 @@ } } ], + "requestBody": { + "description": "The SF payload", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SfNotification" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SfNotification" + } + } + }, + "application/*+json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SfNotification" + } + } + } + } + }, "responses": { - "200": { - "description": "Success", + "204": { + "description": "No Content", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteResult" + "$ref": "#/components/schemas/ActionResult" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/DeleteResult" + "$ref": "#/components/schemas/ActionResult" } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteResult" + "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/DeleteResult" + "$ref": "#/components/schemas/ProblemDetails" } } } - }, - "404": { - "description": "Not Found", + } + }, + "deprecated": true + } + }, + "/api/v1/Status": { + "get": { + "tags": [ + "Status" + ], + "summary": "Ping", + "description": "Verifies that your application can successfully call the Accounting Data Service 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 Accounting Data Service API", + "operationId": "v1_Status_RetrieveStatus", + "parameters": [ + { + "name": "useCompanyInfo", + "in": "query", + "description": "When true, the API will use information from the 'Company'\r\n instead of the 'Group' company", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteResult" + "$ref": "#/components/schemas/StatusModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/DeleteResult" + "$ref": "#/components/schemas/StatusModel" } } } @@ -13934,72 +13596,104 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] + }, + { + "bearer_token": [ ] + }, + { + "api_key": [ ] + } + ] + } + }, + "/api/v1/Status/auth": { + "get": { + "tags": [ + "Status" + ], + "summary": "Check Authentication", + "description": "Verifies that the specified authentication token is valid and returns a successful code if it is.", + "operationId": "v1_Status_CheckAuthentication", + "responses": { + "200": { + "description": "OK" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + }, + "security": [ + { + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/profiles/accounting/contacts": { + "/api/v1/Sync": { "post": { "tags": [ - "Profiles/Accounting/Contacts" + "Sync" ], - "summary": "Create Accounting Profile Contacts", - "description": "Creates one or more Accounting Profile Contacts from a given model.\r\n\r\nAn Accounting Profile Contact has a link to a Contact that is associated with your company's Accounting Profile. A profile has one primary contact and any number of secondary contacts.\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.", - "operationId": "v1_AccountingProfileContacts_CreateContacts", + "summary": "Create Sync", + "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.", + "operationId": "v1_Sync_CreateSync", "requestBody": { - "description": "The Accounting Profile Contacts to create", + "description": "Information about the Sync to execute", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AccountingProfileContactModel" - } + "allOf": [ + { + "$ref": "#/components/schemas/SyncSubmitModel" + } + ], + "description": "A SyncSubmitModel represents a task that loads data from a connector to load into the Accounting Data Service. Data\r\ncontained in a sync will be merged with your existing data. Each record will be matched with existing data\r\ninside the Accounting Data Service 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. Accounting Data Service 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." } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AccountingProfileContactModel" - } + "allOf": [ + { + "$ref": "#/components/schemas/SyncSubmitModel" + } + ], + "description": "A SyncSubmitModel represents a task that loads data from a connector to load into the Accounting Data Service. Data\r\ncontained in a sync will be merged with your existing data. Each record will be matched with existing data\r\ninside the Accounting Data Service 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. Accounting Data Service 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." } }, "application/*+json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AccountingProfileContactModel" - } + "allOf": [ + { + "$ref": "#/components/schemas/SyncSubmitModel" + } + ], + "description": "A SyncSubmitModel represents a task that loads data from a connector to load into the Accounting Data Service. Data\r\ncontained in a sync will be merged with your existing data. Each record will be matched with existing data\r\ninside the Accounting Data Service 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. Accounting Data Service 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." } } } }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AccountingProfileContactModel" - } + "$ref": "#/components/schemas/SyncRequestModel" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AccountingProfileContactModel" - } + "$ref": "#/components/schemas/SyncRequestModel" } } } @@ -14010,13 +13704,43 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } + } + } + } + }, + "429": { + "description": "Too Many Requests", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -14030,59 +13754,72 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/profiles/accounting/contacts/{id}/{contactId}": { - "patch": { + "/api/v1/Sync/batch": { + "post": { "tags": [ - "Profiles/Accounting/Contacts" + "Sync" ], - "summary": "Update Accounting Profile Contact", - "description": "This route is obsolete, we will not support updates on many-to-many tables.\r\n\r\nUpdates an accounting profile contact 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\nAn Accounting Profile Contact has a link to a Contact that is associated with your company's Accounting Profile. A profile has one primary contact and any number of secondary contacts.\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.", - "operationId": "v1_AccountingProfileContacts_UpdateContact", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of the Accounting Profile Contact to update", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "contactId", - "in": "path", - "description": "The ID of the contact to link to this Accounting Profile Contact", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "summary": "Create Batch Import", + "description": "Creates a new batch import Sync task that imports all the models provided to this API call.\r\n\r\nA Sync task represents ingestion of data from a source. For each data model in the source, the Sync process will determine whether the data is new, updated, or unchanged from data that already exists within the Accounting Data Service. For records that are new, the Sync process will add them to the ADS Platform data. For records that are updated, the Sync process will update existing data to match the newly uploaded records. If records have not changed, no action will be taken.\r\n\r\nYou can use this Batch Import process to load data in bulk directly into the Accounting Data Service.\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.", + "operationId": "v1_Sync_CreateBatchImport", + "requestBody": { + "description": "Information about the Sync to execute", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/BatchSyncModel" + } + ], + "description": "A BatchSyncModel contains a collection of records to load into the Accounting Data Service. Data contained\r\nin this batch will be merged with your existing data. Each record will be matched with existing data inside\r\nthe Accounting Data Service using the [Identity Column](https://developer.lockstep.io/docs/identity-columns) rules.\r\nAny record that represents a new AppEnrollmentId+ErpKey will be inserted. A record that matches an existing\r\nAppEnrollmentId+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. ADS 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." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/BatchSyncModel" + } + ], + "description": "A BatchSyncModel contains a collection of records to load into the Accounting Data Service. Data contained\r\nin this batch will be merged with your existing data. Each record will be matched with existing data inside\r\nthe Accounting Data Service using the [Identity Column](https://developer.lockstep.io/docs/identity-columns) rules.\r\nAny record that represents a new AppEnrollmentId+ErpKey will be inserted. A record that matches an existing\r\nAppEnrollmentId+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. ADS 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." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/BatchSyncModel" + } + ], + "description": "A BatchSyncModel contains a collection of records to load into the Accounting Data Service. Data contained\r\nin this batch will be merged with your existing data. Each record will be matched with existing data inside\r\nthe Accounting Data Service using the [Identity Column](https://developer.lockstep.io/docs/identity-columns) rules.\r\nAny record that represents a new AppEnrollmentId+ErpKey will be inserted. A record that matches an existing\r\nAppEnrollmentId+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. ADS 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." + } } } - ], + }, "responses": { - "404": { - "description": "Not Found", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/SyncRequestModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/SyncRequestModel" } } } @@ -14092,116 +13829,44 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "object", + "additionalProperties": { } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "object", + "additionalProperties": { } } } } }, - "200": { - "description": "Success", + "429": { + "description": "Too Many Requests", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AccountingProfileContactModel" + "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/AccountingProfileContactModel" + "$ref": "#/components/schemas/ProblemDetails" } } } }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/profiles/accounting/contacts/query": { - "get": { - "tags": [ - "Profiles/Accounting/Contacts" - ], - "summary": "Query Accounting Profile Contacts", - "description": "Queries Accounting Profile Contacts 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 ADS Platform Developer website.\r\n\r\nAn Accounting Profile Contact has a link to a Contact that is associated with your company's Accounting Profile. A profile has one primary contact and any number of secondary contacts.\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.", - "operationId": "v1_AccountingProfileContacts_QueryContacts", - "parameters": [ - { - "name": "filter", - "in": "query", - "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "include", - "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\n Available collections: None", - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "in": "query", - "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageNumber", - "in": "query", - "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Success", + "default": { + "description": "Error", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AccountingProfileContactModelFetchResult" + "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/AccountingProfileContactModelFetchResult" + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -14215,143 +13880,130 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/profiles/accounting/contacts/query/models": { - "get": { + "/api/v1/Sync/zip": { + "post": { "tags": [ - "Profiles/Accounting/Contacts" + "Sync" ], - "summary": "Query Linked Accounting Profile Contacts", - "description": "Queries Accounting Profile Contacts and Contacts 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 ADS Platform Developer website.\r\n\r\nAn Accounting Profile Contact has a link to a Contact that is associated with your company's Accounting Profile. A profile has one primary contact and any number of secondary contacts.\r\n\r\nA Contact contains information about a person or role within a Company. You can use Contacts to track information about who is responsible for a specific project, who handles invoices, or information about which role at a particular customer or vendor you should speak with about invoices.\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.", - "operationId": "v1_AccountingProfileContacts_QueryLinkedContacts", + "summary": "Upload Sync File", + "description": "Requests a new Sync task from a ZIP file you provide. This ZIP file can contain one or more files with data from the customer's platform. Individual files can be in the format CSV or JSONL (JSON with Lines).\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.", + "operationId": "v1_Sync_CreateZipSync", "parameters": [ { - "name": "filter", + "name": "appEnrollmentId", "in": "query", - "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "description": "The optional existing app enrollment to associate with the data in the zip file.", "schema": { - "type": "string" + "type": "string", + "format": "uuid" } }, { - "name": "order", + "name": "parentSyncRequestId", "in": "query", - "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "description": "The optional existing sync request id to associate with the batch data in the zip file.", "schema": { - "type": "string" + "type": "string", + "format": "uuid" } }, { - "name": "include", + "name": "currentBatch", "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\n Available collections: None", + "description": "The optional current batch no associate with the batch data in the zip file.", "schema": { - "type": "string" + "type": "integer", + "format": "int32", + "default": 1 } }, { - "name": "pageSize", + "name": "totalBatches", "in": "query", - "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "description": "The optional total batches to associate with the total batch data in the zip file.", "schema": { "type": "integer", - "format": "int32" + "format": "int32", + "default": 1 } }, { - "name": "pageNumber", + "name": "isFullSync", "in": "query", - "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "description": "True if this is a full sync, false if this is a partial sync. Defaults to false.", "schema": { - "type": "integer", - "format": "int32" + "type": "boolean", + "default": false } } ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "description": "The ZIP file to upload for this Sync task", + "format": "binary" + } + } + }, + "encoding": { + "file": { + "style": "form" + } + } + } + } + }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AccountingProfileContactResultModelFetchResult" + "$ref": "#/components/schemas/SyncRequestModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/AccountingProfileContactResultModelFetchResult" + "$ref": "#/components/schemas/SyncRequestModel" } } } }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/profiles/accounting/contacts/{id}/primary": { - "patch": { - "tags": [ - "Profiles/Accounting/Contacts" - ], - "summary": "Set Secondary Contact as Primary", - "description": "Reverses the isPrimary fields on the primary and secondary contact to reflect a swap and returns the new primary accounting profile contact model.\r\n\r\nAn Accounting Profile Contact has a link to a Contact that is associated with your company's Accounting Profile. A profile has one primary contact and any number of secondary contacts.\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.", - "operationId": "v1_AccountingProfileContacts_SetAsPrimaryContact", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of the Accounting Profile Contact to set as primary", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "object", + "additionalProperties": { } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "object", + "additionalProperties": { } } } } }, - "400": { - "description": "Bad Request", + "429": { + "description": "Too Many Requests", "content": { "application/json": { "schema": { @@ -14365,17 +14017,17 @@ } } }, - "200": { - "description": "Success", + "default": { + "description": "Error", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AccountingProfileContactModel" + "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/AccountingProfileContactModel" + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -14389,53 +14041,78 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/profiles/companies/{urlSlug}": { - "get": { + "/api/v1/Sync/{id}": { + "patch": { "tags": [ - "Profiles/Companies" + "Sync" ], - "summary": "Retrieve Public Company Profile", - "description": "Retrieves the Public Company Profile specified by the public url slug.\r\n\r\nA Public Company Profile makes available the following information: ", - "operationId": "v1_CompanyProfiles_RetrievePublicCompanyProfile", + "summary": "Update Sync", + "description": "Updates an existing Sync with the information supplied to this PATCH call.\r\n\r\nThis API is restricted to internal service users and may not be called by customers or partners.\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. For example, you can provide the field name \"IsActive\" and specify the new value \"False\"; this API will then change the value of IsActive to false.\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.", + "operationId": "v1_Sync_UpdateSync", "parameters": [ { - "name": "urlSlug", + "name": "id", "in": "path", + "description": "The unique ID number of the Sync to update", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } } ], + "requestBody": { + "description": "A list of changes to apply to this Application", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { } + } + }, + "text/json": { + "schema": { + "type": "object", + "additionalProperties": { } + } + }, + "application/*+json": { + "schema": { + "type": "object", + "additionalProperties": { } + } + } + } + }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PublicCompanyProfileModel" + "$ref": "#/components/schemas/SyncRequestModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/PublicCompanyProfileModel" + "$ref": "#/components/schemas/SyncRequestModel" } } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -14448,183 +14125,132 @@ } } } - } - } - } - }, - "/api/v1/profiles/companies/query": { - "get": { - "tags": [ - "Profiles/Companies" - ], - "summary": "Query Public Company Profiles", - "description": "Queries Public Company Profiles\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 ADS Platform Developer website.\r\n\r\nA Public Company Profile makes available the following information:\r\n\r\n", - "operationId": "v1_CompanyProfiles_QueryPublicCompanyProfiles", - "parameters": [ - { - "name": "filter", - "in": "query", - "description": "The filter for this query.\r\nSee [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "The sort order for the results, in the [Searchlight order syntax](https://github.com/tspence/csharp-searchlight).", - "schema": { - "type": "string" - } }, - { - "name": "pageSize", - "in": "query", - "description": "The page size for results (default 250, maximum of 500)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageNumber", - "in": "query", - "description": "The page number for results (default 0)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Success", + "405": { + "description": "Method Not Allowed", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PublicCompanyProfileModelFetchResult" + "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/PublicCompanyProfileModelFetchResult" + "$ref": "#/components/schemas/ProblemDetails" } } } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" } - } - } - }, - "/api/v1/Provisioning/free-account": { - "post": { + }, + "security": [ + { + "oauth2": [ ] + }, + { + "bearer_token": [ ] + }, + { + "api_key": [ ] + } + ] + }, + "get": { "tags": [ - "Provisioning" + "Sync" ], - "summary": "Provision Free Developer Account", - "description": "Creates a new account for a developer, sending an email with information on how to access the API.", - "operationId": "v1_Provisioning_ProvisionFreeDeveloperAccount", - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/DeveloperAccountSubmitModel" - } - ], - "description": "Model containing information to create a new developer account." - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/DeveloperAccountSubmitModel" - } - ], - "description": "Model containing information to create a new developer account." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/DeveloperAccountSubmitModel" - } - ], - "description": "Model containing information to create a new developer account." - } + "summary": "Retrieve Sync", + "description": "Retrieves the status and information about a Sync operation by the requested ID. Provides status and progress information about this 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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "operationId": "v1_Sync_RetrieveSyncRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The unique ID number of the Sync task to retrieve", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "include", + "in": "query", + "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Details", + "schema": { + "type": "string", + "default": "" } } - }, + ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActionResultModel" + "$ref": "#/components/schemas/SyncRequestModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ActionResultModel" + "$ref": "#/components/schemas/SyncRequestModel" } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { - "type": "object", - "additionalProperties": {} + "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { - "type": "object", - "additionalProperties": {} + "$ref": "#/components/schemas/ProblemDetails" } } } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" } - } - } - }, - "/api/v1/Reports/trial-balance": { - "get": { - "tags": [ - "Reports" - ], - "summary": "Trial Balance Report", - "description": "Generates a Trial Balance Report for the given time 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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", - "operationId": "v1_Reports_GenerateTrialBalanceReport", - "parameters": [ + }, + "security": [ { - "name": "startDate", - "in": "query", - "description": "The start date of the report", - "schema": { - "type": "string", - "format": "date-time" - } + "oauth2": [ ] }, { - "name": "endDate", - "in": "query", - "description": "The end date of the report", - "schema": { - "type": "string", - "format": "date-time" - } + "bearer_token": [ ] }, { - "name": "appEnrollmentId", - "in": "query", - "description": "The app enrollment id of the app enrollment whose data will be used.", + "api_key": [ ] + } + ] + }, + "delete": { + "tags": [ + "Sync" + ], + "summary": "Cancel Sync", + "description": "Cancels a Sync process for an Application if the request is still being processed within the Application. This does not cancel Sync processes which have already proceeded to completion within the Application, or Sync processes outside of Applications such as from a Zip file or Batch Import.\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.", + "operationId": "v1_Sync_CancelSync", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The unique ID number of the Sync task to cancel", + "required": true, "schema": { "type": "string", "format": "uuid" @@ -14633,16 +14259,33 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SyncRequestModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SyncRequestModel" + } + } + } + }, + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FinancialReportModel" + "type": "object", + "additionalProperties": { } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/FinancialReportModel" + "type": "object", + "additionalProperties": { } } } } @@ -14656,114 +14299,90 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Reports/income-statement": { + "/api/v1/Sync/query": { "get": { "tags": [ - "Reports" + "Sync" ], - "summary": "Income Statement Report", - "description": "Generates an Income Statement for the given time 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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", - "operationId": "v1_Reports_GenerateIncomeStatement", + "summary": "Query Syncs", + "description": "Queries Sync tasks 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 Accounting Data Service Developer website.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "operationId": "v1_Sync_QuerySyncs", "parameters": [ { - "name": "startDate", + "name": "filter", "in": "query", - "description": "The start date of the report", + "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { - "type": "string", - "format": "date-time" + "type": "string" } }, { - "name": "endDate", + "name": "include", "in": "query", - "description": "The end date of the report", + "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Details", "schema": { - "type": "string", - "format": "date-time" + "type": "string" } }, { - "name": "appEnrollmentId", + "name": "order", "in": "query", - "description": "The app enrollment id of the app enrollment whose data will be used.", + "description": "The sort order for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "columnOption", + "name": "pageSize", "in": "query", - "description": "The desired column splitting of the report data. An empty string or anything unrecognized\r\n will result in only totals being displayed. Options are as follows:\r\n \r\n By Period - a column for every month/fiscal period within the reporting dates\r\n \r\n Quarterly - a column for every quarter within the reporting dates\r\n \r\n Annually - a column for every year within the reporting dates", + "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { - "type": "string" + "type": "integer", + "format": "int32" } }, { - "name": "displayDepth", + "name": "pageNumber", "in": "query", - "description": "The desired row splitting of the report data. For Income Statements, the minimum report depth is 1.\r\n Options are as follows:\r\n \r\n 1 - combine all accounts by their category\r\n 2 - combine all accounts by their subcategory\r\n 3 - display all accounts", + "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/ReportDepth" - } - ], - "description": "The different depths of describing an account. See the Financial Account Model for possible values for each depth\r\nEnum values are:\r\n \r\n0 - the classification of the account\r\n1 - the category of the account\r\n2 - the subcategory of the account\r\n3 - the account", - "default": 3 - } - }, - { - "name": "comparisonPeriod", - "in": "query", - "description": "Add a column for historical data with the following options and use showCurrencyDifference\r\n and/or show percentageDifference to display a comparison of that historical data to the report period.\r\n Options are as follows (note for YTD the data will be compared as a percentage of YTD and showCurrencyDifference and showPercentageDifference\r\n should not be used):\r\n \r\n \"PP\" - previous period (will show the previous quarter or year if Quarterly or Annually is chosen for columnOption)\r\n \"PY\" - previous year (the same date range as the report, but for the year prior)\r\n \"YTD\" - year to date (the current financial year to the current period)", - "schema": { - "type": "string" - } - }, - { - "name": "showCurrencyDifference", - "in": "query", - "description": "A boolean to turn on a currency based difference between the reporting period and the comparison period.", - "schema": { - "type": "boolean", - "default": false + "type": "integer", + "format": "int32" } }, { - "name": "showPercentageDifference", + "name": "operationType", "in": "query", - "description": "A boolean to turn on a percent based difference between the reporting period and the comparison period.", + "description": "The type of Sync requests to query, defaults to Read.", "schema": { - "type": "boolean", - "default": false + "type": "string", + "default": "Read" } } ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FinancialReportModel" + "$ref": "#/components/schemas/SyncRequestModelFetchResult" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/FinancialReportModel" + "$ref": "#/components/schemas/SyncRequestModelFetchResult" } } } @@ -14773,12 +14392,12 @@ "content": { "application/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -14792,96 +14411,81 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Reports/balance-sheet": { + "/api/v1/Transactions/query": { "get": { "tags": [ - "Reports" + "Transactions" ], - "summary": "Balance Sheet Report", - "description": "Generates a balance sheet for the given time 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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", - "operationId": "v1_Reports_GenerateBalanceSheet", + "summary": "Query Transactions", + "description": "Queries transactions (invoices/credit memos/payments) 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 Accounting Data Service 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.", + "operationId": "v1_Transactions_Query", "parameters": [ { - "name": "startDate", - "in": "query", - "description": "The start date of the report", - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "endDate", + "name": "filter", "in": "query", - "description": "The end date of the report", + "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { - "type": "string", - "format": "date-time" + "type": "string" } }, { - "name": "appEnrollmentId", + "name": "include", "in": "query", - "description": "The app enrollment id of the app enrollment whose data will be used.", + "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", "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "columnOption", + "name": "order", "in": "query", - "description": "The desired column splitting of the report data. An empty string or anything unrecognized\r\n will result in only totals being displayed. Options are as follows:\r\n \r\n By Period - a column for every month/fiscal period within the reporting dates\r\n \r\n Quarterly - a column for every quarter within the reporting dates\r\n \r\n Annually - a column for every year within the reporting dates", + "description": "The sort order for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { "type": "string" } }, { - "name": "displayDepth", + "name": "pageSize", "in": "query", - "description": "The desired row splitting of the report data. For Balance Sheets, the minimum report depth is 1.\r\n Options are as follows:\r\n \r\n 1 - combine all accounts by their category\r\n 2 - combine all accounts by their subcategory\r\n 3 - display all accounts", + "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/ReportDepth" - } - ], - "description": "The different depths of describing an account. See the Financial Account Model for possible values for each depth\r\nEnum values are:\r\n \r\n0 - the classification of the account\r\n1 - the category of the account\r\n2 - the subcategory of the account\r\n3 - the account", - "default": 3 + "type": "integer", + "format": "int32" } }, { - "name": "comparisonPeriod", + "name": "pageNumber", "in": "query", - "description": "Add a column for historical data with the following options and use showCurrencyDifference\r\n and/or show percentageDifference to display a comparison of that historical data to the report period.\r\n \r\n \"PP\" - previous period (will show the previous quarter or year if Quarterly or Annually is chosen for columnOption)\r\n \"PY\" - previous year (the same date range as the report, but for the year prior)", + "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { - "type": "string" + "type": "integer", + "format": "int32" } }, { - "name": "showCurrencyDifference", + "name": "currentDate", "in": "query", - "description": "A boolean to turn on a currency based difference between the reporting period and the comparison period.", + "description": "The date the days past due value will be calculated against. If no currentDate is provided the current UTC date will be used.", "schema": { - "type": "boolean", - "default": false + "type": "string", + "format": "date-time" } }, { - "name": "showPercentageDifference", + "name": "legacy", "in": "query", - "description": "A boolean to turn on a percent based difference between the reporting period and the comparison period.", + "description": "Generates query data based on legacy approach of executing SQL view queries.", "schema": { "type": "boolean", "default": false @@ -14890,31 +14494,16 @@ ], "responses": { "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FinancialReportModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/FinancialReportModel" - } - } - } - }, - "400": { - "description": "Bad Request", + "description": "OK", "content": { "application/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/TransactionModelTransactionSummaryTotalModelSummaryFetchResult" } }, "text/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/TransactionModelTransactionSummaryTotalModelSummaryFetchResult" } } } @@ -14928,103 +14517,55 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Reports/cash-flow-statement": { + "/api/v1/Transactions/{id}/details": { "get": { "tags": [ - "Reports" + "Transactions" ], - "summary": "Cash Flow Statement Report", - "description": "Generates a cash flow statement for the given time 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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", - "operationId": "v1_Reports_GenerateCashFlowStatement", + "summary": "Retrieve Transaction Details", + "description": "Retrieves a list of transaction details for the supplied transaction id.\r\n\r\nA Transaction Detail contains information about the associated Transaction. This information can be an invoice associated to a payment or credit memo or a payment or credit memo used as payment for one or more invoices.\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.", + "operationId": "v1_Transactions_RetrieveTransactionDetails", "parameters": [ { - "name": "startDate", - "in": "query", - "description": "The start date of the report", - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "endDate", - "in": "query", - "description": "The end date of the report", - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "appEnrollmentId", - "in": "query", - "description": "The app enrollment id of the app enrollment whose data will be used.", + "name": "id", + "in": "path", + "description": "", + "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "columnOption", - "in": "query", - "description": "The desired column splitting of the report data. An empty string or anything unrecognized\r\n will result in only totals being displayed. Options are as follows:\r\n \r\n By Period - a column for every month/fiscal period within the reporting dates\r\n \r\n Quarterly - a column for every quarter within the reporting dates\r\n \r\n Annually - a column for every year within the reporting dates", - "schema": { - "type": "string" - } - }, - { - "name": "displayDepth", - "in": "query", - "description": "The desired row splitting of the report data.\r\n Options are as follows:\r\n \r\n 0 - combine all accounts by their classification\r\n 1 - combine all accounts by their category\r\n 2 - combine all accounts by their subcategory\r\n 3 - display all accounts", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/ReportDepth" - } - ], - "description": "The different depths of describing an account. See the Financial Account Model for possible values for each depth\r\nEnum values are:\r\n \r\n0 - the classification of the account\r\n1 - the category of the account\r\n2 - the subcategory of the account\r\n3 - the account", - "default": 3 - } } ], "responses": { "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FinancialReportModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/FinancialReportModel" - } - } - } - }, - "400": { - "description": "Bad Request", + "description": "OK", "content": { "application/json": { "schema": { - "type": "string" + "type": "array", + "items": { + "$ref": "#/components/schemas/TransactionDetailModel" + } } }, "text/json": { "schema": { - "type": "string" + "type": "array", + "items": { + "$ref": "#/components/schemas/TransactionDetailModel" + } } } } @@ -15038,48 +14579,73 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Reports/ar/aging": { + "/api/v1/UserAccounts/{id}": { "get": { "tags": [ - "Reports" + "UserAccounts" ], - "summary": "AR Aging Report", - "description": "Generates an AR Aging Report.\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.", - "operationId": "v1_Reports_GenerateArAging", + "summary": "Retrieve User", + "description": "Retrieves the User with this identifier.\r\n\r\nA User represents a person who has the ability to authenticate against the Accounting Data Service and use services such as ADS 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 Accounting Data Service services. Users may have different privileges and access control rights within the Accounting Data Service.\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.", + "operationId": "v1_UserAccounts_RetrieveUser", "parameters": [ { - "name": "reportDate", + "name": "id", + "in": "path", + "description": "The unique ID number of the User to retrieve", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "include", "in": "query", - "description": "The date used for calculation of days overdue. Defaults to current UTC date.", + "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Notes, Attachments, CustomFields, AccountingRole", "schema": { "type": "string", - "format": "date-time" + "default": "" } } ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AgingModel" + "$ref": "#/components/schemas/UserAccountModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/AgingModel" + "$ref": "#/components/schemas/UserAccountModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -15091,128 +14657,138 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - } - }, - "/api/v1/service-fabric/enroll": { - "post": { + }, + "patch": { "tags": [ - "Service-Fabric" + "UserAccounts" + ], + "summary": "Update User", + "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\nOnly Group Owners and Admins can change other users.When updating another user, only the role and status can be updated.A user can only change their own status when their current status is Onboarding.A user can never change their own role.Nobody can change the owner's role or status. See the \"/transfer-owner\" route for changing the owner.A user can change their own personal 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 Accounting Data Service and use services such as ADS 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 Accounting Data Service services. Users may have different privileges and access control rights within the Accounting Data Service.\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.", + "operationId": "v1_UserAccounts_UpdateUser", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The unique ID number of the User to retrieve", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } ], - "summary": "Enroll in Service Fabric", - "description": "Creates an Organisation from a given model.\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.", - "operationId": "v1_ServiceFabric_CreateOrganisation", "requestBody": { - "description": "The Organisation and Company to create in Service Fabric", + "description": "A list of changes to apply to this User", "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SfEnrollRequest" - } - ], - "description": "Service Fabric Enroll Request" + "type": "object", + "additionalProperties": { } } }, "text/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SfEnrollRequest" - } - ], - "description": "Service Fabric Enroll Request" + "type": "object", + "additionalProperties": { } } }, "application/*+json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SfEnrollRequest" - } - ], - "description": "Service Fabric Enroll Request" + "type": "object", + "additionalProperties": { } } } } }, "responses": { - "200": { - "description": "Success", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SfEnrollResponse" + "type": "object", + "additionalProperties": { } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/SfEnrollResponse" + "type": "object", + "additionalProperties": { } } } } }, - "400": { - "description": "Bad Request", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "type": "object", - "additionalProperties": {} + "$ref": "#/components/schemas/UserAccountModel" } }, "text/json": { "schema": { - "type": "object", - "additionalProperties": {} + "$ref": "#/components/schemas/UserAccountModel" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - } - }, - "/api/v1/service-fabric/companies/{companyId}": { - "get": { + }, + "delete": { "tags": [ - "Service-Fabric" + "UserAccounts" ], - "summary": "Retrieve Company", - "description": "Retrieves the Company specified by the unique identifiers.\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.", - "operationId": "v1_ServiceFabric_RetrieveCompany", + "summary": "Disable User", + "description": "Disable the user referred to by this unique identifier.\r\n\r\nA User represents a person who has the ability to authenticate against the Accounting Data Service and use services such as ADS 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 Accounting Data Service services. Users may have different privileges and access control rights within the Accounting Data Service.\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.", + "operationId": "v1_UserAccounts_DisableUser", "parameters": [ { - "name": "companyId", + "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of this Company; NOT the Company's Service Fabric ID", + "description": "The unique Accounting Data Service ID number of this User", "required": true, "schema": { "type": "string", @@ -15222,16 +14798,16 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SfCompanyResponse" + "$ref": "#/components/schemas/ActionResultModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/SfCompanyResponse" + "$ref": "#/components/schemas/ActionResultModel" } } } @@ -15258,45 +14834,51 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/service-fabric/companies": { - "get": { + "/api/v1/UserAccounts/reenable": { + "post": { "tags": [ - "Service-Fabric" + "UserAccounts" + ], + "summary": "Reenable User", + "description": "This route is obsolete, please use the /UserAccounts/invite to reenable a disabled user.\r\n\r\nReenable the user referred to by this unique identifier.\r\n\r\nA User represents a person who has the ability to authenticate against the Accounting Data Service and use services such as ADS 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 Accounting Data Service services. Users may have different privileges and access control rights within the Accounting Data Service.\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.", + "operationId": "v1_UserAccounts_ReenableUser", + "parameters": [ + { + "name": "id", + "in": "query", + "description": "The unique Accounting Data Service ID number of this User", + "schema": { + "type": "string", + "format": "uuid" + } + } ], - "summary": "Retrieve All Companies in Organisation", - "description": "Retrieves the Companies specified by the unique identifier of the Organisation.\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.", - "operationId": "v1_ServiceFabric_RetrieveAllCompanies", "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SfCompanyResponse" - } + "$ref": "#/components/schemas/ActionResultModel" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SfCompanyResponse" - } + "$ref": "#/components/schemas/ActionResultModel" } } } @@ -15323,72 +14905,75 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - }, + } + }, + "/api/v1/UserAccounts/invite": { "post": { "tags": [ - "Service-Fabric" + "UserAccounts" ], - "summary": "Create Companies", - "description": "Creates a Company from a given model.\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.", - "operationId": "v1_ServiceFabric_CreateCompany", + "summary": "Invite User", + "description": "Invite a user with the specified email to join your accounting group. The user will receive an email to set up their account.\r\n\r\nA User represents a person who has the ability to authenticate against the Accounting Data Service and use services such as ADS 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 Accounting Data Service services. Users may have different privileges and access control rights within the Accounting Data Service.\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.", + "operationId": "v1_UserAccounts_InviteUser", "requestBody": { - "description": "The Company to create in Service Fabric", + "description": "The user to invite", "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SfCompanyRequest" - } - ], - "description": "API version of CompanyRequest" + "type": "array", + "items": { + "$ref": "#/components/schemas/InviteSubmitModel" + } } }, "text/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SfCompanyRequest" - } - ], - "description": "API version of CompanyRequest" + "type": "array", + "items": { + "$ref": "#/components/schemas/InviteSubmitModel" + } } }, "application/*+json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SfCompanyRequest" - } - ], - "description": "API version of CompanyRequest" + "type": "array", + "items": { + "$ref": "#/components/schemas/InviteSubmitModel" + } } } } }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SfCompanyResponse" + "type": "array", + "items": { + "$ref": "#/components/schemas/InviteModel" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/SfCompanyResponse" + "type": "array", + "items": { + "$ref": "#/components/schemas/InviteModel" + } } } } @@ -15399,13 +14984,13 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } @@ -15417,88 +15002,49 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - } - }, - "/api/v1/service-fabric/events/payments/{groupKey}": { - "post": { + }, + "get": { "tags": [ - "Service-Fabric" + "UserAccounts" ], - "summary": "Payments Hook", - "description": "Receives SF webhooks", - "operationId": "v1_ServiceFabric_ReceivePaymentWebhook", + "summary": "Retrieve Invite Data", + "description": "Retrieves invite information for the specified invite token.\r\n\r\nA User represents a person who has the ability to authenticate against the Accounting Data Service and use services such as ADS 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 Accounting Data Service services. Users may have different privileges and access control rights within the Accounting Data Service.", + "operationId": "v1_UserAccounts_RetrieveInviteData", "parameters": [ { - "name": "clientState", - "in": "header", - "description": "", - "schema": { - "type": "string" - } - }, - { - "name": "groupKey", - "in": "path", - "description": "The GroupKey of the group receiving these notifications", - "required": true, + "name": "code", + "in": "query", + "description": "The code of the invite", "schema": { "type": "string", "format": "uuid" } } ], - "requestBody": { - "description": "The SF payload", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SfNotification" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SfNotification" - } - } - }, - "application/*+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SfNotification" - } - } - } - } - }, "responses": { - "204": { - "description": "No Content", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ActionResult" + "$ref": "#/components/schemas/InviteDataModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ActionResult" + "$ref": "#/components/schemas/InviteDataModel" } } } @@ -15518,53 +15064,65 @@ } } } - } + }, + "deprecated": true } }, - "/api/v1/service-fabric/directory/companies": { - "get": { + "/api/v1/UserAccounts/transfer-owner": { + "post": { "tags": [ - "Service-Fabric/Directory" + "UserAccounts" ], - "summary": "Retrieve Directory Company", - "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.", - "operationId": "v1_DirectoryCompanies_GetDirectoryCompanyById", - "parameters": [ - { - "name": "id", - "in": "query", - "description": "", - "schema": { - "type": "string" - } - }, - { - "name": "dataset", - "in": "query", - "description": "", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/DirectoryDataSet" - } - ], - "description": "Different dataset types to retrieve information from the Directory Service", - "default": 0 + "summary": "Transfer Owner", + "description": "Transfer the ownership of a group to another user. This API must be called by the current owner of the group.\r\n\r\nA User represents a person who has the ability to authenticate against the Accounting Data Service and use services such as ADS 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 Accounting Data Service services. Users may have different privileges and access control rights within the Accounting Data Service.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", + "operationId": "v1_UserAccounts_TransferOwner", + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TransferOwnerSubmitModel" + } + ], + "description": "Model used to submit a transfer ownership request" + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TransferOwnerSubmitModel" + } + ], + "description": "Model used to submit a transfer ownership request" + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TransferOwnerSubmitModel" + } + ], + "description": "Model used to submit a transfer ownership request" + } } } - ], + }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DirectoryCompany" + "$ref": "#/components/schemas/TransferOwnerModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/DirectoryCompany" + "$ref": "#/components/schemas/TransferOwnerModel" } } } @@ -15606,72 +15164,99 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/service-fabric/external-connectors/query": { + "/api/v1/UserAccounts/query": { "get": { "tags": [ - "Service-Fabric/External-Connectors" + "UserAccounts" ], - "summary": "Retrieve External Connectors", - "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.", - "operationId": "v1_ExternalConnectors_Query", + "summary": "Query Users", + "description": "Queries Users for this account using the specified filtering, sorting, nested fetch, and pagination rules requested. A User represents a person who has the ability to authenticate against the Accounting Data Service and use services such as ADS 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 Accounting Data Service services. Users may have different privileges and access control rights within the Accounting Data Service.\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.", + "operationId": "v1_UserAccounts_QueryUsers", "parameters": [ { - "name": "Category", + "name": "filter", "in": "query", - "description": "Provider's category to search for. If no provider of the requested category exists the returned list is empty.", + "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { "type": "string" } - } + }, + { + "name": "include", + "in": "query", + "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Notes, Attachments, CustomFields, AccountingRole", + "schema": { + "type": "string" + } + }, + { + "name": "order", + "in": "query", + "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageNumber", + "in": "query", + "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "schema": { + "type": "integer", + "format": "int32" + } + } ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExternalConnector" - } + "$ref": "#/components/schemas/UserAccountModelFetchResult" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExternalConnector" - } + "$ref": "#/components/schemas/UserAccountModelFetchResult" } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { - "type": "object", - "additionalProperties": {} + "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { - "type": "object", - "additionalProperties": {} + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -15683,56 +15268,67 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/service-fabric/external-connectors/{id}/tokens": { - "get": { + "/api/v1/UserAccounts/change-group": { + "post": { "tags": [ - "Service-Fabric/External-Connectors" + "UserAccounts" ], - "summary": "Retrieve External Connector Tokens", - "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.", - "operationId": "v1_ExternalConnectors_GetExternalConnectorTokensById", + "summary": "Change User Group", + "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 Accounting Data Service and use services such as ADS 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 Accounting Data Service services. Users may have different privileges and access control rights within the Accounting Data Service.", + "operationId": "v1_UserAccounts_ChangeUserGroup", "parameters": [ { - "name": "id", - "in": "path", - "description": "External connector identifier", + "name": "groupKey", + "in": "query", + "description": "", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } } ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExternalConnectorToken" - } + "$ref": "#/components/schemas/UserAccountModel" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExternalConnectorToken" - } + "$ref": "#/components/schemas/UserAccountModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -15759,83 +15355,165 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - }, - "post": { + } + }, + "/api/v1/UserAccounts/user-data": { + "get": { "tags": [ - "Service-Fabric/External-Connectors" + "UserAccounts" ], - "summary": "Start External Connector Authentication", - "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.", - "operationId": "v1_ExternalConnectors_StartExternalConnectorAuth", + "summary": "Get User Data", + "description": "Retrieves the user data for the current user. This allows for retrieving extended user data such as UTM parameters.", + "operationId": "v1_UserAccounts_GetUserData", "parameters": [ { - "name": "id", - "in": "path", - "description": "External connector identifier", + "name": "include", + "in": "query", + "description": "The set of data to retrieve. To avoid any casing confusion, these values are converted to upper case.\r\n Possible values are: UTM", "required": true, "schema": { - "type": "string" + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserDataResponseModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserDataResponseModel" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + }, + "deprecated": true, + "security": [ + { + "oauth2": [ ] + }, + { + "bearer_token": [ ] + }, + { + "api_key": [ ] } + ] + } + }, + "/api/v1/UserAccounts/support-access": { + "post": { + "tags": [ + "UserAccounts" ], + "summary": "Set Support Access", + "description": "Set support access for the calling user.\r\n\r\nSupport access allows Accounting Data Service 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\nProviding a `null` value for the `expiresAt` parameter will revoke support access.\r\n\r\nEvery call to this API will regenerate the support access code.", + "operationId": "v1_UserAccounts_SetSupportAccess", "requestBody": { - "description": "External connector auth request information", + "description": "", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/ExternalConnectorAuthRequest" + "$ref": "#/components/schemas/SupportAccessRequest" } ], - "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." + "description": "Sets support access data for a user." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/ExternalConnectorAuthRequest" + "$ref": "#/components/schemas/SupportAccessRequest" } ], - "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." + "description": "Sets support access data for a user." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/ExternalConnectorAuthRequest" + "$ref": "#/components/schemas/SupportAccessRequest" } ], - "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." + "description": "Sets support access data for a user." } } - } + }, + "required": true }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ExternalConnectorAuth" + "$ref": "#/components/schemas/SupportAccessModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ExternalConnectorAuth" + "$ref": "#/components/schemas/SupportAccessModel" } } } @@ -15862,50 +15540,76 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Status": { + "/api/v1/UserRoles/{id}": { "get": { "tags": [ - "Status" + "UserRoles" ], - "summary": "Ping", - "description": "Verifies that your application can successfully call the ADS 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 ADS Platform API", - "operationId": "v1_Status_RetrieveStatus", + "summary": "Retrieve User Role", + "description": "Retrieves the User Role with this identifier.\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.", + "operationId": "v1_UserRoles_RetrieveUserRole", "parameters": [ { - "name": "useCompanyInfo", + "name": "id", + "in": "path", + "description": "The unique ID number of the User Role to retrieve", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "include", "in": "query", - "description": "When true, the API will use information from the 'Company'\r\n instead of the 'Group' company", + "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", "schema": { - "type": "boolean", - "default": false + "type": "string", + "default": "" } } ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StatusModel" + "$ref": "#/components/schemas/UserRoleModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/StatusModel" + "$ref": "#/components/schemas/UserRoleModel" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -15919,142 +15623,143 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Status/auth": { + "/api/v1/UserRoles/query": { "get": { "tags": [ - "Status" + "UserRoles" ], - "summary": "Check Authentication", - "description": "Verifies that the specified authentication token is valid and returns a successful code if it is.", - "operationId": "v1_Status_CheckAuthentication", - "responses": { - "200": { - "description": "Success" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ + "summary": "Query User Roles", + "description": "Queries User Roles for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.\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.", + "operationId": "v1_UserRoles_QueryUserRoles", + "parameters": [ { - "oauth2": [] + "name": "filter", + "in": "query", + "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "schema": { + "type": "string" + } }, { - "bearer_token": [] + "name": "include", + "in": "query", + "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", + "schema": { + "type": "string" + } }, { - "api_key": [] - } - ] - } - }, - "/api/v1/Sync": { - "post": { - "tags": [ - "Sync" - ], - "summary": "Create Sync", - "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.", - "operationId": "v1_Sync_CreateSync", - "requestBody": { - "description": "Information about the Sync to execute", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SyncSubmitModel" - } - ], - "description": "A SyncSubmitModel represents a task that loads data from a connector to load into the ADS 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 ADS 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. ADS Platform 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." - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SyncSubmitModel" - } - ], - "description": "A SyncSubmitModel represents a task that loads data from a connector to load into the ADS 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 ADS 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. ADS Platform 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." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SyncSubmitModel" - } - ], - "description": "A SyncSubmitModel represents a task that loads data from a connector to load into the ADS 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 ADS 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. ADS Platform 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." - } + "name": "order", + "in": "query", + "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageNumber", + "in": "query", + "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "schema": { + "type": "integer", + "format": "int32" } } - }, + ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SyncRequestModel" + "$ref": "#/components/schemas/UserRoleModelFetchResult" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/SyncRequestModel" + "$ref": "#/components/schemas/UserRoleModelFetchResult" } } } }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } + "401": { + "description": "Unauthorized" }, - "429": { - "description": "Too Many Requests", + "403": { + "description": "Forbidden" + } + }, + "security": [ + { + "oauth2": [ ] + }, + { + "bearer_token": [ ] + }, + { + "api_key": [ ] + } + ] + } + }, + "/api/v1/WebhookRules/{id}": { + "get": { + "tags": [ + "WebhookRules" + ], + "summary": "Retrieve Webhook Rule", + "description": "Retrieves the Webhook Rule specified by this unique identifier.\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.", + "operationId": "v1_WebhookRules_RetrieveWebhookRule", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The unique Accounting Data Service ID number of this Webhook Rule", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/WebhookRuleModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/WebhookRuleModel" } } } }, - "default": { - "description": "Error", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -16077,95 +15782,76 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - } - }, - "/api/v1/Sync/batch": { - "post": { + }, + "patch": { "tags": [ - "Sync" + "WebhookRules" + ], + "summary": "Update Webhook Rule", + "description": "Updates a webhook rule 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.\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.", + "operationId": "v1_WebhookRules_UpdateWebhookRule", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The unique Accounting Data Service ID number of the Webhook Rule to update.", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } ], - "summary": "Create Batch Import", - "description": "Creates a new batch import Sync task that imports all the models provided to this API call.\r\n\r\nA Sync task represents ingestion of data from a source. For each data model in the source, the Sync process will determine whether the data is new, updated, or unchanged from data that already exists within the ADS Platform. For records that are new, the Sync process will add them to the ADS Platform data. For records that are updated, the Sync process will update existing data to match the newly uploaded records. If records have not changed, no action will be taken.\r\n\r\nYou can use this Batch Import process to load data in bulk directly into the ADS 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.", - "operationId": "v1_Sync_CreateBatchImport", "requestBody": { - "description": "Information about the Sync to execute", + "description": "A list of changes to apply to this Webhook Rule", "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/BatchSyncModel" - } - ], - "description": "A BatchSyncModel contains a collection of records to load into the ADS Platform. Data contained\r\nin this batch will be merged with your existing data. Each record will be matched with existing data inside\r\nthe ADS Platform using the [Identity Column](https://developer.lockstep.io/docs/identity-columns) rules.\r\nAny record that represents a new AppEnrollmentId+ErpKey will be inserted. A record that matches an existing\r\nAppEnrollmentId+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. ADS 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." + "type": "object", + "additionalProperties": { } } }, "text/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/BatchSyncModel" - } - ], - "description": "A BatchSyncModel contains a collection of records to load into the ADS Platform. Data contained\r\nin this batch will be merged with your existing data. Each record will be matched with existing data inside\r\nthe ADS Platform using the [Identity Column](https://developer.lockstep.io/docs/identity-columns) rules.\r\nAny record that represents a new AppEnrollmentId+ErpKey will be inserted. A record that matches an existing\r\nAppEnrollmentId+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. ADS 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." + "type": "object", + "additionalProperties": { } } }, "application/*+json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/BatchSyncModel" - } - ], - "description": "A BatchSyncModel contains a collection of records to load into the ADS Platform. Data contained\r\nin this batch will be merged with your existing data. Each record will be matched with existing data inside\r\nthe ADS Platform using the [Identity Column](https://developer.lockstep.io/docs/identity-columns) rules.\r\nAny record that represents a new AppEnrollmentId+ErpKey will be inserted. A record that matches an existing\r\nAppEnrollmentId+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. ADS 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." + "type": "object", + "additionalProperties": { } } } } }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SyncRequestModel" + "$ref": "#/components/schemas/WebhookRuleModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/SyncRequestModel" + "$ref": "#/components/schemas/WebhookRuleModel" } } } }, "400": { "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } - }, - "429": { - "description": "Too Many Requests", "content": { "application/json": { "schema": { @@ -16179,8 +15865,8 @@ } } }, - "default": { - "description": "Error", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -16203,89 +15889,118 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - } - }, - "/api/v1/Sync/zip": { - "post": { + }, + "delete": { "tags": [ - "Sync" + "WebhookRules" ], - "summary": "Upload Sync File", - "description": "Requests a new Sync task from a ZIP file you provide. This ZIP file can contain one or more files with data from the customer's platform. Individual files can be in the format CSV or JSONL (JSON with Lines).\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.", - "operationId": "v1_Sync_CreateZipSync", + "summary": "Delete Webhook Rule", + "description": "Deletes the Webhook Rule referred to by this unique identifier.\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.", + "operationId": "v1_WebhookRules_DeleteWebhookRule", "parameters": [ { - "name": "appEnrollmentId", - "in": "query", - "description": "The optional existing app enrollment to associate with the data in the zip file.", + "name": "id", + "in": "path", + "description": "The unique Accounting Data Service ID number of the Webhook Rule to delete.", + "required": true, "schema": { "type": "string", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActionResultModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ActionResultModel" + } + } + } }, - { - "name": "parentSyncRequestId", - "in": "query", - "description": "The optional existing sync request id to associate with the batch data in the zip file.", - "schema": { - "type": "string", - "format": "uuid" + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + }, + "security": [ { - "name": "currentBatch", - "in": "query", - "description": "The optional current batch no associate with the batch data in the zip file.", - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } + "oauth2": [ ] }, { - "name": "totalBatches", - "in": "query", - "description": "The optional total batches to associate with the total batch data in the zip file.", - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } + "bearer_token": [ ] }, { - "name": "isFullSync", - "in": "query", - "description": "True if this is a full sync, false if this is a partial sync. Defaults to false.", - "schema": { - "type": "boolean", - "default": false - } + "api_key": [ ] } + ] + } + }, + "/api/v1/WebhookRules": { + "post": { + "tags": [ + "WebhookRules" ], + "summary": "Create Webhook Rules", + "description": "Creates one or more webhook rules from a given model.\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.", + "operationId": "v1_WebhookRules_CreateWebhookRules", "requestBody": { + "description": "The Webhook Rules to create", "content": { - "multipart/form-data": { + "application/json": { "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary" - } + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookRuleModel" } - }, - "encoding": { - "file": { - "style": "form" + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookRuleModel" + } + } + }, + "application/*+json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookRuleModel" } } } @@ -16293,16 +16008,22 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SyncRequestModel" + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookRuleModel" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/SyncRequestModel" + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookRuleModel" + } } } } @@ -16313,34 +16034,163 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } }, - "429": { - "description": "Too Many Requests", + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + }, + "security": [ + { + "oauth2": [ ] + }, + { + "bearer_token": [ ] + }, + { + "api_key": [ ] + } + ] + } + }, + "/api/v1/WebhookRules/query": { + "get": { + "tags": [ + "WebhookRules" + ], + "summary": "Query Webhook Rules", + "description": "Queries Webhook Rules for this account using the specified filtering, sorting, 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 Accounting Data Service 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.", + "operationId": "v1_WebhookRules_QueryWebhookRules", + "parameters": [ + { + "name": "filter", + "in": "query", + "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "schema": { + "type": "string" + } + }, + { + "name": "include", + "in": "query", + "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", + "schema": { + "type": "string" + } + }, + { + "name": "order", + "in": "query", + "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageNumber", + "in": "query", + "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/WebhookRuleModelFetchResult" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/WebhookRuleModelFetchResult" } } } }, - "default": { - "description": "Error", + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + }, + "security": [ + { + "oauth2": [ ] + }, + { + "bearer_token": [ ] + }, + { + "api_key": [ ] + } + ] + } + }, + "/api/v1/Webhooks/{id}": { + "get": { + "tags": [ + "Webhooks" + ], + "summary": "Retrieve Webhook", + "description": "Retrieves the Webhook specified by this unique identifier.\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.", + "operationId": "v1_Webhooks_RetrieveWebhook", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The unique Accounting Data Service ID number of this Webhook", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WebhookModel" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/WebhookModel" + } + } + } + }, + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -16363,30 +16213,28 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - } - }, - "/api/v1/Sync/{id}": { + }, "patch": { "tags": [ - "Sync" + "Webhooks" ], - "summary": "Update Sync", - "description": "Updates an existing Sync with the information supplied to this PATCH call.\r\n\r\nThis API is restricted to internal service users and may not be called by customers or partners.\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. For example, you can provide the field name \"IsActive\" and specify the new value \"False\"; this API will then change the value of IsActive to false.\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.", - "operationId": "v1_Sync_UpdateSync", + "summary": "Update Webhook", + "description": "Updates a webhook 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.\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.", + "operationId": "v1_Webhooks_UpdateWebhook", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ID number of the Sync to update", + "description": "The unique Accounting Data Service ID number of the Webhook to update.", "required": true, "schema": { "type": "string", @@ -16395,40 +16243,40 @@ } ], "requestBody": { - "description": "A list of changes to apply to this Application", + "description": "A list of changes to apply to this Webhook", "content": { "application/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { } } } } }, "responses": { - "200": { - "description": "Success", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SyncRequestModel" + "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/SyncRequestModel" + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -16438,27 +16286,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "object", + "additionalProperties": { } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "object", + "additionalProperties": { } } } } }, - "405": { - "description": "Method Not Allowed", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/WebhookModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/WebhookModel" } } } @@ -16472,56 +16322,47 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] }, - "get": { + "delete": { "tags": [ - "Sync" + "Webhooks" ], - "summary": "Retrieve Sync", - "description": "Retrieves the status and information about a Sync operation by the requested ID. Provides status and progress information about this 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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", - "operationId": "v1_Sync_RetrieveSyncRequest", + "summary": "Delete Webhook", + "description": "Deletes the Webhook referred to by this unique identifier.\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.", + "operationId": "v1_Webhooks_DeleteWebhook", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ID number of the Sync task to retrieve", + "description": "The unique Accounting Data Service ID number of the Webhook to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "include", - "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Details", - "schema": { - "type": "string", - "default": "" - } } ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SyncRequestModel" + "$ref": "#/components/schemas/ActionResultModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/SyncRequestModel" + "$ref": "#/components/schemas/ActionResultModel" } } } @@ -16550,28 +16391,126 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - }, - "delete": { + } + }, + "/api/v1/Webhooks": { + "post": { "tags": [ - "Sync" + "Webhooks" ], - "summary": "Cancel Sync", - "description": "Cancels a Sync process for an Application if the request is still being processed within the Application. This does not cancel Sync processes which have already proceeded to completion within the Application, or Sync processes outside of Applications such as from a Zip file or Batch Import.\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.", - "operationId": "v1_Sync_CancelSync", + "summary": "Create Webhooks", + "description": "Creates one or more webhooks from a given model.\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.", + "operationId": "v1_Webhooks_CreateWebhooks", + "requestBody": { + "description": "The Webhooks to create", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookModel" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookModel" + } + } + }, + "application/*+json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookModel" + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookModel" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { } + } + }, + "text/json": { + "schema": { + "type": "object", + "additionalProperties": { } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + }, + "security": [ + { + "oauth2": [ ] + }, + { + "bearer_token": [ ] + }, + { + "api_key": [ ] + } + ] + } + }, + "/api/v1/Webhooks/{id}/regenerate-client-secret": { + "patch": { + "tags": [ + "Webhooks" + ], + "summary": "Regenerate Client Secret", + "description": "Updates a webhook that matches the specified id with a new client secret.\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.", + "operationId": "v1_Webhooks_RegenerateClientSecret", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ID number of the Sync task to cancel", + "description": "The unique Accounting Data Service ID number of the Webhook to update.", "required": true, "schema": { "type": "string", @@ -16580,34 +16519,32 @@ } ], "responses": { - "200": { - "description": "Success", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SyncRequestModel" + "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/SyncRequestModel" + "$ref": "#/components/schemas/ProblemDetails" } } } }, - "400": { - "description": "Bad Request", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "type": "object", - "additionalProperties": {} + "$ref": "#/components/schemas/WebhookModel" } }, "text/json": { "schema": { - "type": "object", - "additionalProperties": {} + "$ref": "#/components/schemas/WebhookModel" } } } @@ -16621,25 +16558,25 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Sync/query": { + "/api/v1/Webhooks/query": { "get": { "tags": [ - "Sync" + "Webhooks" ], - "summary": "Query Syncs", - "description": "Queries Sync tasks 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 ADS Platform Developer website.\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* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", - "operationId": "v1_Sync_QuerySyncs", + "summary": "Query Webhooks", + "description": "Queries Webhooks for this account using the specified filtering, sorting, 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 Accounting Data Service 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.", + "operationId": "v1_Webhooks_QueryWebhooks", "parameters": [ { "name": "filter", @@ -16652,7 +16589,7 @@ { "name": "include", "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Details", + "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collection: WebhookRules", "schema": { "type": "string" } @@ -16660,7 +16597,7 @@ { "name": "order", "in": "query", - "description": "The sort order for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { "type": "string" } @@ -16682,44 +16619,20 @@ "type": "integer", "format": "int32" } - }, - { - "name": "operationType", - "in": "query", - "description": "The type of Sync requests to query, defaults to Read.", - "schema": { - "type": "string", - "default": "Read" - } } ], "responses": { "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SyncRequestModelFetchResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/SyncRequestModelFetchResult" - } - } - } - }, - "400": { - "description": "Bad Request", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/WebhookModelFetchResult" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/WebhookModelFetchResult" } } } @@ -16733,30 +16646,30 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Sync/{id}/manifest": { - "post": { + "/api/v1/Webhooks/{webhookId}/history/query": { + "get": { "tags": [ - "Sync" + "Webhooks" ], - "summary": "Create Manifest", - "description": "\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.", - "operationId": "v1_Sync_GenerateManifest", + "summary": "Query Webhook History", + "description": "\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.", + "operationId": "v1_Webhooks_QueryWebhookHistory", "parameters": [ { - "name": "id", + "name": "webhookId", "in": "path", - "description": "The unique ID number of the Sync task to create manifest", + "description": "The unique Accounting Data Service ID number of this Webhook", "required": true, "schema": { "type": "string", @@ -16764,115 +16677,25 @@ } }, { - "name": "appEnrollmentId", - "in": "header", - "description": "The unique ID number of application", + "name": "include", + "in": "query", + "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collection: Records, RequestMessage, ResponseMessage", "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "description": "manifestTaskModel", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/InboundSyncReportDataJsonApiDataModel" - } - ], - "description": "Standard Json API data model.\r\nhttps://jsonapi.org/" - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/InboundSyncReportDataJsonApiDataModel" - } - ], - "description": "Standard Json API data model.\r\nhttps://jsonapi.org/" - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/InboundSyncReportDataJsonApiDataModel" - } - ], - "description": "Standard Json API data model.\r\nhttps://jsonapi.org/" - } + "type": "string" } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ManifestResponseModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ManifestResponseModel" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/Transactions/query": { - "get": { - "tags": [ - "Transactions" - ], - "summary": "Query Transactions", - "description": "Queries transactions (invoices/credit memos/payments) 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 ADS Platform 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.", - "operationId": "v1_Transactions_Query", - "parameters": [ - { - "name": "filter", - "in": "query", - "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "include", - "in": "query", - "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", - "schema": { - "type": "string" + }, + { + "name": "filter", + "in": "query", + "description": "The filter for this query.\r\n \r\nSee [Azure Query Language](https://docs.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities)", + "schema": { + "type": "string" } }, { - "name": "order", + "name": "select", "in": "query", - "description": "The sort order for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "description": "The selection for this query. Selection is the desired properties of an entity to pull from the set.\r\nIf a property is not selected, it will either return as null or empty.\r\n \r\nSee [Azure Query Language](https://docs.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities)", "schema": { "type": "string" } @@ -16880,7 +16703,7 @@ { "name": "pageSize", "in": "query", - "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "description": "The page size for results (default 250, maximum of 500).", "schema": { "type": "integer", "format": "int32" @@ -16889,43 +16712,25 @@ { "name": "pageNumber", "in": "query", - "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "description": "The page number for results (default 0).", "schema": { "type": "integer", "format": "int32" } - }, - { - "name": "currentDate", - "in": "query", - "description": "The date the days past due value will be calculated against. If no currentDate is provided the current UTC date will be used.", - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "legacy", - "in": "query", - "description": "Generates query data based on legacy approach of executing SQL view queries.", - "schema": { - "type": "boolean", - "default": false - } } ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TransactionModelTransactionSummaryTotalModelSummaryFetchResult" + "$ref": "#/components/schemas/WebhookHistoryTableStorageModelFetchResult" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TransactionModelTransactionSummaryTotalModelSummaryFetchResult" + "$ref": "#/components/schemas/WebhookHistoryTableStorageModelFetchResult" } } } @@ -16939,126 +16744,65 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Transactions/{id}/details": { + "/api/v1/Webhooks/{webhookId}/history/{webhookHistoryId}/retry": { "get": { "tags": [ - "Transactions" + "Webhooks" ], - "summary": "Retrieve Transaction Details", - "description": "Retrieves a list of transaction details for the supplied transaction id.\r\n\r\nA Transaction Detail contains information about the associated Transaction. This information can be an invoice associated to a payment or credit memo or a payment or credit memo used as payment for one or more invoices.\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.", - "operationId": "v1_Transactions_RetrieveTransactionDetails", + "summary": "Retry Failed Webhook History", + "description": "\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.", + "operationId": "v1_Webhooks_RetryWebhookHistory", "parameters": [ { - "name": "id", + "name": "webhookId", "in": "path", - "description": "", + "description": "The unique Accounting Data Service ID number of this Webhook", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TransactionDetailModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TransactionDetailModel" - } - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] }, { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/Transcriptions/validate/{id}": { - "get": { - "tags": [ - "Transcriptions" - ], - "summary": "Retrieve Transcription Validation Request", - "description": "Retrieves the Transcription Validation Request specified by this unique identifier, optionally including nested data sets.\r\n\r\nA Transcription Validation Request represents a collection of files sent from the client to verify the file type using the machine learning platform Sage AI.\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.", - "operationId": "v1_Transcriptions_RetrieveTranscriptionValidationRequest", - "parameters": [ - { - "name": "id", + "name": "webhookHistoryId", "in": "path", - "description": "The unique ADS Platform ID number of the transcription validation request", + "description": "The unique Accounting Data Service ID number of the Webhook History to be retried.\r\nNote: the webhook history supplied must have a isSuccessful status of false to be retried.", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "include", - "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Items", - "schema": { - "type": "string", - "default": "" - } } ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TranscriptionValidationRequestModel" + "type": "string" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TranscriptionValidationRequestModel" + "type": "string" } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -17072,83 +16816,6 @@ } } }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - }, - "patch": { - "tags": [ - "Transcriptions" - ], - "summary": "Update Transcription Validation Request", - "description": "Updates an existing Transcription Validation Request with the information supplied to this PATCH call.\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 Transcription Validation Request represents a collection of files sent from the client to verify the file type using the machine learning platform Sage AI.\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.", - "operationId": "v1_Transcriptions_UpdateTranscriptionValidationRequest", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of the Transcription Validation Request to update", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "description": "A list of changes to apply to this Transcription Validation Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "application/*+json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TranscriptionValidationRequestModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/TranscriptionValidationRequestModel" - } - } - } - }, "400": { "description": "Bad Request", "content": { @@ -17173,53 +16840,64 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] - }, - "delete": { + } + }, + "/api/v1/workflow-statuses/{id}": { + "get": { "tags": [ - "Transcriptions" + "WorkflowStatuses" ], - "summary": "Delete Transcription Validation Request", - "description": "Deletes the Transcription Validation Request and all associated items referred to by this unique identifier.\r\n\r\nA Transcription Validation Request represents a collection of files sent from the client to verify the file type using the machine learning platform Sage AI.\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.", - "operationId": "v1_Transcriptions_DeleteTranscriptionValidationRequest", + "summary": "Retrieve Workflow Status", + "description": "Retrieves the Workflow Status specified by this unique identifier.\r\n\r\nA Workflow Status represents the state for a specific workflow for an entity. A Workflow Status may be generic for common use cases or specific to a set of predefined statuses.\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.", + "operationId": "v1_WorkflowStatuses_RetrieveWorkflowStatus", "parameters": [ { "name": "id", "in": "path", - "description": "The unique ADS Platform ID number of the transcription validation request to delete", + "description": "The unique ID number of the Workflow Status to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "include", + "in": "query", + "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Children, Parents", + "schema": { + "type": "string", + "default": "" + } } ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteResult" + "$ref": "#/components/schemas/WorkflowStatusModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/DeleteResult" + "$ref": "#/components/schemas/WorkflowStatusModel" } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -17242,33 +16920,33 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Transcriptions/validate": { + "/api/v1/workflow-statuses": { "post": { "tags": [ - "Transcriptions" + "WorkflowStatuses" ], - "summary": "Create Transcription Validation Request", - "description": "Creates one Transcription Validation Request with all the associated request items within this account and returns the record as created.\r\n\r\nA Transcription Validation Request represents a collection of files sent from the client to verify the file type using the machine learning platform Sage AI.\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.", - "operationId": "v1_Transcriptions_CreateTranscriptionValidationRequest", + "summary": "Create Workflow Statuses", + "description": "Creates one or more Workflow Statuses from a given model.\r\n\r\nCustom WorkflowStatuses will not be supported in the future. Please use predefined WorkflowStatuses.\r\n\r\nA Workflow Status represents the state for a specific workflow for an entity. A Workflow Status may be generic for common use cases or specific to a set of predefined statuses.\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.", + "operationId": "v1_WorkflowStatuses_CreateWorkflowStatuses", "requestBody": { - "description": "The files which will be verified", + "description": "The Workflow Statuses to create", "content": { "application/json": { "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/TranscriptionRequestSubmit" + "$ref": "#/components/schemas/WorkflowStatusModel" } } }, @@ -17276,7 +16954,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/TranscriptionRequestSubmit" + "$ref": "#/components/schemas/WorkflowStatusModel" } } }, @@ -17284,7 +16962,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/TranscriptionRequestSubmit" + "$ref": "#/components/schemas/WorkflowStatusModel" } } } @@ -17292,16 +16970,22 @@ }, "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TranscriptionValidationRequestModel" + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStatusModel" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TranscriptionValidationRequestModel" + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStatusModel" + } } } } @@ -17311,12 +16995,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/WorkflowStatusModel" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/WorkflowStatusModel" } } } @@ -17328,27 +17012,28 @@ "description": "Forbidden" } }, + "deprecated": true, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } }, - "/api/v1/Transcriptions/validate/query": { + "/api/v1/workflow-statuses/query": { "get": { "tags": [ - "Transcriptions" + "WorkflowStatuses" ], - "summary": "Query Transcription Validation Requests", - "description": "Queries transcription validation requests transactions 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 ADS Platform 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.", - "operationId": "v1_Transcriptions_QueryTranscriptionValidationRequests", + "summary": "Query Workflow Statuses", + "description": "Queries Workflow Statuses 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 Accounting Data Services Developer website.\r\n\r\nA Workflow Status represents the state for a specific workflow for an entity. A Workflow Status may be generic for common use cases or specific to a set of predefined statuses.\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.", + "operationId": "v1_WorkflowStatuses_QueryWorkflowStatuses", "parameters": [ { "name": "filter", @@ -17358,18 +17043,10 @@ "type": "string" } }, - { - "name": "include", - "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Items", - "schema": { - "type": "string" - } - }, { "name": "order", "in": "query", - "description": "The sort order for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", + "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", "schema": { "type": "string" } @@ -17395,16 +17072,16 @@ ], "responses": { "200": { - "description": "Success", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TranscriptionValidationRequestModelFetchResult" + "$ref": "#/components/schemas/WorkflowStatusModelFetchResult" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TranscriptionValidationRequestModelFetchResult" + "$ref": "#/components/schemas/WorkflowStatusModelFetchResult" } } } @@ -17418,5071 +17095,253 @@ }, "security": [ { - "oauth2": [] + "oauth2": [ ] }, { - "bearer_token": [] + "bearer_token": [ ] }, { - "api_key": [] + "api_key": [ ] } ] } - }, - "/api/v1/Transcriptions/validation-items": { - "post": { - "tags": [ - "Transcriptions" - ], - "summary": "Creates a TranscriptionValidationRequestItemModel", - "description": "Retrieves the TranscriptionValidationRequestItemModel specified by this unique identifier.\r\n\r\nA TranscriptionValidationRequestItemModel represents a file sent from the client to verify the file type using the machine learning platform Sage AI.\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.", - "operationId": "v1_Transcriptions_CreateRequestItem", - "requestBody": { - "description": "The TranscriptionValidationRequestItemModels to add to an existing TranscriptionValidationRequestItemModel", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranscriptionRequestSubmit" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranscriptionRequestSubmit" - } - } + } + }, + "components": { + "schemas": { + "AccountAuthorisation": { + "type": "object", + "properties": { + "activationLink": { + "type": "string", + "description": "A URL that can be used to complete account activation at the servicer.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Optional information that can be used to complete account activation at the servicer." + }, + "ActionResult": { + "type": "object", + "additionalProperties": false + }, + "ActionResultModel": { + "type": "object", + "properties": { + "messages": { + "type": "array", + "items": { + "type": "string" }, - "application/*+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranscriptionRequestSubmit" - } - } - } + "description": "If the API call produced messages, this element will contain a list of user-visible\r\ntext strings that contain information about what work occurred in the API.", + "nullable": true } }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranscriptionValidationRequestItemModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranscriptionValidationRequestItemModel" - } - } - } - } + "additionalProperties": false, + "description": "Represents the result of an action.\r\n \r\nIn the Accounting Data Service 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." + }, + "Address": { + "type": "object", + "properties": { + "addressLine1": { + "type": "string", + "description": "Address line 1.", + "nullable": true }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } + "addressLine2": { + "type": "string", + "description": "Address line 2.", + "nullable": true }, - "401": { - "description": "Unauthorized" + "addressLine3": { + "type": "string", + "description": "Address line 3.", + "nullable": true }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] + "addressLine4": { + "type": "string", + "description": "Address line 4.", + "nullable": true }, - { - "bearer_token": [] + "countrySubdivision": { + "type": "string", + "description": "Subdivision of a country. For example, state, county, or region.", + "nullable": true }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/Transcriptions/validation-items/{id}": { - "get": { - "tags": [ - "Transcriptions" - ], - "summary": "Retrieve a TranscriptionValidationRequestItemModel", - "description": "Retrieves the TranscriptionValidationRequestItemModel specified by this unique identifier.\r\n\r\nA TranscriptionValidationRequestItemModel represents a file sent from the client to verify the file type using the machine learning platform Sage AI.\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.", - "operationId": "v1_Transcriptions_RetrieveTranscriptionValidationRequestItem", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of the TranscriptionValidationRequestItemModel", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } + "postalCode": { + "type": "string", + "description": "Postal/zip code.", + "nullable": true + }, + "country": { + "type": "string", + "description": "Country in the ISO 3166-1 Alpha-3 format.", + "nullable": true } + }, + "additionalProperties": false, + "description": "Address object." + }, + "AgingBucket": { + "enum": [ + 0, + 1, + 2, + 3, + 4 ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TranscriptionValidationRequestItemModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/TranscriptionValidationRequestItemModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } + "type": "integer", + "description": "The different buckets used for aging.", + "format": "int32" + }, + "AgingBucketResult": { + "type": "object", + "properties": { + "bucket": { + "allOf": [ + { + "$ref": "#/components/schemas/AgingBucket" } - } - }, - "401": { - "description": "Unauthorized" + ], + "description": "The different buckets used for aging." }, - "403": { - "description": "Forbidden" + "value": { + "type": "number", + "description": "The outstanding amount for the given bucket in the group's base currency.", + "format": "double" } }, - "security": [ - { - "oauth2": [] + "additionalProperties": false, + "description": "The aging data for an individual bucket" + }, + "AgingModel": { + "type": "object", + "properties": { + "groupKey": { + "type": "string", + "description": "The Group Key the aging data is calculated for.", + "format": "uuid" }, - { - "bearer_token": [] + "total": { + "type": "number", + "description": "The total AR outstanding amount in the group's base currency.", + "format": "double" }, - { - "api_key": [] + "buckets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgingBucketResult" + }, + "description": "The outstanding amount in the group's base currency, grouped by days overdue.", + "nullable": true } - ] + }, + "additionalProperties": false, + "description": "A summary of AR Aging for a given Group Key. This aging data is presented\r\nin buckets of days overdue in the group's base currency." }, - "patch": { - "tags": [ - "Transcriptions" - ], - "summary": "Update a TranscriptionValidationRequestItemModel", - "description": "Updates the TranscriptionValidationRequestItemModel specified by this unique identifier.\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 TranscriptionValidationRequestItemModel represents a file sent from the client to verify the file type using the machine learning platform Sage AI.\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.", - "operationId": "v1_Transcriptions_UpdateTranscriptionValidationRequestItem", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of the TranscriptionValidationRequestItemModel", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "description": "A list of changes to apply to this TranscriptionValidationRequestItemModel", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "application/*+json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TranscriptionValidationRequestItemModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/TranscriptionValidationRequestItemModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - }, - "delete": { - "tags": [ - "Transcriptions" - ], - "summary": "Delete a TranscriptionValidationRequestItemModel", - "description": "Deletes the TranscriptionValidationRequestItemModel specified by this unique identifier.\r\n\r\nA TranscriptionValidationRequestItemModel represents a file sent from the client to verify the file type using the machine learning platform Sage AI.\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.", - "operationId": "v1_Transcriptions_DeleteTranscriptionValidationRequestItem", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of the TranscriptionValidationRequestItemModel", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeleteResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/DeleteResult" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/Transcriptions/validation-items/query": { - "get": { - "tags": [ - "Transcriptions" - ], - "summary": "Query Transcription Validation Request Items", - "description": "Queries TranscriptionValidationRequestItemModels 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 ADS Platform 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.", - "operationId": "v1_Transcriptions_QueryTranscriptionValidationRequestItems", - "parameters": [ - { - "name": "filter", - "in": "query", - "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "include", - "in": "query", - "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 ///", - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "The sort order for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "in": "query", - "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageNumber", - "in": "query", - "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TranscriptionValidationRequestItemModelFetchResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/TranscriptionValidationRequestItemModelFetchResult" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/Transcriptions/email-reply-suggestions": { - "post": { - "tags": [ - "Transcriptions" - ], - "summary": "Retrieve an EmailReplyGeneratorResponse", - "description": "Retrieves the Email Reply Generator Response containing a list of email reply suggestions\r\n\r\nAn Email Reply Generator Request represents an email to be sent for a list of email reply suggestions.\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.", - "operationId": "v1_Transcriptions_GetEmailReplySuggestions", - "requestBody": { - "description": "The Email Reply Generator Request to be sent", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/EmailReplyGeneratorRequest" - } - ], - "description": "Represents the request to the SAGE GMS API" - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/EmailReplyGeneratorRequest" - } - ], - "description": "Represents the request to the SAGE GMS API" - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/EmailReplyGeneratorRequest" - } - ], - "description": "Represents the request to the SAGE GMS API" - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EmailReplyGeneratorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/EmailReplyGeneratorResponse" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/UserAccounts/{id}": { - "get": { - "tags": [ - "UserAccounts" - ], - "summary": "Retrieve User", - "description": "Retrieves the User with this identifier.\r\n\r\nA User represents a person who has the ability to authenticate against the ADS Platform and use services such as ADS 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 ADS Platform services. Users may have different privileges and access control rights within the ADS 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.", - "operationId": "v1_UserAccounts_RetrieveUser", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ID number of the User to retrieve", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "include", - "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Notes, Attachments, CustomFields, AccountingRole", - "schema": { - "type": "string", - "default": "" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserAccountModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/UserAccountModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - }, - "patch": { - "tags": [ - "UserAccounts" - ], - "summary": "Update User", - "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\nOnly Group Owners and Admins can change other users.When updating another user, only the role and status can be updated.A user can only change their own status when their current status is Onboarding.A user can never change their own role.Nobody can change the owner's role or status. See the \"/transfer-owner\" route for changing the owner.A user can change their own personal 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 ADS Platform and use services such as ADS 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 ADS Platform services. Users may have different privileges and access control rights within the ADS 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.", - "operationId": "v1_UserAccounts_UpdateUser", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ID number of the User to retrieve", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "description": "A list of changes to apply to this User", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "application/*+json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } - }, - "responses": { - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } - }, - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserAccountModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/UserAccountModel" - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - } - }, - "deprecated": true, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - }, - "delete": { - "tags": [ - "UserAccounts" - ], - "summary": "Disable User", - "description": "Disable the user referred to by this unique identifier.\r\n\r\nA User represents a person who has the ability to authenticate against the ADS Platform and use services such as ADS 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 ADS Platform services. Users may have different privileges and access control rights within the ADS Platform.\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.", - "operationId": "v1_UserAccounts_DisableUser", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of this User", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActionResultModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ActionResultModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/UserAccounts/reenable": { - "post": { - "tags": [ - "UserAccounts" - ], - "summary": "Reenable User", - "description": "This route is obsolete, please use the /UserAccounts/invite to reenable a disabled user.\r\n\r\nReenable the user referred to by this unique identifier.\r\n\r\nA User represents a person who has the ability to authenticate against the ADS Platform and use services such as ADS 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 ADS Platform services. Users may have different privileges and access control rights within the ADS Platform.\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.", - "operationId": "v1_UserAccounts_ReenableUser", - "parameters": [ - { - "name": "id", - "in": "query", - "description": "The unique ADS Platform ID number of this User", - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActionResultModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ActionResultModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/UserAccounts/invite": { - "post": { - "tags": [ - "UserAccounts" - ], - "summary": "Invite User", - "description": "Invite a user with the specified email to join your accounting group. The user will receive an email to set up their account.\r\n\r\nA User represents a person who has the ability to authenticate against the ADS Platform and use services such as ADS 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 ADS Platform services. Users may have different privileges and access control rights within the ADS Platform.\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.", - "operationId": "v1_UserAccounts_InviteUser", - "requestBody": { - "description": "The user to invite", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InviteSubmitModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InviteSubmitModel" - } - } - }, - "application/*+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InviteSubmitModel" - } - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InviteModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InviteModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - }, - "get": { - "tags": [ - "UserAccounts" - ], - "summary": "Retrieve Invite Data", - "description": "Retrieves invite information for the specified invite token.\r\n\r\nA User represents a person who has the ability to authenticate against the ADS Platform and use services such as ADS 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 ADS Platform services. Users may have different privileges and access control rights within the ADS Platform.", - "operationId": "v1_UserAccounts_RetrieveInviteData", - "parameters": [ - { - "name": "code", - "in": "query", - "description": "The code of the invite", - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InviteDataModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InviteDataModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - }, - "deprecated": true - } - }, - "/api/v1/UserAccounts/transfer-owner": { - "post": { - "tags": [ - "UserAccounts" - ], - "summary": "Transfer Owner", - "description": "Transfer the ownership of a group to another user. This API must be called by the current owner of the group.\r\n\r\nA User represents a person who has the ability to authenticate against the ADS Platform and use services such as ADS 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 ADS Platform services. Users may have different privileges and access control rights within the ADS Platform.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.", - "operationId": "v1_UserAccounts_TransferOwner", - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/TransferOwnerSubmitModel" - } - ], - "description": "Model used to submit a transfer ownership request" - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/TransferOwnerSubmitModel" - } - ], - "description": "Model used to submit a transfer ownership request" - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/TransferOwnerSubmitModel" - } - ], - "description": "Model used to submit a transfer ownership request" - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TransferOwnerModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/TransferOwnerModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/UserAccounts/query": { - "get": { - "tags": [ - "UserAccounts" - ], - "summary": "Query Users", - "description": "Queries Users for this account using the specified filtering, sorting, nested fetch, and pagination rules requested. A User represents a person who has the ability to authenticate against the ADS Platform and use services such as ADS 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 ADS Platform services. Users may have different privileges and access control rights within the ADS 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.", - "operationId": "v1_UserAccounts_QueryUsers", - "parameters": [ - { - "name": "filter", - "in": "query", - "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "include", - "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Notes, Attachments, CustomFields, AccountingRole", - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "in": "query", - "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageNumber", - "in": "query", - "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserAccountModelFetchResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/UserAccountModelFetchResult" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/UserAccounts/change-group": { - "post": { - "tags": [ - "UserAccounts" - ], - "summary": "Change User Group", - "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 ADS Platform and use services such as ADS 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 ADS Platform services. Users may have different privileges and access control rights within the ADS Platform.", - "operationId": "v1_UserAccounts_ChangeUserGroup", - "parameters": [ - { - "name": "groupKey", - "in": "query", - "description": "", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserAccountModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/UserAccountModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/UserAccounts/user-data": { - "get": { - "tags": [ - "UserAccounts" - ], - "summary": "Get User Data", - "description": "Retrieves the user data for the current user. This allows for retrieving extended user data such as UTM parameters.", - "operationId": "v1_UserAccounts_GetUserData", - "parameters": [ - { - "name": "include", - "in": "query", - "description": "The set of data to retrieve. To avoid any casing confusion, these values are converted to upper case.\r\n Possible values are: UTM", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserDataResponseModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/UserDataResponseModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/UserAccounts/support-access": { - "post": { - "tags": [ - "UserAccounts" - ], - "summary": "Set Support Access", - "description": "Set support access for the calling user.\r\n\r\nSupport access allows ADS Platform 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\nProviding a `null` value for the `expiresAt` parameter will revoke support access.\r\n\r\nEvery call to this API will regenerate the support access code.", - "operationId": "v1_UserAccounts_SetSupportAccess", - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SupportAccessRequest" - } - ], - "description": "Sets support access data for a user." - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SupportAccessRequest" - } - ], - "description": "Sets support access data for a user." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SupportAccessRequest" - } - ], - "description": "Sets support access data for a user." - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportAccessModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/SupportAccessModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/UserRoles/{id}": { - "get": { - "tags": [ - "UserRoles" - ], - "summary": "Retrieve User Role", - "description": "Retrieves the User Role with this identifier.\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.", - "operationId": "v1_UserRoles_RetrieveUserRole", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ID number of the User Role to retrieve", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "include", - "in": "query", - "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", - "schema": { - "type": "string", - "default": "" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserRoleModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/UserRoleModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/UserRoles/query": { - "get": { - "tags": [ - "UserRoles" - ], - "summary": "Query User Roles", - "description": "Queries User Roles for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.\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.", - "operationId": "v1_UserRoles_QueryUserRoles", - "parameters": [ - { - "name": "filter", - "in": "query", - "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "include", - "in": "query", - "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", - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "in": "query", - "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageNumber", - "in": "query", - "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserRoleModelFetchResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/UserRoleModelFetchResult" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/WebhookRules/{id}": { - "get": { - "tags": [ - "WebhookRules" - ], - "summary": "Retrieve Webhook Rule", - "description": "Retrieves the Webhook Rule specified by this unique identifier.\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.", - "operationId": "v1_WebhookRules_RetrieveWebhookRule", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of this Webhook Rule", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebhookRuleModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WebhookRuleModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - }, - "patch": { - "tags": [ - "WebhookRules" - ], - "summary": "Update Webhook Rule", - "description": "Updates a webhook rule 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.\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.", - "operationId": "v1_WebhookRules_UpdateWebhookRule", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of the Webhook Rule to update.", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "description": "A list of changes to apply to this Webhook Rule", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "application/*+json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebhookRuleModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WebhookRuleModel" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - }, - "delete": { - "tags": [ - "WebhookRules" - ], - "summary": "Delete Webhook Rule", - "description": "Deletes the Webhook Rule referred to by this unique identifier.\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.", - "operationId": "v1_WebhookRules_DeleteWebhookRule", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of the Webhook Rule to delete.", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActionResultModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ActionResultModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/WebhookRules": { - "post": { - "tags": [ - "WebhookRules" - ], - "summary": "Create Webhook Rules", - "description": "Creates one or more webhook rules from a given model.\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.", - "operationId": "v1_WebhookRules_CreateWebhookRules", - "requestBody": { - "description": "The Webhook Rules to create", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookRuleModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookRuleModel" - } - } - }, - "application/*+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookRuleModel" - } - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookRuleModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookRuleModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/WebhookRules/query": { - "get": { - "tags": [ - "WebhookRules" - ], - "summary": "Query Webhook Rules", - "description": "Queries Webhook Rules for this account using the specified filtering, sorting, 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 ADS Platform 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.", - "operationId": "v1_WebhookRules_QueryWebhookRules", - "parameters": [ - { - "name": "filter", - "in": "query", - "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "include", - "in": "query", - "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", - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "in": "query", - "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageNumber", - "in": "query", - "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebhookRuleModelFetchResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WebhookRuleModelFetchResult" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/Webhooks/{id}": { - "get": { - "tags": [ - "Webhooks" - ], - "summary": "Retrieve Webhook", - "description": "Retrieves the Webhook specified by this unique identifier.\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.", - "operationId": "v1_Webhooks_RetrieveWebhook", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of this Webhook", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebhookModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WebhookModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - }, - "patch": { - "tags": [ - "Webhooks" - ], - "summary": "Update Webhook", - "description": "Updates a webhook 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.\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.", - "operationId": "v1_Webhooks_UpdateWebhook", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of the Webhook to update.", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "description": "A list of changes to apply to this Webhook", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "application/*+json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } - }, - "responses": { - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebhookModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WebhookModel" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - }, - "delete": { - "tags": [ - "Webhooks" - ], - "summary": "Delete Webhook", - "description": "Deletes the Webhook referred to by this unique identifier.\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.", - "operationId": "v1_Webhooks_DeleteWebhook", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of the Webhook to delete.", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActionResultModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ActionResultModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/Webhooks": { - "post": { - "tags": [ - "Webhooks" - ], - "summary": "Create Webhooks", - "description": "Creates one or more webhooks from a given model.\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.", - "operationId": "v1_Webhooks_CreateWebhooks", - "requestBody": { - "description": "The Webhooks to create", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookModel" - } - } - }, - "application/*+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookModel" - } - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/Webhooks/{id}/regenerateclientsecret": { - "patch": { - "tags": [ - "Webhooks" - ], - "summary": "Regenerate Client Secret", - "description": "This route is obsolete, please use the /{id}/regenerate-client-secret route instead.\r\n\r\nUpdates a webhook that matches the specified id with a new client secret.\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.", - "operationId": "v1_Webhooks_RegenerateClientSecretObs", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of the Webhook to update.", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebhookModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WebhookModel" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/Webhooks/{id}/regenerate-client-secret": { - "patch": { - "tags": [ - "Webhooks" - ], - "summary": "Regenerate Client Secret", - "description": "Updates a webhook that matches the specified id with a new client secret.\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.", - "operationId": "v1_Webhooks_RegenerateClientSecret", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ADS Platform ID number of the Webhook to update.", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebhookModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WebhookModel" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/Webhooks/query": { - "get": { - "tags": [ - "Webhooks" - ], - "summary": "Query Webhooks", - "description": "Queries Webhooks for this account using the specified filtering, sorting, 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 ADS Platform 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.", - "operationId": "v1_Webhooks_QueryWebhooks", - "parameters": [ - { - "name": "filter", - "in": "query", - "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "include", - "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collection: WebhookRules", - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "in": "query", - "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageNumber", - "in": "query", - "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebhookModelFetchResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WebhookModelFetchResult" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/Webhooks/{webhookId}/history/query": { - "get": { - "tags": [ - "Webhooks" - ], - "summary": "Query Webhook History", - "description": "\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.", - "operationId": "v1_Webhooks_QueryWebhookHistory", - "parameters": [ - { - "name": "webhookId", - "in": "path", - "description": "The unique ADS Platform ID number of this Webhook", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "include", - "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collection: Records, RequestMessage, ResponseMessage", - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "in": "query", - "description": "The filter for this query.\r\n \r\nSee [Azure Query Language](https://docs.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities)", - "schema": { - "type": "string" - } - }, - { - "name": "select", - "in": "query", - "description": "The selection for this query. Selection is the desired properties of an entity to pull from the set.\r\nIf a property is not selected, it will either return as null or empty.\r\n \r\nSee [Azure Query Language](https://docs.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities)", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "in": "query", - "description": "The page size for results (default 250, maximum of 500).", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageNumber", - "in": "query", - "description": "The page number for results (default 0).", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebhookHistoryTableStorageModelFetchResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WebhookHistoryTableStorageModelFetchResult" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/Webhooks/{webhookId}/history/{webhookHistoryId}/retry": { - "get": { - "tags": [ - "Webhooks" - ], - "summary": "Retry Failed Webhook History", - "description": "\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.", - "operationId": "v1_Webhooks_RetryWebhookHistory", - "parameters": [ - { - "name": "webhookId", - "in": "path", - "description": "The unique ADS Platform ID number of this Webhook", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "webhookHistoryId", - "in": "path", - "description": "The unique ADS Platform ID number of the Webhook History to be retried.\r\nNote: the webhook history supplied must have a isSuccessful status of false to be retried.", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "type": "string" - } - }, - "text/json": { - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/workflow-statuses/{id}": { - "get": { - "tags": [ - "WorkflowStatuses" - ], - "summary": "Retrieve Workflow Status", - "description": "Retrieves the Workflow Status specified by this unique identifier.\r\n\r\nA Workflow Status represents the state for a specific workflow for an entity. A Workflow Status may be generic for common use cases or specific to a set of predefined statuses.\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.", - "operationId": "v1_WorkflowStatuses_RetrieveWorkflowStatus", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The unique ID number of the Workflow Status to retrieve", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "include", - "in": "query", - "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n \r\nAvailable collections: Children, Parents", - "schema": { - "type": "string", - "default": "" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkflowStatusModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WorkflowStatusModel" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/workflow-statuses": { - "post": { - "tags": [ - "WorkflowStatuses" - ], - "summary": "Create Workflow Statuses", - "description": "Creates one or more Workflow Statuses from a given model.\r\n\r\nCustom WorkflowStatuses will not be supported in the future. Please use predefined WorkflowStatuses.\r\n\r\nA Workflow Status represents the state for a specific workflow for an entity. A Workflow Status may be generic for common use cases or specific to a set of predefined statuses.\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.", - "operationId": "v1_WorkflowStatuses_CreateWorkflowStatuses", - "requestBody": { - "description": "The Workflow Statuses to create", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkflowStatusModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkflowStatusModel" - } - } - }, - "application/*+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkflowStatusModel" - } - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkflowStatusModel" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkflowStatusModel" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkflowStatusModel" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WorkflowStatusModel" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - }, - "/api/v1/workflow-statuses/query": { - "get": { - "tags": [ - "WorkflowStatuses" - ], - "summary": "Query Workflow Statuses", - "description": "Queries Workflow Statuses 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 Accounting Data Services Developer website.\r\n\r\nA Workflow Status represents the state for a specific workflow for an entity. A Workflow Status may be generic for common use cases or specific to a set of predefined statuses.\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.", - "operationId": "v1_WorkflowStatuses_QueryWorkflowStatuses", - "parameters": [ - { - "name": "filter", - "in": "query", - "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "order", - "in": "query", - "description": "The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "string" - } - }, - { - "name": "pageSize", - "in": "query", - "description": "The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "pageNumber", - "in": "query", - "description": "The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkflowStatusModelFetchResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/WorkflowStatusModelFetchResult" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "oauth2": [] - }, - { - "bearer_token": [] - }, - { - "api_key": [] - } - ] - } - } - }, - "components": { - "schemas": { - "AccountAuthorisation": { - "type": "object", - "properties": { - "activationLink": { - "type": "string", - "description": "A URL that can be used to complete account activation at the servicer.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Optional information that can be used to complete account activation at the servicer." - }, - "AccountingProfileContactModel": { - "type": "object", - "properties": { - "accountingProfileContactId": { - "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.", - "format": "uuid", - "readOnly": true - }, - "accountingProfileId": { - "type": "string", - "description": "The ID of the profile this contact is belongs to.", - "format": "uuid" - }, - "contactId": { - "type": "string", - "description": "The ID of the contact that is linked to this profile.", - "format": "uuid" - }, - "isPrimary": { - "type": "boolean", - "description": "Determines whether the contact is primary or secondary." - }, - "groupKey": { - "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid", - "readOnly": true - }, - "created": { - "type": "string", - "description": "The date on which this record was created.", - "format": "date-time", - "readOnly": true - }, - "createdUserId": { - "type": "string", - "description": "The ID of the user who created this contact.", - "format": "uuid", - "readOnly": true - }, - "modified": { - "type": "string", - "description": "The date on which this record was last modified.", - "format": "date-time", - "readOnly": true - }, - "modifiedUserId": { - "type": "string", - "description": "The ID of the user who last modified this contact.", - "format": "uuid", - "readOnly": true - } - }, - "additionalProperties": false, - "description": "An Accounting Profile Contact has a link to a Contact that is associated with your company's\r\nAccounting Profile. These Contacts are secondary contacts to the primary that is on the profile." - }, - "AccountingProfileContactModelFetchResult": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageSize": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageNumber": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AccountingProfileContactModel" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "AccountingProfileContactResultModel": { - "type": "object", - "properties": { - "contactId": { - "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", - "format": "uuid", - "readOnly": true - }, - "companyId": { - "type": "string", - "description": "The ID of the company to which this contact belongs.", - "format": "uuid" - }, - "groupKey": { - "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid", - "readOnly": true - }, - "erpKey": { - "title": "ERP Key", - "maxLength": 100, - "minLength": 0, - "type": "string", - "description": "The unique ID of this record as it was known in its originating financial system.\r\n \r\nIf this contact 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).", - "nullable": true - }, - "contactName": { - "maxLength": 100, - "minLength": 0, - "type": "string", - "description": "The name of the contact.", - "nullable": true - }, - "contactCode": { - "maxLength": 20, - "minLength": 0, - "type": "string", - "description": "A friendly human-readable code that describes this Contact.", - "nullable": true, - "deprecated": true - }, - "title": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "description": "The title of the contact.", - "nullable": true, - "deprecated": true - }, - "roleCode": { - "maxLength": 20, - "minLength": 0, - "type": "string", - "description": "The role code for the contact.", - "nullable": true, - "deprecated": true - }, - "emailAddress": { - "maxLength": 200, - "minLength": 0, - "type": "string", - "description": "The email address of the contact.", - "format": "email", - "nullable": true, - "example": "mail@example.com" - }, - "phone": { - "maxLength": 20, - "minLength": 0, - "type": "string", - "description": "The phone number of the contact.", - "nullable": true, - "deprecated": true - }, - "fax": { - "maxLength": 20, - "minLength": 0, - "type": "string", - "description": "The fax number of the contact.", - "nullable": true, - "deprecated": true - }, - "locale": { - "maxLength": 48, - "minLength": 0, - "type": "string", - "description": "The IETF language tag for the contact's locale.", - "nullable": true, - "deprecated": true - }, - "address1": { - "maxLength": 80, - "minLength": 0, - "type": "string", - "description": "The first line of the address.", - "nullable": true, - "deprecated": true - }, - "address2": { - "maxLength": 80, - "minLength": 0, - "type": "string", - "description": "The second line of the address.", - "nullable": true, - "deprecated": true - }, - "address3": { - "maxLength": 80, - "minLength": 0, - "type": "string", - "description": "The third line of the address.", - "nullable": true, - "deprecated": true - }, - "address4": { - "maxLength": 80, - "minLength": 0, - "type": "string", - "description": "The fourth line of the address.", - "nullable": true, - "deprecated": true - }, - "city": { - "maxLength": 100, - "minLength": 0, - "type": "string", - "description": "The city of the address.", - "nullable": true, - "deprecated": true - }, - "stateRegion": { - "maxLength": 60, - "minLength": 0, - "type": "string", - "description": "The state/region of the address.", - "nullable": true, - "deprecated": true - }, - "postalCode": { - "maxLength": 10, - "minLength": 0, - "type": "string", - "description": "The postal/zip code of the address.", - "nullable": true, - "deprecated": true - }, - "countryCode": { - "maxLength": 2, - "minLength": 2, - "type": "string", - "description": "The two character country code of the address. This will be validated by the /api/v1/definitions/countries data set", - "nullable": true, - "deprecated": true - }, - "isActive": { - "type": "boolean", - "description": "Flag indicating if the contact is active.", - "default": true - }, - "webpageUrl": { - "maxLength": 512, - "minLength": 0, - "type": "string", - "description": "The webpage url of the contact.", - "format": "uri", - "nullable": true, - "example": "https://example.com", - "deprecated": true - }, - "pictureUrl": { - "maxLength": 512, - "minLength": 0, - "type": "string", - "description": "The picture/avatar url of the contact.", - "format": "uri", - "nullable": true, - "example": "https://example.com/pictureUrl", - "deprecated": true - }, - "created": { - "type": "string", - "description": "The date on which this record was created.", - "format": "date-time", - "readOnly": true - }, - "createdUserId": { - "type": "string", - "description": "The ID of the user who created this contact.", - "format": "uuid", - "readOnly": true - }, - "modified": { - "type": "string", - "description": "The date on which this record was last modified.", - "format": "date-time", - "readOnly": true - }, - "modifiedUserId": { - "type": "string", - "description": "The ID of the user who last modified this contact.", - "format": "uuid", - "readOnly": true - }, - "appEnrollmentId": { - "type": "string", - "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.", - "format": "uuid", - "nullable": true, - "readOnly": true - }, - "notes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NoteModel" - }, - "description": "A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the\r\n`include` parameter when retrieving data.\r\n \r\nTo create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes)\r\nendpoint with the `TableKey` to `Contact` and the `ObjectKey` set to the `ContactId` 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).", - "nullable": true, - "readOnly": true - }, - "attachments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachmentModel" - }, - "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 `Contact` and the `ObjectKey` set to the `ContactId` 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).", - "nullable": true, - "readOnly": true - }, - "customFieldDefinitions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldDefinitionModel" - }, - "description": "A collection of custom fields linked to this record. To retrieve this collection, specify\r\n`CustomFieldDefinitions` 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 `Contact` and the `ObjectKey` set to the `ContactId` 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).", - "nullable": true, - "readOnly": true - }, - "customFieldValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldValueModel" - }, - "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 `Contact` and the `ObjectKey` set to the `ContactId` 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).", - "nullable": true, - "readOnly": true - }, - "isPrimary": { - "type": "boolean", - "description": "Determines whether the contact is primary or secondary." - }, - "accountingProfileId": { - "type": "string", - "description": "The ID of the profile this contact belongs to.", - "format": "uuid" - }, - "accountingProfileContactId": { - "type": "string", - "description": "The ID of the accounting profile contact this contact matches.", - "format": "uuid" - }, - "name": { - "type": "string", - "description": "The Name of the profile this contact belongs to.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "A Contact contains information about a person or role within a Company.\r\nYou can use Contacts to track information about who is responsible for a specific project,\r\nwho handles invoices, or information about which role at a particular customer or\r\nvendor you should speak with about invoices.\r\n \r\nAn Accounting Profile Contact has a link to a Contact that is associated with your company's\r\nAccounting Profile. These Contacts are secondary contacts to the primary that is on the profile." - }, - "AccountingProfileContactResultModelFetchResult": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageSize": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageNumber": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AccountingProfileContactResultModel" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "AccountingProfileModel": { - "required": [ - "companyId", - "emailAddress", - "name", - "type" - ], - "type": "object", - "properties": { - "accountingProfileId": { - "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.", - "format": "uuid", - "readOnly": true - }, - "companyId": { - "minLength": 1, - "type": "string", - "description": "The ID of the company profile to which this accounting profile belongs.", - "format": "uuid" - }, - "groupKey": { - "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid", - "readOnly": true - }, - "name": { - "maxLength": 100, - "minLength": 1, - "type": "string", - "description": "The name of the accounting profile." - }, - "type": { - "maxLength": 50, - "minLength": 1, - "type": "string", - "description": "The type of the accounting profile.\r\nSome examples include 'AR', 'AP', 'AR+AP', 'General Accounting', 'Treasury', 'Payroll', 'Finance'" - }, - "emailAddress": { - "maxLength": 200, - "minLength": 1, - "type": "string", - "description": "The email address associated with the accounting profile.", - "format": "email", - "example": "mail@example.com" - }, - "phone": { - "maxLength": 20, - "type": "string", - "description": "The phone number associated with the accounting profile.", - "nullable": true - }, - "address1": { - "maxLength": 100, - "type": "string", - "description": "The first line of the address.", - "nullable": true - }, - "address2": { - "maxLength": 100, - "type": "string", - "description": "The second line of the address.", - "nullable": true - }, - "address3": { - "maxLength": 100, - "type": "string", - "description": "The third line of the address.", - "nullable": true - }, - "city": { - "maxLength": 100, - "type": "string", - "description": "The city of the address.", - "nullable": true - }, - "region": { - "maxLength": 20, - "type": "string", - "description": "The state/region of the address.", - "nullable": true - }, - "postalCode": { - "maxLength": 10, - "type": "string", - "description": "The postal/zip code of the address.", - "nullable": true - }, - "country": { - "maxLength": 2, - "minLength": 2, - "type": "string", - "description": "The two character country code of the address.", - "nullable": true - }, - "created": { - "type": "string", - "description": "The date on which this record was created.", - "format": "date-time", - "readOnly": true - }, - "createdUserId": { - "type": "string", - "description": "The ID of the user who created this accounting profile.", - "format": "uuid", - "readOnly": true - }, - "modified": { - "type": "string", - "description": "The date on which this record was last modified.", - "format": "date-time", - "readOnly": true - }, - "modifiedUserId": { - "type": "string", - "description": "The ID of the user who last modified this accounting profile.", - "format": "uuid", - "readOnly": true - }, - "notes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NoteModel" - }, - "description": "A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the\r\n`include` parameter when retrieving data.\r\n \r\nTo create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes)\r\nendpoint with the `TableKey` to `AccountingProfile` and the `ObjectKey` set to the `AccountingProfileId` 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).", - "nullable": true, - "readOnly": true - }, - "attachments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachmentModel" - }, - "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 `AccountingProfile` and the `ObjectKey` set to the `AccountingProfileId` 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).", - "nullable": true, - "readOnly": true - }, - "customFieldDefinitions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldDefinitionModel" - }, - "description": "A collection of custom fields linked to this record. To retrieve this collection, specify\r\n`CustomFieldDefinitions` 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 `AccountingProfile` and the `ObjectKey` set to the `AccountingProfileId` 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).", - "nullable": true, - "readOnly": true - }, - "customFieldValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldValueModel" - }, - "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 `AccountingProfile` and the `ObjectKey` set to the `AccountingProfileId` 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).", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false, - "description": "An Accounting Profile is a child of a Company Profile, and collectively,\r\nthey comprise the identity and necessary information for an accounting team\r\nto work with trading partners, financial institutions, auditors, and others.\r\nYou can use Accounting Profiles to define an accounting function by what\r\nthe function does and how to interface with the function." - }, - "AccountingProfileModelFetchResult": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageSize": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageNumber": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AccountingProfileModel" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "AccountingProfileRequest": { - "required": [ - "companyId", - "emailAddress", - "name", - "type" - ], - "type": "object", - "properties": { - "accountingProfileId": { - "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.", - "format": "uuid", - "readOnly": true - }, - "companyId": { - "minLength": 1, - "type": "string", - "description": "The ID of the company profile to which this accounting profile belongs.", - "format": "uuid" - }, - "groupKey": { - "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid", - "readOnly": true - }, - "name": { - "maxLength": 100, - "minLength": 1, - "type": "string", - "description": "The name of the accounting profile." - }, - "type": { - "maxLength": 50, - "minLength": 1, - "type": "string", - "description": "The type of the accounting profile.\r\nSome examples include 'AR', 'AP', 'AR+AP', 'General Accounting', 'Treasury', 'Payroll', 'Finance'" - }, - "emailAddress": { - "maxLength": 200, - "minLength": 1, - "type": "string", - "description": "The email address associated with the accounting profile.", - "format": "email", - "example": "mail@example.com" - }, - "phone": { - "maxLength": 20, - "type": "string", - "description": "The phone number associated with the accounting profile.", - "nullable": true - }, - "address1": { - "maxLength": 100, - "type": "string", - "description": "The first line of the address.", - "nullable": true - }, - "address2": { - "maxLength": 100, - "type": "string", - "description": "The second line of the address.", - "nullable": true - }, - "address3": { - "maxLength": 100, - "type": "string", - "description": "The third line of the address.", - "nullable": true - }, - "city": { - "maxLength": 100, - "type": "string", - "description": "The city of the address.", - "nullable": true - }, - "region": { - "maxLength": 20, - "type": "string", - "description": "The state/region of the address.", - "nullable": true - }, - "postalCode": { - "maxLength": 10, - "type": "string", - "description": "The postal/zip code of the address.", - "nullable": true - }, - "country": { - "maxLength": 2, - "minLength": 2, - "type": "string", - "description": "The two character country code of the address.", - "nullable": true - }, - "created": { - "type": "string", - "description": "The date on which this record was created.", - "format": "date-time", - "readOnly": true - }, - "createdUserId": { - "type": "string", - "description": "The ID of the user who created this accounting profile.", - "format": "uuid", - "readOnly": true - }, - "modified": { - "type": "string", - "description": "The date on which this record was last modified.", - "format": "date-time", - "readOnly": true - }, - "modifiedUserId": { - "type": "string", - "description": "The ID of the user who last modified this accounting profile.", - "format": "uuid", - "readOnly": true - }, - "notes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NoteModel" - }, - "description": "A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the\r\n`include` parameter when retrieving data.\r\n \r\nTo create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes)\r\nendpoint with the `TableKey` to `AccountingProfile` and the `ObjectKey` set to the `AccountingProfileId` 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).", - "nullable": true, - "readOnly": true - }, - "attachments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachmentModel" - }, - "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 `AccountingProfile` and the `ObjectKey` set to the `AccountingProfileId` 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).", - "nullable": true, - "readOnly": true - }, - "customFieldDefinitions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldDefinitionModel" - }, - "description": "A collection of custom fields linked to this record. To retrieve this collection, specify\r\n`CustomFieldDefinitions` 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 `AccountingProfile` and the `ObjectKey` set to the `AccountingProfileId` 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).", - "nullable": true, - "readOnly": true - }, - "customFieldValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldValueModel" - }, - "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 `AccountingProfile` and the `ObjectKey` set to the `AccountingProfileId` 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).", - "nullable": true, - "readOnly": true - }, - "primaryContactId": { - "type": "string", - "description": "The ID of the primary contact that is linked to this profile.", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "An Accounting Profile is a child of a Company Profile, and collectively,\r\nthey comprise the identity and necessary information for an accounting team\r\nto work with trading partners, financial institutions, auditors, and others.\r\nYou can use Accounting Profiles to define an accounting function by what\r\nthe function does and how to interface with the function." - }, - "ActionResult": { - "type": "object", - "additionalProperties": false - }, - "ActionResultModel": { - "type": "object", - "properties": { - "messages": { - "type": "array", - "items": { - "type": "string" - }, - "description": "If the API call produced messages, this element will contain a list of user-visible\r\ntext strings that contain information about what work occurred in the API.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Represents the result of an action.\r\n \r\nIn the ADS Platform 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." - }, - "Address": { - "type": "object", - "properties": { - "addressLine1": { - "type": "string", - "description": "Address line 1.", - "nullable": true - }, - "addressLine2": { - "type": "string", - "description": "Address line 2.", - "nullable": true - }, - "addressLine3": { - "type": "string", - "description": "Address line 3.", - "nullable": true - }, - "addressLine4": { - "type": "string", - "description": "Address line 4.", - "nullable": true - }, - "countrySubdivision": { - "type": "string", - "description": "Subdivision of a country. For example, state, county, or region.", - "nullable": true - }, - "postalCode": { - "type": "string", - "description": "Postal/zip code.", - "nullable": true - }, - "country": { - "type": "string", - "description": "Country in the ISO 3166-1 Alpha-3 format.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Address object." - }, - "AgingBucket": { - "enum": [ - 0, - 1, - 2, - 3, - 4 - ], - "type": "integer", - "description": "The different buckets used for aging.", - "format": "int32" - }, - "AgingBucketResult": { - "type": "object", - "properties": { - "bucket": { - "allOf": [ - { - "$ref": "#/components/schemas/AgingBucket" - } - ], - "description": "The different buckets used for aging." - }, - "value": { - "type": "number", - "description": "The outstanding amount for the given bucket in the group's base currency.", - "format": "double" - } - }, - "additionalProperties": false, - "description": "The aging data for an individual bucket" - }, - "AgingModel": { - "type": "object", - "properties": { - "groupKey": { - "type": "string", - "description": "The Group Key the aging data is calculated for.", - "format": "uuid" - }, - "total": { - "type": "number", - "description": "The total AR outstanding amount in the group's base currency.", - "format": "double" - }, - "buckets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AgingBucketResult" - }, - "description": "The outstanding amount in the group's base currency, grouped by days overdue.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "A summary of AR Aging for a given Group Key. This aging data is presented\r\nin buckets of days overdue in the group's base currency." - }, - "Amount": { - "type": "object", - "properties": { - "netAmount": { - "type": "number", - "description": "Net amount of the payment after fees have been deducted by the servicer(s) involved.", - "format": "double", - "nullable": true - }, - "fee": { - "type": "number", - "description": "Total fee amount applied to this payment by the servicer(s) involved.", - "format": "double", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Amount of the payment." - }, - "ApiKeyModel": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "apiKeyId": { - "type": "string", - "description": "The unique identifier for the API key.", - "format": "uuid", - "readOnly": true - }, - "groupKey": { - "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid", - "readOnly": true - }, - "name": { - "maxLength": 100, - "minLength": 1, - "type": "string", - "description": "The name of the API key." - }, - "environment": { - "type": "string", - "description": "For convenience, a call to createApiKey will contain the name of the environment for this API key,\r\ntypically SBX or PRD. This can help you distinguish between keys created on the Sandbox environment\r\nfrom those created on Production.", - "nullable": true, - "readOnly": true - }, - "apiKey": { - "maxLength": 100, - "minLength": 0, - "type": "string", - "description": "The API key to use for authentication. This will only be returned upon creation of the API key.\r\nAll other times, this value will be `null`.\r\n \r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).", - "nullable": true, - "readOnly": true - }, - "keyPrefix": { - "maxLength": 10, - "minLength": 10, - "type": "string", - "description": "The first 10 characters of the API key. This information can be used to ensure that you are\r\nlooking at the correct API Key, but cannot be used for authentication.", - "nullable": true, - "readOnly": true - }, - "created": { - "type": "string", - "description": "The date the API key was created.", - "format": "date-time", - "readOnly": true - }, - "createdUserId": { - "type": "string", - "description": "The user that created the API key.", - "format": "uuid", - "readOnly": true - }, - "revoked": { - "type": "string", - "description": "The date the API key was revoked.", - "format": "date-time", - "nullable": true, - "readOnly": true - }, - "revokedUserId": { - "type": "string", - "description": "The user who revoked the API key.", - "format": "uuid", - "nullable": true, - "readOnly": true - }, - "expires": { - "type": "string", - "description": "The UTC datetime when the API key expires.", - "format": "date-time", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false, - "description": "An API Key is an authentication token that you may use with the ADS Platform API. Because API Keys\r\ndo not have an expiration date, they are well suited for unattended processes. Each API Key\r\nis associated with a user, and may be revoked to prevent it from accessing the ADS Platform API.\r\nWhen you create an API Key, make sure to save the value in a secure location. ADS Platform cannot\r\nretrieve an API Key once it is created.\r\n \r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys)." - }, - "ApiKeyModelFetchResult": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageSize": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageNumber": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApiKeyModel" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "AppEnrollmentCustomFieldModel": { - "type": "object", - "properties": { - "appEnrollmentId": { - "type": "string", - "description": "Unique id for the app enrollment", - "format": "uuid", - "readOnly": true - }, - "appId": { - "type": "string", - "description": "Id of enrolled app", - "format": "uuid", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the application", - "nullable": true, - "readOnly": true - }, - "appType": { - "type": "string", - "description": "Tag for what type of app the application is", - "nullable": true, - "readOnly": true - }, - "groupKey": { - "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid", - "readOnly": true - }, - "customFieldDefinitionId": { - "type": "string", - "description": "Unique Id for the custom field definition", - "format": "uuid", - "readOnly": true - }, - "customFieldLabel": { - "type": "string", - "description": "Text to display in-application for custom field", - "nullable": true, - "readOnly": true - }, - "dataType": { - "type": "string", - "description": "Data type of the custom field definition", - "nullable": true, - "readOnly": true - }, - "sortOrder": { - "type": "integer", - "description": "Used for display logic when multiple app enrollment custom fields exist", - "format": "int32", - "readOnly": true - }, - "stringValue": { - "type": "string", - "description": "String of data for field", - "nullable": true, - "readOnly": true, - "deprecated": true - }, - "numericValue": { - "type": "number", - "description": "Number data for field", - "format": "double", - "nullable": true, - "readOnly": true, - "deprecated": true - }, - "value": { - "type": "string", - "description": "Value for the field", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false, - "description": "App enrollment and custom field merged into one" - }, - "AppEnrollmentCustomFieldModelFetchResult": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageSize": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageNumber": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppEnrollmentCustomFieldModel" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "AppEnrollmentModel": { - "required": [ - "appId" - ], - "type": "object", - "properties": { - "appEnrollmentId": { - "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.", - "format": "uuid", - "readOnly": true - }, - "appId": { - "minLength": 1, - "type": "string", - "description": "The ID number of the Application that this enrollment represents. You can fetch information\r\nabout this Application object by specifying `App` in the \"Include\" parameter for your request.", - "format": "uuid", - "readOnly": true - }, - "groupKey": { - "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid", - "readOnly": true - }, - "isActive": { - "type": "boolean", - "description": "Determines whether the app enrollment is in use", - "default": true - }, - "created": { - "type": "string", - "description": "Created date", - "format": "date-time", - "readOnly": true - }, - "createdUserId": { - "type": "string", - "description": "Created user ID", - "format": "uuid", - "readOnly": true - }, - "modified": { - "type": "string", - "description": "Last modified date", - "format": "date-time", - "readOnly": true - }, - "modifiedUserId": { - "type": "string", - "description": "Last user ID to modify", - "format": "uuid", - "readOnly": true - }, - "cronSettings": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "description": "Stores schedule information for the application enrollment\r\nsee https://en.wikipedia.org/wiki/Cron", - "default": null, - "nullable": true - }, - "syncScheduleIsActive": { - "type": "boolean", - "description": "Flag indicating if the Sync process should be ran on the specified schedule", - "default": true - }, - "isDeleted": { - "type": "boolean", - "description": "Flag indicating if the App Enrollment is currently being deleted from the Platform.", - "readOnly": true - }, - "app": { - "allOf": [ - { - "$ref": "#/components/schemas/ApplicationModel" - } - ], - "description": "The Application to which this AppEnrollment belongs. Contains general name, description,\r\nlogo, and other metadata about this application.\r\n \r\nTo retrieve this object, specify `App` in the \"Include\" parameter for your query.", - "nullable": true, - "readOnly": true - }, - "customFieldDefinitions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldDefinitionModel" - }, - "description": "A collection of custom fields linked to this record. To retrieve this collection, specify\r\n`CustomFieldDefinitions` 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 `AppEnrollment` and the `ObjectKey` set to the `AppEnrollmentId` 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).", - "nullable": true, - "readOnly": true - }, - "customFieldValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldValueModel" - }, - "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 `AppEnrollment` and the `ObjectKey` set to the `AppEnrollmentId` 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).", - "nullable": true, - "readOnly": true - }, - "lastSync": { - "allOf": [ - { - "$ref": "#/components/schemas/SyncRequestModel" - } - ], - "description": "Data about the last sync attached to this app enrollment\r\n \r\nTo retrieve this collection, specify `LastSync` in the \"Include\" parameter for your query.", - "nullable": true, - "readOnly": true - }, - "lastSuccessfulSync": { - "allOf": [ - { - "$ref": "#/components/schemas/SyncRequestModel" - } - ], - "description": "Data about the last successful sync associated with this enrollment", - "nullable": true, - "readOnly": true - }, - "connectorInfo": { - "allOf": [ - { - "$ref": "#/components/schemas/ConnectorInfoModel" - } - ], - "description": "Optional data necessary to create an app enrollment for a supported connector.\r\nOnly enter relevant fields for the given connector.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "An AppEnrollment represents an app that has been enrolled to the current account. When you sign up for an\r\napp using the ADS Platform, you obtain an enrollment record for that app. Example types of apps include\r\nconnectors and feature enhancement apps. The App Enrollment object contains information about this app, its\r\nconfiguration, and settings.\r\n \r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) for more information." - }, - "AppEnrollmentModelFetchResult": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageSize": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageNumber": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppEnrollmentModel" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "AppEnrollmentReconnectInfo": { - "type": "object", - "properties": { - "authCode": { - "type": "string", - "description": "The OAuth authentication code.", - "nullable": true - }, - "username": { - "type": "string", - "description": "The username for the web services account with access permissions.", - "nullable": true - }, - "password": { - "type": "string", - "description": "The password for the web services account with access permissions.", - "nullable": true - }, - "realmId": { - "type": "string", - "description": "The Realm Id for the app enrollment to reconnect.", - "nullable": true - }, - "tokenId": { - "type": "string", - "description": "The access token id for the connector enrollment.", - "nullable": true - }, - "tokenSecret": { - "type": "string", - "description": "The access token secret for the connector enrollment.", - "nullable": true - }, - "redirectUri": { - "type": "string", - "description": "The OAuth redirect uri.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Information to reconnect an ERP." - }, - "ApplicationModel": { - "required": [ - "appType", - "name" - ], - "type": "object", - "properties": { - "appId": { - "type": "string", - "description": "A unique code identifying this application", - "format": "uuid", - "readOnly": true - }, - "name": { - "maxLength": 100, - "minLength": 1, - "type": "string", - "description": "The name of this application" - }, - "description": { - "maxLength": 500, - "type": "string", - "description": "Brief summary of this application shown as a subtitle", - "nullable": true - }, - "appType": { - "maxLength": 50, - "type": "string", - "description": "Tag for what type of app this is" - }, - "ownerId": { - "type": "string", - "description": "The ID of the owner", - "format": "uuid" - }, - "projectUrl": { - "maxLength": 200, - "type": "string", - "description": "The URL to visit for more information about this application", - "nullable": true, - "example": "https://example.com/projectUrl" - }, - "iconUrl": { - "maxLength": 200, - "type": "string", - "description": "The URL for the icon for this application", - "nullable": true, - "example": "https://example.com/iconUrl" - }, - "createdUserId": { - "type": "string", - "description": "The ID of the user who created this application", - "format": "uuid", - "readOnly": true - }, - "modifiedUserId": { - "type": "string", - "description": "The ID of the user who last modified this application", - "format": "uuid", - "readOnly": true - }, - "created": { - "type": "string", - "description": "The date this application was created", - "format": "date-time", - "readOnly": true - }, - "modified": { - "type": "string", - "description": "The date this application was last modified", - "format": "date-time", - "readOnly": true - }, - "isActive": { - "type": "boolean", - "description": "Flag indicating if the application is active.", - "default": true - }, - "groupKey": { - "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid", - "readOnly": true - }, - "b2CClientId": { - "type": "string", - "description": "The B2C Client ID of the application", - "format": "uuid", - "nullable": true, - "readOnly": true - }, - "notes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NoteModel" - }, - "description": "A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the\r\n`include` parameter when retrieving data.\r\n \r\nTo create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes)\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).", - "nullable": true, - "readOnly": true - }, - "attachments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachmentModel" - }, - "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 `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).", - "nullable": true, - "readOnly": true - }, - "customFieldDefinitions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldDefinitionModel" - }, - "description": "A collection of custom fields linked to this record. To retrieve this collection, specify\r\n`CustomFieldDefinitions` 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).", - "nullable": true, - "readOnly": true - }, - "customFieldValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldValueModel" - }, - "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).", - "nullable": true, - "readOnly": true - }, - "enrollments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppEnrollmentModel" - }, - "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).", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false, - "description": "An Application represents a feature available to customers within the ADS Platform. You can create\r\nApplications by working with your ADS Platform business development manager and publish them on the platform\r\nso that customers can browse and find your Application on the ADS Platform Marketplace. When a\r\ncustomer adds an Application to their account, they obtain an AppEnrollment which represents that customer's\r\ninstance of this Application. The customer-specific AppEnrollment contains a customer's configuration data\r\nfor the Application, which is not customer-specific.\r\n \r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.\n--swaggerCategory:Platform" - }, - "ApplicationModelFetchResult": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageSize": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageNumber": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApplicationModel" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "AttachmentLinkModel": { - "type": "object", - "properties": { - "groupKey": { - "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid", - "readOnly": true - }, - "attachmentId": { - "type": "string", - "description": "The unique ID of an attachment record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.", - "format": "uuid" - }, - "objectKey": { - "type": "string", - "description": "An Attachment is connected to an existing item within the ADS Platform by the fields `TableKey` and\r\n`ObjectKey`. For example, an Attachment 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 ADS Platform to which this\r\nAttachment 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).", - "format": "uuid" - }, - "tableKey": { - "maxLength": 40, - "minLength": 0, - "type": "string", - "description": "An Attachment is connected to an existing item within the ADS Platform by the fields `TableKey` and\r\n`ObjectKey`. For example, an Attachment 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 ADS Platform to which this Attachment\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).", - "nullable": true - }, - "created": { - "type": "string", - "description": "The date the Attachment Link was created.", - "format": "date-time", - "readOnly": true - }, - "createdUserId": { - "type": "string", - "description": "The unique ID of the [UserAccount](https://developer.lockstep.io/docs/useraccountmodel) of the user\r\nwho created this Attachment Link.", - "format": "uuid", - "readOnly": true - } - }, - "additionalProperties": false, - "description": "An Attachment Link represents a single link between any nestable object and an attachment" - }, - "AttachmentLinkModelFetchResult": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageSize": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageNumber": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachmentLinkModel" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "AttachmentModel": { - "required": [ - "objectKey", - "tableKey" - ], - "type": "object", - "properties": { - "attachmentId": { - "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.", - "format": "uuid", - "readOnly": true - }, - "groupKey": { - "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid", - "readOnly": true - }, - "tableKey": { - "maxLength": 40, - "minLength": 1, - "type": "string", - "description": "An Attachment is connected to an existing item within the ADS Platform by the fields `TableKey` and\r\n`ObjectKey`. For example, an Attachment 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 ADS Platform to which this Attachment\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).", - "readOnly": true - }, - "objectKey": { - "minLength": 1, - "type": "string", - "description": "An Attachment is connected to an existing item within the ADS Platform by the fields `TableKey` and\r\n`ObjectKey`. For example, an Attachment 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 ADS Platform to which this\r\nAttachment 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).", - "format": "uuid", - "readOnly": true - }, - "fileName": { - "maxLength": 200, - "minLength": 0, - "type": "string", - "description": "An Attachment represents a file that was uploaded to the ADS Platform. This field contains the original\r\nname of the file on disk, without its extension.", - "nullable": true, - "readOnly": true - }, - "fileExt": { - "maxLength": 20, - "minLength": 0, - "type": "string", - "description": "An Attachment represents a file that was uploaded to the ADS Platform. This field contains the original\r\nextension name of the file on disk.", - "nullable": true, - "readOnly": true - }, - "isArchived": { - "type": "boolean", - "description": "A flag indicating whether this Attachment is archived (also known as hidden or deleted). When you call\r\n[ArchiveAttachment](https://developer.lockstep.io/reference/delete_api-v1-attachments-id) this field will\r\nbe set to true.\r\n \r\nYou should avoid displaying Attachments with the IsArchived field set to true in your user interface." - }, - "erpKey": { - "type": "string", - "description": "The unique ID of this record as it was known in its originating financial system.\r\n \r\nIf this company 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 from a financial system, this value will be `null`.\r\n \r\nFor more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).", - "nullable": true, - "readOnly": true - }, - "appEnrollmentId": { - "type": "string", - "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.", - "format": "uuid", - "nullable": true, - "readOnly": true - }, - "created": { - "type": "string", - "description": "The date the attachment was created.", - "format": "date-time", - "readOnly": true - }, - "createdUserId": { - "type": "string", - "description": "The unique ID of the [UserAccount](https://developer.lockstep.io/docs/useraccountmodel) of the user\r\nwho created this Attachment.", - "format": "uuid", - "readOnly": true - }, - "modified": { - "type": "string", - "description": "The date the attachment was modified.", - "format": "date-time", - "readOnly": true - }, - "modifiedUserId": { - "type": "string", - "description": "The unique ID of the [UserAccount](https://developer.lockstep.io/docs/useraccountmodel) of the user\r\nwho modified this Attachment.", - "format": "uuid", - "readOnly": true - }, - "attachmentType": { - "maxLength": 100, - "minLength": 0, - "type": "string", - "description": "A text string describing the type of this Attachment.", - "nullable": true - }, - "uploadStatus": { - "enum": [ - "Upload Pending", - "Uploaded", - "Upload Failed" - ], - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/ScanStatus" - } - ], - "description": "The different statuses of an attachment being scanned for viruses.", - "format": "", - "readOnly": true - } - }, - "additionalProperties": false, - "description": "An Attachment is a file that can be attached to various account attributes within ADS.\r\nThis data model contains metadata about the attachment. You can upload and download attachments\r\ninto the ADS Platform along with this metadata. Attachments can be used for invoices, payments,\r\nlegal documents, or any other external files that you wish to track.\r\n \r\nSee [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information." - }, - "AttachmentModelFetchResult": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageSize": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageNumber": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachmentModel" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "BaseCurrencySyncModel": { - "required": [ - "baseCurrencyCode" - ], - "type": "object", - "properties": { - "baseCurrencyCode": { - "type": "string", - "description": "The default currency code used by this business entity.\r\n \r\nFor a list of defined currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies)" - } - }, - "additionalProperties": {}, - "description": "The BaseCurrencySyncModel represents information coming into ADS 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 BaseCurrencySyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be used to update the Group Account base currency code.\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." - }, - "BatchSyncModel": { - "type": "object", - "properties": { - "appEnrollmentId": { - "type": "string", - "description": "The optional existing app enrollment to associate with the data in this batch.", - "format": "uuid", - "nullable": true - }, - "isFullSync": { - "type": "boolean", - "description": "True if this is a full sync, false if this is a partial sync. Defaults to false.", - "default": false - }, - "currentBatch": { - "type": "integer", - "description": "The optional current batch number for this batch sync.", - "format": "int32", - "default": 1, - "nullable": true - }, - "totalBatches": { - "type": "integer", - "description": "The optional total number of batchs for this batch sync.", - "format": "int32", - "default": 1, - "nullable": true - }, - "parentSyncRequestId": { - "type": "string", - "description": "The optional existing parent sync request id for the batch sync.", - "format": "uuid", - "nullable": true - }, - "companies": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CompanySyncModel" - }, - "description": "A list of Company records to merge with your ADS Platform data", - "nullable": true - }, - "contacts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ContactSyncModel" - }, - "description": "A list of Contact records to merge with your ADS Platform data", - "nullable": true - }, - "creditMemoApplications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CreditMemoAppliedSyncModel" - }, - "description": "A list of CreditMemoApplied records to merge with your ADS Platform data", - "nullable": true - }, - "invoices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InvoiceSyncModel" - }, - "description": "A list of Invoice records to merge with your ADS Platform data", - "nullable": true - }, - "invoiceLines": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InvoiceLineSyncModel" - }, - "description": "A list of InvoiceLine records to merge with your ADS Platform data", - "nullable": true - }, - "invoiceWorkflowStatuses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InvoiceWorkflowStatusSyncModel" - }, - "description": "A list of InvoiceWorkflowStatus records to merge with your ADS Platform data", - "nullable": true - }, - "customFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSyncModel" - }, - "description": "A list of CustomField records to merge with your ADS Platform data", - "nullable": true - }, - "payments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentSyncModel" - }, - "description": "A list of Payment records to merge with your ADS Platform data", - "nullable": true - }, - "paymentApplications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentAppliedSyncModel" - }, - "description": "A list of PaymentApplied records to merge with your ADS Platform data", - "nullable": true - }, - "financialYearSettings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FinancialYearSettingSyncModel" - }, - "description": "A list of FinancialYearSetting records to merge with your ADS Platform data", - "nullable": true - }, - "financialAccounts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FinancialAccountSyncModel" - }, - "description": "A list of FinancialAccount records to merge with your ADS Platform data", - "nullable": true - }, - "financialAccountBalanceHistories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FinancialAccountBalanceHistorySyncModel" - }, - "description": "A list of FinancialAccountBalanceHistory records to merge with your ADS Platform data", - "nullable": true - }, - "baseCurrencies": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BaseCurrencySyncModel" - }, - "description": "A list of BaseCurrency records to merge with your ADS Platform data", - "nullable": true - }, - "journalEntries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JournalEntrySyncModel" - }, - "description": "A list of JournalEntry records to merge with your ADS Platform data", - "nullable": true - }, - "journalEntryLines": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JournalEntryLineSyncModel" - }, - "description": "A list of JournalEntryLine records to merge with your ADS Platform data", - "nullable": true - } - }, - "additionalProperties": false, - "description": "A BatchSyncModel contains a collection of records to load into the ADS Platform. Data contained\r\nin this batch will be merged with your existing data. Each record will be matched with existing data inside\r\nthe ADS Platform using the [Identity Column](https://developer.lockstep.io/docs/identity-columns) rules.\r\nAny record that represents a new AppEnrollmentId+ErpKey will be inserted. A record that matches an existing\r\nAppEnrollmentId+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. ADS 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." - }, - "BulkCurrencyConversionModel": { - "required": [ - "sourceCurrency" - ], + "Amount": { "type": "object", "properties": { - "date": { - "type": "string", - "description": "The date for the currency rate", - "format": "date" + "netAmount": { + "type": "number", + "description": "Net amount of the payment after fees have been deducted by the servicer(s) involved.", + "format": "double", + "nullable": true }, - "sourceCurrency": { - "maxLength": 3, - "minLength": 1, - "type": "string", - "description": "The currency code This will be validated by the /api/v1/definitions/currencies data set" + "fee": { + "type": "number", + "description": "Total fee amount applied to this payment by the servicer(s) involved.", + "format": "double", + "nullable": true } }, "additionalProperties": false, - "description": "Input format used for bulk conversion route" + "description": "Amount of the payment." }, - "BulkDeleteRequestModel": { + "ApiKeyModel": { "required": [ - "idsToDelete" + "name" ], "type": "object", "properties": { - "idsToDelete": { - "minItems": 1, - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "description": "Represents the IDs to be deleted" - } - }, - "additionalProperties": false, - "description": "Represents a bulk delete request in the API" - }, - "CodeDefinitionModel": { - "type": "object", - "properties": { - "codeDefinitionId": { + "apiKeyId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.", + "description": "The unique identifier for the API key.", "format": "uuid", "readOnly": true }, "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "readOnly": true }, - "codeType": { - "maxLength": 40, - "minLength": 0, + "name": { + "maxLength": 100, + "minLength": 1, "type": "string", - "description": "The type of the Code Definition", - "nullable": true + "description": "The name of the API key." }, - "code": { - "maxLength": 40, - "minLength": 0, + "environment": { "type": "string", - "description": "The Code to be defined.", - "nullable": true + "description": "For convenience, a call to createApiKey will contain the name of the environment for this API key,\r\ntypically SBX or PRD. This can help you distinguish between keys created on the Sandbox environment\r\nfrom those created on Production.", + "nullable": true, + "readOnly": true }, - "codeDescription": { - "maxLength": 200, + "apiKey": { + "maxLength": 100, "minLength": 0, "type": "string", - "description": "The definition of the Code", - "nullable": true + "description": "The API key to use for authentication. This will only be returned upon creation of the API key.\r\nAll other times, this value will be `null`.\r\n \r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).", + "nullable": true, + "readOnly": true + }, + "keyPrefix": { + "maxLength": 10, + "minLength": 10, + "type": "string", + "description": "The first 10 characters of the API key. This information can be used to ensure that you are\r\nlooking at the correct API Key, but cannot be used for authentication.", + "nullable": true, + "readOnly": true }, "created": { "type": "string", - "description": "The date that the Code Definition was created", + "description": "The date the API key was created.", "format": "date-time", "readOnly": true }, "createdUserId": { "type": "string", - "description": "The ID of the user who created the Code Definition", + "description": "The user that created the API key.", "format": "uuid", "readOnly": true }, - "modified": { + "revoked": { "type": "string", - "description": "The date the Code Definition was last modified", + "description": "The date the API key was revoked.", "format": "date-time", + "nullable": true, "readOnly": true }, - "modifiedUserId": { + "revokedUserId": { "type": "string", - "description": "The ID of the user who last modified the Code Definition", + "description": "The user who revoked the API key.", "format": "uuid", + "nullable": true, + "readOnly": true + }, + "expires": { + "type": "string", + "description": "The UTC datetime when the API key expires.", + "format": "date-time", + "nullable": true, "readOnly": true } }, "additionalProperties": false, - "description": "Represents a Code Definition. Codes can be used as shortened, human readable strings.\r\nAdditionally, this table can be used to store lists of system values for ADS Platform objects." + "description": "An API Key is an authentication token that you may use with the Accounting Data Service API. Because API Keys\r\ndo not have an expiration date, they are well suited for unattended processes. Each API Key\r\nis associated with a user, and may be revoked to prevent it from accessing the Accounting Data Service API.\r\nWhen you create an API Key, make sure to save the value in a secure location. Accounting Data Service cannot\r\nretrieve an API Key once it is created.\r\n \r\nFor more information, see [API Keys](https://developer.lockstep.io/docs/api-keys)." }, - "CodeDefinitionModelFetchResult": { + "ApiKeyModelFetchResult": { "type": "object", "properties": { "totalCount": { @@ -22503,365 +17362,447 @@ "records": { "type": "array", "items": { - "$ref": "#/components/schemas/CodeDefinitionModel" + "$ref": "#/components/schemas/ApiKeyModel" }, "nullable": true } }, "additionalProperties": false }, - "CompanyDetailsModel": { + "AppEnrollmentCustomFieldModel": { "type": "object", "properties": { - "groupKey": { + "appEnrollmentId": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid" + "description": "Unique id for the app enrollment", + "format": "uuid", + "readOnly": true }, - "customerId": { + "appId": { "type": "string", - "description": "The unique ID of this company", - "format": "uuid" + "description": "Id of enrolled app", + "format": "uuid", + "readOnly": true }, "name": { "type": "string", - "description": "The unique ID of this company", - "nullable": true - }, - "address1": { - "type": "string", - "description": "Company address info", - "nullable": true - }, - "address2": { - "type": "string", - "description": "Company address info", - "nullable": true - }, - "address3": { - "type": "string", - "description": "Company address info", - "nullable": true - }, - "city": { - "type": "string", - "description": "Company address info", - "nullable": true - }, - "state": { - "type": "string", - "description": "Company address info", - "nullable": true - }, - "postalCode": { - "type": "string", - "description": "Company address info", - "nullable": true + "description": "The name of the application", + "nullable": true, + "readOnly": true }, - "country": { + "appType": { "type": "string", - "description": "Company address country", - "nullable": true + "description": "Tag for what type of app the application is", + "nullable": true, + "readOnly": true }, - "phoneNumber": { + "groupKey": { "type": "string", - "description": "Company phone number", - "nullable": true + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", + "format": "uuid", + "readOnly": true }, - "faxNumber": { + "customFieldDefinitionId": { "type": "string", - "description": "Company fax number", - "nullable": true + "description": "Unique Id for the custom field definition", + "format": "uuid", + "readOnly": true }, - "email": { + "customFieldLabel": { "type": "string", - "description": "Company email address", - "nullable": true + "description": "Text to display in-application for custom field", + "nullable": true, + "readOnly": true }, - "contactId": { + "dataType": { "type": "string", - "description": "Company primary contact id", - "format": "uuid" + "description": "Data type of the custom field definition", + "nullable": true, + "readOnly": true }, - "contactName": { - "type": "string", - "description": "Company primary contact name", - "nullable": true + "sortOrder": { + "type": "integer", + "description": "Used for display logic when multiple app enrollment custom fields exist", + "format": "int32", + "readOnly": true }, - "contactEmail": { + "stringValue": { "type": "string", - "description": "Company primary contact email address", - "nullable": true + "description": "String of data for field", + "nullable": true, + "readOnly": true, + "deprecated": true }, - "outstandingInvoices": { - "type": "integer", - "description": "Company number of outstanding invoices", - "format": "int32", + "numericValue": { + "type": "number", + "description": "Number data for field", + "format": "double", + "nullable": true, + "readOnly": true, "deprecated": true }, - "groupBaseCurrencyCode": { + "value": { "type": "string", - "description": "The group's base currency code.", + "description": "Value for the field", "nullable": true, - "deprecated": true + "readOnly": true + } + }, + "additionalProperties": false, + "description": "App enrollment and custom field merged into one" + }, + "AppEnrollmentCustomFieldModelFetchResult": { + "type": "object", + "properties": { + "totalCount": { + "type": "integer", + "format": "int32", + "nullable": true }, - "outstandingAmount": { - "type": "number", - "description": "Company total outstanding invoice amount in the group's base currency.", - "format": "double", - "deprecated": true + "pageSize": { + "type": "integer", + "format": "int32", + "nullable": true }, - "amountPastDue": { - "type": "number", - "description": "Company total past due amount in the group's base currency.", - "format": "double", - "deprecated": true + "pageNumber": { + "type": "integer", + "format": "int32", + "nullable": true }, - "payments": { + "records": { "type": "array", "items": { - "$ref": "#/components/schemas/CompanyDetailsPaymentModel" + "$ref": "#/components/schemas/AppEnrollmentCustomFieldModel" }, - "description": "Company payments collected", - "nullable": true, - "deprecated": true + "nullable": true } }, - "additionalProperties": false, - "description": "Contains company details data" + "additionalProperties": false }, - "CompanyDetailsPaymentModel": { + "AppEnrollmentModel": { + "required": [ + "appId" + ], "type": "object", "properties": { - "groupKey": { + "appEnrollmentId": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid" + "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.", + "format": "uuid", + "readOnly": true }, - "paymentId": { + "appId": { + "minLength": 1, "type": "string", - "description": "Unique identifier for payment", - "format": "uuid" + "description": "The ID number of the Application that this enrollment represents. You can fetch information\r\nabout this Application object by specifying `App` in the \"Include\" parameter for your request.", + "format": "uuid", + "readOnly": true }, - "paymentAppliedId": { + "groupKey": { "type": "string", - "description": "Unique identifier for payment applied", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", - "nullable": true + "readOnly": true }, - "paymentType": { + "isActive": { + "type": "boolean", + "description": "Determines whether the app enrollment is in use", + "default": true + }, + "created": { "type": "string", - "description": "Payment type", - "nullable": true + "description": "Created date", + "format": "date-time", + "readOnly": true }, - "invoiceId": { + "createdUserId": { "type": "string", - "description": "Unique identifier for invoice payment is associated with", + "description": "Created user ID", "format": "uuid", - "nullable": true + "readOnly": true }, - "invoiceTypeCode": { + "modified": { "type": "string", - "description": "Invoice type payment is associated with", - "nullable": true + "description": "Last modified date", + "format": "date-time", + "readOnly": true }, - "invoiceReferenceCode": { + "modifiedUserId": { "type": "string", - "description": "Invoice reference code payment is associated with", - "nullable": true + "description": "Last user ID to modify", + "format": "uuid", + "readOnly": true }, - "invoiceCurrencyCode": { + "cronSettings": { + "maxLength": 50, + "minLength": 0, "type": "string", - "description": "The currency code of the invoice the payment is associated with.", + "description": "Stores schedule information for the application enrollment\r\nsee https://en.wikipedia.org/wiki/Cron", + "default": null, "nullable": true }, - "invoiceTotalAmount": { - "type": "number", - "description": "Invoice total amount payment is associated with", - "format": "double" + "syncScheduleIsActive": { + "type": "boolean", + "description": "Flag indicating if the Sync process should be ran on the specified schedule", + "default": true }, - "paymentDate": { - "type": "string", - "description": "Date payment placed", - "format": "date-time" + "isDeleted": { + "type": "boolean", + "description": "Flag indicating if the App Enrollment is currently being deleted from the Network.", + "readOnly": true }, - "paymentCurrencyCode": { - "type": "string", - "description": "The currency code of the payment.", - "nullable": true + "app": { + "allOf": [ + { + "$ref": "#/components/schemas/ApplicationModel" + } + ], + "description": "The Application to which this AppEnrollment belongs. Contains general name, description,\r\nlogo, and other metadata about this application.\r\n \r\nTo retrieve this object, specify `App` in the \"Include\" parameter for your query.", + "nullable": true, + "readOnly": true }, - "paymentAmount": { - "type": "number", - "description": "Amount payment was made for", - "format": "double" + "customFieldDefinitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldDefinitionModel" + }, + "description": "A collection of custom fields linked to this record. To retrieve this collection, specify\r\n`CustomFieldDefinitions` 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 `AppEnrollment` and the `ObjectKey` set to the `AppEnrollmentId` 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).", + "nullable": true, + "readOnly": true + }, + "customFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldValueModel" + }, + "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 `AppEnrollment` and the `ObjectKey` set to the `AppEnrollmentId` 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).", + "nullable": true, + "readOnly": true + }, + "lastSync": { + "allOf": [ + { + "$ref": "#/components/schemas/SyncRequestModel" + } + ], + "description": "Data about the last sync attached to this app enrollment\r\n \r\nTo retrieve this collection, specify `LastSync` in the \"Include\" parameter for your query.", + "nullable": true, + "readOnly": true + }, + "lastSuccessfulSync": { + "allOf": [ + { + "$ref": "#/components/schemas/SyncRequestModel" + } + ], + "description": "Data about the last successful sync associated with this enrollment", + "nullable": true, + "readOnly": true + }, + "connectorInfo": { + "allOf": [ + { + "$ref": "#/components/schemas/ConnectorInfoModel" + } + ], + "description": "Optional data necessary to create an app enrollment for a supported connector.\r\nOnly enter relevant fields for the given connector.", + "nullable": true } }, "additionalProperties": false, - "description": "Company payment collected information" + "description": "An AppEnrollment represents an app that has been enrolled to the current account. When you sign up for an\r\napp using the Accounting Data Service, you obtain an enrollment record for that app. Example types of apps include\r\nconnectors and feature enhancement apps. The App Enrollment object contains information about this app, its\r\nconfiguration, and settings.\r\n \r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) for more information." }, - "CompanyIdentifierModel": { - "required": [ - "type", - "value" - ], + "AppEnrollmentModelFetchResult": { "type": "object", "properties": { - "type": { - "minLength": 1, - "type": "string", - "description": "The type of identifier." + "totalCount": { + "type": "integer", + "format": "int32", + "nullable": true }, - "value": { - "minLength": 1, + "pageSize": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "pageNumber": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppEnrollmentModel" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "AppEnrollmentReconnectInfo": { + "type": "object", + "properties": { + "username": { "type": "string", - "description": "The value of the identifier." + "description": "The username for the web services account with access permissions.", + "nullable": true }, - "jurisdiction": { + "password": { "type": "string", - "description": "The jurisdiction of the identifier.", + "description": "The password for the web services account with access permissions.", "nullable": true }, - "subjurisdiction": { + "realmId": { "type": "string", - "description": "The sub-jurisdiction of the identifier, ISO3166-1 or ISO3166-2 code.", + "description": "The Realm Id for the app enrollment to reconnect.", "nullable": true } }, "additionalProperties": false, - "description": "A model representing a company identifier." + "description": "Information to reconnect an ERP." }, - "CompanyMagicLinkSummaryModel": { + "ApplicationModel": { "required": [ - "companyName" + "appType", + "name" ], "type": "object", "properties": { - "companyId": { + "appId": { "type": "string", - "description": "The unique id for this company", - "format": "uuid" + "description": "A unique code identifying this application", + "format": "uuid", + "readOnly": true }, - "companyName": { + "name": { "maxLength": 100, - "minLength": 0, + "minLength": 1, "type": "string", - "description": "The short name of the company." + "description": "The name of this application" }, - "companyType": { - "maxLength": 20, - "minLength": 0, + "description": { + "maxLength": 500, "type": "string", - "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.", + "description": "Brief summary of this application shown as a subtitle", "nullable": true }, - "groupKey": { + "appType": { + "maxLength": 50, "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid" + "description": "Tag for what type of app this is" }, - "primaryContactName": { + "ownerId": { "type": "string", - "description": "The name of the primary contact for this company", - "nullable": true + "description": "The ID of the owner", + "format": "uuid" }, - "primaryContactEmailAddress": { + "projectUrl": { + "maxLength": 200, "type": "string", - "description": "The email of the primary contact for this company", - "nullable": true + "description": "The URL to visit for more information about this application", + "nullable": true, + "example": "https://example.com/projectUrl" }, - "pointOfContact": { + "iconUrl": { + "maxLength": 200, "type": "string", - "description": "The point of contact for this company", - "nullable": true - }, - "outstandingAmount": { - "type": "number", - "description": "The total outstanding amount for this company", - "format": "double" - }, - "amountPastDue": { - "type": "number", - "description": "The total amount past due for this company", - "format": "double" - }, - "totalOpenInvoices": { - "type": "integer", - "description": "The total number of open invoices for this company", - "format": "int32" - }, - "pastDue": { - "type": "integer", - "description": "The total number of invoices that are past due for this company", - "format": "int32" - }, - "totalVisits": { - "type": "integer", - "description": "Total number of visits for all magic links sent for this company", - "format": "int32" - }, - "linksSent": { - "type": "integer", - "description": "Total number of sent links for this company", - "format": "int32" + "description": "The URL for the icon for this application", + "nullable": true, + "example": "https://example.com/iconUrl" }, - "latestMagicLinkDate": { + "createdUserId": { "type": "string", - "description": "Created date of the most recent magic link made for this company", - "format": "date-time", - "nullable": true + "description": "The ID of the user who created this application", + "format": "uuid", + "readOnly": true }, - "latestMagicLinkId": { + "modifiedUserId": { "type": "string", - "description": "Id of the most recent magic link made for this company", + "description": "The ID of the user who last modified this application", "format": "uuid", - "nullable": true - }, - "latestMagicLinkStatus": { - "allOf": [ - { - "$ref": "#/components/schemas/MagicLinkStatus" - } - ], - "description": "Status of the most recent magic link made for this company", - "nullable": true + "readOnly": true }, - "latestMagicLinkExpirationDate": { + "created": { "type": "string", - "description": "Expiration date of the most recent magic link made for this company", + "description": "The date this application was created", "format": "date-time", - "nullable": true + "readOnly": true }, - "currencyCode": { + "modified": { "type": "string", - "description": "The currency code associated with this company based on the related invoices and payments.\r\n`Multi` - Multiple currency codes are present.", - "nullable": true + "description": "The date this application was last modified", + "format": "date-time", + "readOnly": true }, - "inviteStatus": { - "type": "string", - "description": "The invite status of this company", - "nullable": true + "isActive": { + "type": "boolean", + "description": "Flag indicating if the application is active.", + "default": true }, - "inviteStatusModified": { + "groupKey": { "type": "string", - "description": "The UTC date and time the invite status was last modified", - "format": "date-time", - "nullable": true + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", + "format": "uuid", + "readOnly": true }, - "inviteStatusModifiedUserId": { + "b2CClientId": { "type": "string", - "description": "The user id of the user who last modified the invite status", + "description": "The B2C Client ID of the application", "format": "uuid", - "nullable": true + "nullable": true, + "readOnly": true }, - "isActive": { - "type": "boolean", - "description": "This flag indicates whether the company is currently active." + "notes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NoteModel" + }, + "description": "A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the\r\n`include` parameter when retrieving data.\r\n \r\nTo create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes)\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).", + "nullable": true, + "readOnly": true + }, + "attachments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttachmentModel" + }, + "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 `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).", + "nullable": true, + "readOnly": true + }, + "customFieldDefinitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldDefinitionModel" + }, + "description": "A collection of custom fields linked to this record. To retrieve this collection, specify\r\n`CustomFieldDefinitions` 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).", + "nullable": true, + "readOnly": true + }, + "customFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldValueModel" + }, + "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).", + "nullable": true, + "readOnly": true + }, + "enrollments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppEnrollmentModel" + }, + "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).", + "nullable": true, + "readOnly": true } }, "additionalProperties": false, - "description": "A summary of companies combined with their most recent magic links" + "description": "An Application represents a feature available to customers within the Accounting Data Service. You can create\r\nApplications by working with your Accounting Data Service business development manager and publish them on the network\r\nso that customers can browse and find your Application on the Accounting Data Service Marketplace. When a\r\ncustomer adds an Application to their account, they obtain an AppEnrollment which represents that customer's\r\ninstance of this Application. The customer-specific AppEnrollment contains a customer's configuration data\r\nfor the Application, which is not customer-specific.\r\n \r\nSee [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.\n--swaggerCategory:Platform" }, - "CompanyMagicLinkSummaryModelFetchResult": { + "ApplicationModelFetchResult": { "type": "object", "properties": { "totalCount": { @@ -22882,468 +17823,485 @@ "records": { "type": "array", "items": { - "$ref": "#/components/schemas/CompanyMagicLinkSummaryModel" + "$ref": "#/components/schemas/ApplicationModel" }, "nullable": true } }, "additionalProperties": false }, - "CompanyModel": { - "required": [ - "companyName" - ], + "AttachmentLinkModel": { "type": "object", "properties": { - "companyId": { + "groupKey": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "readOnly": true }, - "companyName": { - "maxLength": 100, - "minLength": 1, + "attachmentId": { "type": "string", - "description": "The short name of the company." + "description": "The unique ID of an attachment record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.", + "format": "uuid" }, - "erpKey": { - "maxLength": 100, - "minLength": 0, + "objectKey": { "type": "string", - "description": "The unique ID of this record as it was known in its originating financial system.\r\n \r\nIf this company 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).", - "nullable": true + "description": "An Attachment is connected to an existing item within the Accounting Data Service by the fields `TableKey` and\r\n`ObjectKey`. For example, an Attachment 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 Accounting Data Service to which this\r\nAttachment 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).", + "format": "uuid" }, - "companyType": { - "maxLength": 20, + "tableKey": { + "maxLength": 40, "minLength": 0, "type": "string", - "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.", + "description": "An Attachment is connected to an existing item within the Accounting Data Service by the fields `TableKey` and\r\n`ObjectKey`. For example, an Attachment 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 Accounting Data Service to which this Attachment\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).", "nullable": true }, - "parentCompanyId": { - "type": "string", - "description": "If this business entity is part of an organization, this value is non-null and it is set\r\nto the `CompanyId` value of the parent company of this business entity.\r\n \r\nIf this value is null, this business entity is a standalone.", - "format": "uuid", - "nullable": true, - "deprecated": true - }, - "enterpriseId": { + "created": { "type": "string", - "description": "For convenience, this field indicates the top-level parent company. This can be used\r\nto jump directly to the top parent in complex organizational hierarchies.", - "format": "uuid", - "deprecated": true + "description": "The date the Attachment Link was created.", + "format": "date-time", + "readOnly": true }, - "groupKey": { + "createdUserId": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The unique ID of the [UserAccount](https://developer.lockstep.io/docs/useraccountmodel) of the user\r\nwho created this Attachment Link.", "format": "uuid", "readOnly": true + } + }, + "additionalProperties": false, + "description": "An Attachment Link represents a single link between any nestable object and an attachment" + }, + "AttachmentLinkModelFetchResult": { + "type": "object", + "properties": { + "totalCount": { + "type": "integer", + "format": "int32", + "nullable": true }, - "isActive": { - "type": "boolean", - "description": "This flag indicates whether the company is currently active. An inactive company\r\nshould be hidden from the user interface but will still be available for querying." - }, - "defaultCurrencyCode": { - "maxLength": 3, - "minLength": 0, - "type": "string", - "description": "The default currency code used by this business entity. This value can be overridden\r\nfor invoices in a different currency code.\r\n \r\nFor a list of defined currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies)", - "nullable": true - }, - "companyLogoUrl": { - "maxLength": 512, - "minLength": 0, - "type": "string", - "description": "The URL of this company's logo, if known.", - "nullable": true, - "deprecated": true - }, - "companyLogoStatus": { - "allOf": [ - { - "$ref": "#/components/schemas/ScanStatus" - } - ], - "description": "The scan status of the company's logo, if it exists", - "nullable": true, - "deprecated": true - }, - "primaryContactId": { - "type": "string", - "description": "The ADS Platform `ContactId` of the primary contact for this company.", - "format": "uuid", + "pageSize": { + "type": "integer", + "format": "int32", "nullable": true }, - "address1": { - "maxLength": 170, - "minLength": 0, - "type": "string", - "description": "Address info", - "nullable": true, - "deprecated": true + "pageNumber": { + "type": "integer", + "format": "int32", + "nullable": true }, - "address2": { - "maxLength": 170, - "minLength": 0, + "records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttachmentLinkModel" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "AttachmentModel": { + "required": [ + "objectKey", + "tableKey" + ], + "type": "object", + "properties": { + "attachmentId": { "type": "string", - "description": "Address info", - "nullable": true, - "deprecated": true + "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.", + "format": "uuid", + "readOnly": true }, - "address3": { - "maxLength": 170, - "minLength": 0, + "groupKey": { "type": "string", - "description": "Address info", - "nullable": true, - "deprecated": true + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", + "format": "uuid", + "readOnly": true }, - "address4": { - "maxLength": 170, - "minLength": 0, + "tableKey": { + "maxLength": 40, + "minLength": 1, "type": "string", - "description": "Address info", - "nullable": true, - "deprecated": true + "description": "An Attachment is connected to an existing item within the Accounting Data Service by the fields `TableKey` and\r\n`ObjectKey`. For example, an Attachment 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 Accounting Data Service to which this Attachment\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).", + "readOnly": true }, - "city": { - "maxLength": 100, - "minLength": 0, + "objectKey": { + "minLength": 1, "type": "string", - "description": "Address info", - "nullable": true, - "deprecated": true + "description": "An Attachment is connected to an existing item within the Accounting Data Service by the fields `TableKey` and\r\n`ObjectKey`. For example, an Attachment 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 Accounting Data Service to which this\r\nAttachment 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).", + "format": "uuid", + "readOnly": true }, - "stateRegion": { - "maxLength": 60, + "fileName": { + "maxLength": 200, "minLength": 0, "type": "string", - "description": "Address info", + "description": "An Attachment represents a file that was uploaded to the Accounting Data Service. This field contains the original\r\nname of the file on disk, without its extension.", "nullable": true, - "deprecated": true + "readOnly": true }, - "postalCode": { - "maxLength": 10, + "fileExt": { + "maxLength": 20, "minLength": 0, "type": "string", - "description": "Address info", - "nullable": true, - "deprecated": true - }, - "country": { - "maxLength": 100, - "type": "string", - "description": "Address info", + "description": "An Attachment represents a file that was uploaded to the Accounting Data Service. This field contains the original\r\nextension name of the file on disk.", "nullable": true, - "deprecated": true + "readOnly": true }, - "timeZone": { - "maxLength": 40, - "minLength": 0, - "type": "string", - "description": "Time zone", - "nullable": true, - "deprecated": true + "isArchived": { + "type": "boolean", + "description": "A flag indicating whether this Attachment is archived (also known as hidden or deleted). When you call\r\n[ArchiveAttachment](https://developer.lockstep.io/reference/delete_api-v1-attachments-id) this field will\r\nbe set to true.\r\n \r\nYou should avoid displaying Attachments with the IsArchived field set to true in your user interface." }, - "phoneNumber": { - "maxLength": 20, - "minLength": 0, + "erpKey": { "type": "string", - "description": "Phone number", + "description": "The unique ID of this record as it was known in its originating financial system.\r\n \r\nIf this company 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 from a financial system, this value will be `null`.\r\n \r\nFor more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).", "nullable": true, - "deprecated": true + "readOnly": true }, - "faxNumber": { - "maxLength": 20, - "minLength": 0, + "appEnrollmentId": { "type": "string", - "description": "Fax number", + "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.", + "format": "uuid", "nullable": true, - "deprecated": true + "readOnly": true }, "created": { "type": "string", - "description": "The date this company was created", + "description": "The date the attachment was created.", "format": "date-time", "readOnly": true }, "createdUserId": { "type": "string", - "description": "The ID of the user who created this company", + "description": "The unique ID of the [UserAccount](https://developer.lockstep.io/docs/useraccountmodel) of the user\r\nwho created this Attachment.", "format": "uuid", "readOnly": true }, "modified": { "type": "string", - "description": "The date this company was last modified", + "description": "The date the attachment was modified.", "format": "date-time", "readOnly": true }, "modifiedUserId": { "type": "string", - "description": "The ID of the user who last modified this company", + "description": "The unique ID of the [UserAccount](https://developer.lockstep.io/docs/useraccountmodel) of the user\r\nwho modified this Attachment.", "format": "uuid", "readOnly": true }, - "taxId": { - "maxLength": 30, - "minLength": 0, - "type": "string", - "description": "Federal Tax ID", - "nullable": true, - "deprecated": true - }, - "dunsNumber": { - "maxLength": 10, - "minLength": 0, - "type": "string", - "description": "Dun & Bradstreet Number", - "nullable": true, - "deprecated": true - }, - "apEmailAddress": { - "maxLength": 254, - "minLength": 0, - "type": "string", - "description": "AP (Accounts Payable) Email Address", - "format": "email", - "nullable": true, - "deprecated": true - }, - "arEmailAddress": { - "maxLength": 254, - "minLength": 0, - "type": "string", - "description": "AR (Accounts Receivable) Email Address", - "format": "email", - "nullable": true, - "deprecated": true - }, - "preferredDeliveryMethod": { - "maxLength": 20, + "attachmentType": { + "maxLength": 100, "minLength": 0, "type": "string", - "description": "Indicates the preferred invoice delivery method. Examples include Print, Email, Fax", - "nullable": true, - "deprecated": true + "description": "A text string describing the type of this Attachment.", + "nullable": true }, - "domainName": { - "maxLength": 254, - "minLength": 0, + "uploadStatus": { + "enum": [ + "Upload Pending", + "Uploaded", + "Upload Failed", + "Upload Error" + ], "type": "string", - "description": "For companies that use a custom domain name for their email system, this is\r\nthe domain name used by this company. If this value is known, new emails that\r\ncome in from this domain will be connected to this company.", - "nullable": true, - "deprecated": true + "allOf": [ + { + "$ref": "#/components/schemas/ScanStatus" + } + ], + "description": "The different statuses of an attachment being scanned for viruses.", + "format": "", + "readOnly": true + } + }, + "additionalProperties": false, + "description": "An Attachment is a file that can be attached to various account attributes within ADS.\r\nThis data model contains metadata about the attachment. You can upload and download attachments\r\ninto the Accounting Data Service along with this metadata. Attachments can be used for invoices, payments,\r\nlegal documents, or any other external files that you wish to track.\r\n \r\nSee [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information." + }, + "AttachmentModelFetchResult": { + "type": "object", + "properties": { + "totalCount": { + "type": "integer", + "format": "int32", + "nullable": true }, - "companyClassificationCodeDefId": { - "type": "string", - "description": "Identifier for classification of this company.", - "format": "uuid", - "nullable": true, - "deprecated": true + "pageSize": { + "type": "integer", + "format": "int32", + "nullable": true }, - "description": { - "maxLength": 254, - "minLength": 0, - "type": "string", - "description": "Description of the company.", - "nullable": true, - "deprecated": true + "pageNumber": { + "type": "integer", + "format": "int32", + "nullable": true }, - "website": { - "maxLength": 512, - "minLength": 0, + "records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttachmentModel" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "BaseCurrencySyncModel": { + "required": [ + "baseCurrencyCode" + ], + "type": "object", + "properties": { + "baseCurrencyCode": { "type": "string", - "description": "Website URL for this company.", - "nullable": true, - "deprecated": true - }, + "description": "The default currency code used by this business entity.\r\n \r\nFor a list of defined currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies)" + } + }, + "additionalProperties": { }, + "description": "The BaseCurrencySyncModel represents information coming into ADS 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 BaseCurrencySyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be used to update the Group Account base currency code.\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." + }, + "BatchSyncModel": { + "type": "object", + "properties": { "appEnrollmentId": { "type": "string", - "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.", + "description": "The optional existing app enrollment to associate with the data in this batch.", "format": "uuid", - "nullable": true, - "readOnly": true + "nullable": true }, - "emailAddress": { - "maxLength": 254, - "minLength": 0, - "type": "string", - "description": "Company Email Address", - "format": "email", + "isFullSync": { + "type": "boolean", + "description": "True if this is a full sync, false if this is a partial sync. Defaults to false.", + "default": false + }, + "currentBatch": { + "type": "integer", + "description": "The optional current batch number for this batch sync.", + "format": "int32", + "default": 1, "nullable": true }, - "publicUrlSlug": { - "maxLength": 100, - "minLength": 0, + "totalBatches": { + "type": "integer", + "description": "The optional total number of batchs for this batch sync.", + "format": "int32", + "default": 1, + "nullable": true + }, + "parentSyncRequestId": { "type": "string", - "description": "The public url slug for the Company.", - "nullable": true, - "deprecated": true + "description": "The optional existing parent sync request id for the batch sync.", + "format": "uuid", + "nullable": true }, - "primaryContactSet": { - "type": "boolean", - "description": "Indicates if the primary contact has been set by the user.", - "readOnly": true, - "deprecated": true + "companies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CompanySyncModel" + }, + "description": "A list of Company records to merge with your Accounting Data Service data", + "nullable": true }, - "stateTaxId": { - "maxLength": 20, - "minLength": 0, - "type": "string", - "description": "State Tax ID", - "nullable": true, - "deprecated": true + "contacts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ContactSyncModel" + }, + "description": "A list of Contact records to merge with your Accounting Data Service data", + "nullable": true }, - "stateOfIncorporation": { - "maxLength": 20, - "minLength": 0, - "type": "string", - "description": "The state where the company was registered.", - "nullable": true, - "deprecated": true + "creditMemoApplications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CreditMemoAppliedSyncModel" + }, + "description": "A list of CreditMemoApplied records to merge with your Accounting Data Service data", + "nullable": true }, - "linkedInUrlSlug": { - "maxLength": 100, - "minLength": 0, - "type": "string", - "description": "Linkedin Url", - "nullable": true, - "deprecated": true + "invoices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InvoiceSyncModel" + }, + "description": "A list of Invoice records to merge with your Accounting Data Service data", + "nullable": true }, - "isVerified": { - "type": "boolean", - "description": "This flag indicates whether the company is verified.", - "default": false, - "readOnly": true, - "deprecated": true + "invoiceLines": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InvoiceLineSyncModel" + }, + "description": "A list of InvoiceLine records to merge with your Accounting Data Service data", + "nullable": true }, - "lastVerifiedDate": { - "type": "string", - "description": "The date this company was last verified.", - "format": "date-time", - "nullable": true, - "readOnly": true, - "deprecated": true + "invoiceWorkflowStatuses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InvoiceWorkflowStatusSyncModel" + }, + "description": "A list of InvoiceWorkflowStatus records to merge with your Accounting Data Service data", + "nullable": true }, - "viewBoxSettings": { - "allOf": [ - { - "$ref": "#/components/schemas/ViewBoxSettingsModel" - } - ], - "description": "View box settings for the company logo.", - "nullable": true, - "readOnly": true, - "deprecated": true + "customFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSyncModel" + }, + "description": "A list of CustomField records to merge with your Accounting Data Service data", + "nullable": true }, - "serviceFabricOrgId": { - "type": "string", - "description": "The unique ID of the Service Fabric organisation to which this record belongs.", - "format": "uuid", - "nullable": true, - "readOnly": true + "payments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentSyncModel" + }, + "description": "A list of Payment records to merge with your Accounting Data Service data", + "nullable": true }, - "serviceFabricCompanyId": { - "type": "string", - "description": "The unique ID of this record within Service Fabric.", - "format": "uuid", - "nullable": true, - "readOnly": true + "paymentApplications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentAppliedSyncModel" + }, + "description": "A list of PaymentApplied records to merge with your Accounting Data Service data", + "nullable": true }, - "companyRegistrationNumber": { - "maxLength": 20, - "minLength": 0, - "type": "string", - "description": "A unique identification number assigned to the company by the national registration office.", - "nullable": true, - "deprecated": true + "financialYearSettings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FinancialYearSettingSyncModel" + }, + "description": "A list of FinancialYearSetting records to merge with your Accounting Data Service data", + "nullable": true }, - "profileReferenceId": { - "type": "string", - "description": "An optional reference to a real company, making this a profile.", - "format": "uuid", - "nullable": true, - "readOnly": true, - "deprecated": true + "financialAccounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FinancialAccountSyncModel" + }, + "description": "A list of FinancialAccount records to merge with your Accounting Data Service data", + "nullable": true }, - "companyIdentifiers": { + "financialAccountBalanceHistories": { "type": "array", "items": { - "$ref": "#/components/schemas/CompanyIdentifierModel" + "$ref": "#/components/schemas/FinancialAccountBalanceHistorySyncModel" }, - "description": "Company identifiers for this company.", - "nullable": true, - "deprecated": true + "description": "A list of FinancialAccountBalanceHistory records to merge with your Accounting Data Service data", + "nullable": true }, - "notes": { + "baseCurrencies": { "type": "array", "items": { - "$ref": "#/components/schemas/NoteModel" + "$ref": "#/components/schemas/BaseCurrencySyncModel" }, - "description": "A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the\r\n`include` parameter when retrieving data.\r\n \r\nTo create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes)\r\nendpoint with the `TableKey` to `Company` and the `ObjectKey` set to the `CompanyId` 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).", - "nullable": true, - "readOnly": true + "description": "A list of BaseCurrency records to merge with your Accounting Data Service data", + "nullable": true }, - "attachments": { + "journalEntries": { "type": "array", "items": { - "$ref": "#/components/schemas/AttachmentModel" + "$ref": "#/components/schemas/JournalEntrySyncModel" }, - "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 `Company` and the `ObjectKey` set to the `CompanyId` 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).", - "nullable": true, - "readOnly": true + "description": "A list of JournalEntry records to merge with your Accounting Data Service data", + "nullable": true }, - "contacts": { + "journalEntryLines": { "type": "array", "items": { - "$ref": "#/components/schemas/ContactModel" + "$ref": "#/components/schemas/JournalEntryLineSyncModel" }, - "description": "All contacts attached to this company.\r\n \r\nTo retrieve this collection, specify `Contacts` in the \"Include\" parameter for your query.", - "nullable": true, + "description": "A list of JournalEntryLine records to merge with your Accounting Data Service data", + "nullable": true + } + }, + "additionalProperties": false, + "description": "A BatchSyncModel contains a collection of records to load into the Accounting Data Service. Data contained\r\nin this batch will be merged with your existing data. Each record will be matched with existing data inside\r\nthe Accounting Data Service using the [Identity Column](https://developer.lockstep.io/docs/identity-columns) rules.\r\nAny record that represents a new AppEnrollmentId+ErpKey will be inserted. A record that matches an existing\r\nAppEnrollmentId+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. ADS 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." + }, + "BulkDeleteRequestModel": { + "required": [ + "idsToDelete" + ], + "type": "object", + "properties": { + "idsToDelete": { + "minItems": 1, + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "description": "Represents the IDs to be deleted" + } + }, + "additionalProperties": false, + "description": "Represents a bulk delete request in the API" + }, + "CodeDefinitionModel": { + "type": "object", + "properties": { + "codeDefinitionId": { + "type": "string", + "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.", + "format": "uuid", + "readOnly": true + }, + "groupKey": { + "type": "string", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", + "format": "uuid", "readOnly": true }, - "invoices": { - "type": "array", - "items": {}, - "description": "All invoices attached to this company.\r\n \r\nTo 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).", - "nullable": true, + "codeType": { + "maxLength": 40, + "minLength": 0, + "type": "string", + "description": "The type of the Code Definition", + "nullable": true + }, + "code": { + "maxLength": 40, + "minLength": 0, + "type": "string", + "description": "The Code to be defined.", + "nullable": true + }, + "codeDescription": { + "maxLength": 200, + "minLength": 0, + "type": "string", + "description": "The definition of the Code", + "nullable": true + }, + "created": { + "type": "string", + "description": "The date that the Code Definition was created", + "format": "date-time", "readOnly": true }, - "customFieldDefinitions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldDefinitionModel" - }, - "description": "A collection of custom fields linked to this record. To retrieve this collection, specify\r\n`CustomFieldDefinitions` 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 `Company` and the `ObjectKey` set to the `CompanyId` 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).", - "nullable": true, + "createdUserId": { + "type": "string", + "description": "The ID of the user who created the Code Definition", + "format": "uuid", "readOnly": true }, - "customFieldValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldValueModel" - }, - "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 `Company` and the `ObjectKey` set to the `CompanyId` 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).", - "nullable": true, + "modified": { + "type": "string", + "description": "The date the Code Definition was last modified", + "format": "date-time", "readOnly": true }, - "companyClassificationCodeDefinition": { - "allOf": [ - { - "$ref": "#/components/schemas/CodeDefinitionModel" - } - ], - "description": "Classification code definition for this company.\r\n \r\nTo retrieve this collection, specify `Classification` in the \"Include\" parameter for your query.", - "nullable": true, + "modifiedUserId": { + "type": "string", + "description": "The ID of the user who last modified the Code Definition", + "format": "uuid", "readOnly": true } }, "additionalProperties": false, - "description": "A Company represents a customer, a vendor, or a company within the organization of the account holder.\r\nCompanies can have parents and children, representing an organizational hierarchy of corporate entities.\r\nYou can use Companies to track projects and financial data under this Company label.\r\n \r\nSee [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information." + "description": "Represents a Code Definition. Codes can be used as shortened, human readable strings.\r\nAdditionally, this table can be used to store lists of system values for Accounting Data Service objects." }, - "CompanyModelFetchResult": { + "CodeDefinitionModelFetchResult": { "type": "object", "properties": { "totalCount": { @@ -23364,506 +18322,767 @@ "records": { "type": "array", "items": { - "$ref": "#/components/schemas/CompanyModel" + "$ref": "#/components/schemas/CodeDefinitionModel" }, "nullable": true } }, "additionalProperties": false }, - "CompanySyncModel": { - "required": [ - "companyName", - "companyType", - "erpKey", - "isActive" - ], + "CompanyDetailsModel": { "type": "object", "properties": { - "onMatchAction": { - "allOf": [ - { - "$ref": "#/components/schemas/MatchAction" - } - ], - "description": "Indicates what action to take when an existing object has been found during the sync process." + "groupKey": { + "type": "string", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", + "format": "uuid" }, - "networkId": { + "customerId": { "type": "string", - "description": "The unique identifier of this object in the Sage Network platform.", - "format": "uuid", + "description": "The unique ID of this company", + "format": "uuid" + }, + "name": { + "type": "string", + "description": "The unique ID of this company", "nullable": true }, - "erpKey": { + "address1": { "type": "string", - "description": "This is the primary key of the Company record. For this field, you should use whatever the company's unique\r\nidentifying number is in the originating system. Search for a unique, non-changing number within the\r\noriginating financial system for this record.\r\n \r\nExample: If you store your company records in a database, whatever the primary key for the company table is\r\nin the database should be the `ErpKey`.\r\n \r\nExample: If you use a financial system such as QuickBooks or Xero, look for the primary ID number of the\r\ncompany record within that financial system.\r\n \r\nFor more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns)." + "description": "Company address info", + "nullable": true }, - "companyName": { + "address2": { "type": "string", - "description": "A friendly, short name of the company." + "description": "Company address info", + "nullable": true }, - "companyType": { + "address3": { "type": "string", - "description": "This field indicates the type of company. It can be one of a limited number of values: `Company`,\r\n`Customer`, `Group`, `Vendor`, or `Third Party`. A company that represents both a customer and a vendor is\r\nidentified as a `CustomerVendor`.\r\n \r\nWhen loading data into ADS, you should focus on the distinction between a company that is part of\r\nyour own enterprise, or a company that is external to your enterprise.\r\n \r\nFor a company that is within your enterprise, you should set this value to be `Company`.\r\n \r\nFor a company that is external to your enterprise, you should set this value to either `Customer`,\r\n`Vendor`, `Third Party`, or `CustomerVendor`. If you don't know what value to choose, select\r\n`CustomerVendor`." + "description": "Company address info", + "nullable": true }, - "parentCompanyErpKey": { + "city": { "type": "string", - "description": "If this company has a parent company, identify the parent company's `ErpKey` value here. This value should\r\nbe the original primary key or unique ID of the parent company to this company belongs. This value should\r\nmatch the original ErpKey field on the parent company.\r\n \r\nIf this company is not a child company, leave this field null.", + "description": "Company address info", "nullable": true }, - "parentCompanyNetworkId": { + "state": { "type": "string", - "description": "The network id of the parent Company.", + "description": "Company address info", + "nullable": true + }, + "postalCode": { + "type": "string", + "description": "Company address info", + "nullable": true + }, + "country": { + "type": "string", + "description": "Company address country", + "nullable": true + }, + "phoneNumber": { + "type": "string", + "description": "Company phone number", + "nullable": true + }, + "faxNumber": { + "type": "string", + "description": "Company fax number", + "nullable": true + }, + "email": { + "type": "string", + "description": "Company email address", + "nullable": true + }, + "contactId": { + "type": "string", + "description": "Company primary contact id", + "format": "uuid" + }, + "contactName": { + "type": "string", + "description": "Company primary contact name", + "nullable": true + }, + "contactEmail": { + "type": "string", + "description": "Company primary contact email address", + "nullable": true + }, + "outstandingInvoices": { + "type": "integer", + "description": "Company number of outstanding invoices", + "format": "int32", + "deprecated": true + }, + "groupBaseCurrencyCode": { + "type": "string", + "description": "The group's base currency code.", + "nullable": true, + "deprecated": true + }, + "outstandingAmount": { + "type": "number", + "description": "Company total outstanding invoice amount in the group's base currency.", + "format": "double", + "deprecated": true + }, + "amountPastDue": { + "type": "number", + "description": "Company total past due amount in the group's base currency.", + "format": "double", + "deprecated": true + }, + "payments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CompanyDetailsPaymentModel" + }, + "description": "Company payments collected", + "nullable": true, + "deprecated": true + } + }, + "additionalProperties": false, + "description": "Contains company details data" + }, + "CompanyDetailsPaymentModel": { + "type": "object", + "properties": { + "groupKey": { + "type": "string", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", + "format": "uuid" + }, + "paymentId": { + "type": "string", + "description": "Unique identifier for payment", + "format": "uuid" + }, + "paymentAppliedId": { + "type": "string", + "description": "Unique identifier for payment applied", "format": "uuid", "nullable": true }, - "isActive": { - "type": "boolean", - "description": "This flag indicates whether the company is currently active. An inactive company will be hidden from the\r\nuser interface but will still be available for querying." + "paymentType": { + "type": "string", + "description": "Payment type", + "nullable": true }, - "defaultCurrencyCode": { + "invoiceId": { "type": "string", - "description": "The default currency code for transactions related to this company. For a list of currency codes, see\r\n[Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies).", + "description": "Unique identifier for invoice payment is associated with", + "format": "uuid", "nullable": true }, - "companyLogoUrl": { + "invoiceTypeCode": { "type": "string", - "description": "The URL of this company's logo, if known.", + "description": "Invoice type payment is associated with", "nullable": true }, - "primaryContactErpKey": { + "invoiceReferenceCode": { + "type": "string", + "description": "Invoice reference code payment is associated with", + "nullable": true + }, + "invoiceCurrencyCode": { + "type": "string", + "description": "The currency code of the invoice the payment is associated with.", + "nullable": true + }, + "invoiceTotalAmount": { + "type": "number", + "description": "Invoice total amount payment is associated with", + "format": "double" + }, + "paymentDate": { + "type": "string", + "description": "Date payment placed", + "format": "date-time" + }, + "paymentCurrencyCode": { + "type": "string", + "description": "The currency code of the payment.", + "nullable": true + }, + "paymentAmount": { + "type": "number", + "description": "Amount payment was made for", + "format": "double" + } + }, + "additionalProperties": false, + "description": "Company payment collected information" + }, + "CompanyIdentifierModel": { + "required": [ + "type", + "value" + ], + "type": "object", + "properties": { + "type": { + "minLength": 1, "type": "string", - "description": "The `ErpKey` of the primary contact for this company. This value should match the `ErpKey` value of the\r\n[Importing Contacts](https://developer.lockstep.io/docs/importing-contacts) record for the contact table.", - "nullable": true + "description": "The type of identifier." }, - "primaryContactNetworkId": { + "value": { + "minLength": 1, "type": "string", - "description": "The network id of the primary Contact.", - "format": "uuid", - "nullable": true + "description": "The value of the identifier." }, - "address1": { + "jurisdiction": { "type": "string", - "description": "The company's primary mailing address information", + "description": "The jurisdiction of the identifier.", "nullable": true }, - "address2": { + "subjurisdiction": { "type": "string", - "description": "The company's primary mailing address information", + "description": "The sub-jurisdiction of the identifier, ISO3166-1 or ISO3166-2 code.", "nullable": true + } + }, + "additionalProperties": false, + "description": "A model representing a company identifier." + }, + "CompanyMagicLinkSummaryModel": { + "required": [ + "companyName" + ], + "type": "object", + "properties": { + "companyId": { + "type": "string", + "description": "The unique id for this company", + "format": "uuid" }, - "address3": { + "companyName": { + "maxLength": 100, + "minLength": 0, "type": "string", - "description": "The company's primary mailing address information", - "nullable": true + "description": "The short name of the company." }, - "address4": { + "companyType": { + "maxLength": 20, + "minLength": 0, "type": "string", - "description": "The company's primary mailing address information", + "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.", "nullable": true }, - "city": { + "groupKey": { "type": "string", - "description": "The company's primary mailing address information", - "nullable": true + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", + "format": "uuid" }, - "stateRegion": { + "primaryContactName": { "type": "string", - "description": "The company's primary mailing address information", + "description": "The name of the primary contact for this company", "nullable": true }, - "postalCode": { + "primaryContactEmailAddress": { "type": "string", - "description": "The company's primary mailing address information", + "description": "The email of the primary contact for this company", "nullable": true }, - "country": { + "pointOfContact": { "type": "string", - "description": "The company's primary mailing address information", + "description": "The point of contact for this company", "nullable": true }, - "phoneNumber": { + "outstandingAmount": { + "type": "number", + "description": "The total outstanding amount for this company", + "format": "double" + }, + "amountPastDue": { + "type": "number", + "description": "The total amount past due for this company", + "format": "double" + }, + "totalOpenInvoices": { + "type": "integer", + "description": "The total number of open invoices for this company", + "format": "int32" + }, + "pastDue": { + "type": "integer", + "description": "The total number of invoices that are past due for this company", + "format": "int32" + }, + "totalVisits": { + "type": "integer", + "description": "Total number of visits for all magic links sent for this company", + "format": "int32" + }, + "linksSent": { + "type": "integer", + "description": "Total number of sent links for this company", + "format": "int32" + }, + "latestMagicLinkDate": { "type": "string", - "description": "The main phone number of this company.", + "description": "Created date of the most recent magic link made for this company", + "format": "date-time", "nullable": true }, - "faxNumber": { + "latestMagicLinkId": { "type": "string", - "description": "The main fax number of this company.", + "description": "Id of the most recent magic link made for this company", + "format": "uuid", "nullable": true }, - "created": { - "type": "string", - "description": "If known, the date when this record was created according to the originating financial system\r\nin which this record is maintained. If the originating financial system does not maintain a\r\ncreated-date, leave this field null.", - "format": "date-time", + "latestMagicLinkStatus": { + "allOf": [ + { + "$ref": "#/components/schemas/MagicLinkStatus" + } + ], + "description": "Status of the most recent magic link made for this company", "nullable": true }, - "modified": { + "latestMagicLinkExpirationDate": { "type": "string", - "description": "If known, the date when this record was most recently modified according to the originating\r\nfinancial system in which this record is maintained. If the originating financial system does\r\nnot maintain a most-recently-modified-date, leave this field null.", + "description": "Expiration date of the most recent magic link made for this company", "format": "date-time", "nullable": true }, - "taxId": { + "currencyCode": { "type": "string", - "description": "The company's Tax ID number for the appropriate government for this company.", + "description": "The currency code associated with this company based on the related invoices and payments.\r\n`Multi` - Multiple currency codes are present.", "nullable": true }, - "dunsNumber": { + "inviteStatus": { "type": "string", - "description": "The Dun and Bradstreet number for this company, if known.", + "description": "The invite status of this company", "nullable": true }, - "apEmailAddress": { - "type": "string", - "description": "If you know the AP (accounts payable) email address of this company, fill it in here. This is the email\r\naddress where you would send questions to the company if the company owed you money.", - "nullable": true, - "deprecated": true - }, - "arEmailAddress": { + "inviteStatusModified": { "type": "string", - "description": "If you know the AR (accounts receivable) email address of this company, fill it in here. This is the email\r\naddress where you would send questions to the company if you owed this company money.", - "nullable": true, - "deprecated": true + "description": "The UTC date and time the invite status was last modified", + "format": "date-time", + "nullable": true }, - "preferredDeliveryMethod": { + "inviteStatusModifiedUserId": { "type": "string", - "description": "Indicates the preferred invoice delivery method. Examples include Print, Email, Fax", + "description": "The user id of the user who last modified the invite status", + "format": "uuid", "nullable": true }, - "emailAddress": { - "type": "string", - "description": "The company email address.", + "isActive": { + "type": "boolean", + "description": "This flag indicates whether the company is currently active." + } + }, + "additionalProperties": false, + "description": "A summary of companies combined with their most recent magic links" + }, + "CompanyMagicLinkSummaryModelFetchResult": { + "type": "object", + "properties": { + "totalCount": { + "type": "integer", + "format": "int32", "nullable": true }, - "externalReference": { - "type": "string", - "description": "An external reference that identifies the Company from the originating ERP system, separate from the ErpKey.", + "pageSize": { + "type": "integer", + "format": "int32", "nullable": true }, - "companyRegistrationNumber": { - "type": "string", - "description": "A unique identification number assigned to the company by the national registration office.", + "pageNumber": { + "type": "integer", + "format": "int32", "nullable": true }, - "companyIdentifiers": { - "type": "string", - "description": "The set of identifiers for the Company.", + "records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CompanyMagicLinkSummaryModel" + }, "nullable": true } }, - "additionalProperties": {}, - "description": "The CompanySyncModel represents information coming into ADS 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 CompanySyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the ADS Platform API as a [CompanyModel](https://developer.lockstep.io/docs/companymodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." + "additionalProperties": false }, - "ConnectorInfoModel": { + "CompanyModel": { + "required": [ + "companyName" + ], "type": "object", "properties": { - "authCode": { + "companyId": { "type": "string", - "description": "The authorization code returned from the first step of the OAuth2 flow\r\nhttps://oauth.net/2/grant-types/authorization-code/", - "default": null, - "nullable": true + "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", + "format": "uuid", + "readOnly": true }, - "tokenId": { + "companyName": { + "maxLength": 100, + "minLength": 1, "type": "string", - "description": "The access token id for the connector enrollment.", - "default": null, - "nullable": true + "description": "The short name of the company." }, - "tokenSecret": { + "erpKey": { + "maxLength": 100, + "minLength": 0, "type": "string", - "description": "The access token secret for the connector enrollment.", - "default": null, + "description": "The unique ID of this record as it was known in its originating financial system.\r\n \r\nIf this company 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).", "nullable": true }, - "realmId": { + "companyType": { + "maxLength": 20, + "minLength": 0, "type": "string", - "description": "The realm id of the account being granted permissions to access", - "default": null, + "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.", "nullable": true }, - "subsidiaryId": { + "parentCompanyId": { "type": "string", - "description": "The subsidiary id that corresponds to a legal entity.", - "default": null, - "nullable": true + "description": "If this business entity is part of an organization, this value is non-null and it is set\r\nto the `CompanyId` value of the parent company of this business entity.\r\n \r\nIf this value is null, this business entity is a standalone.", + "format": "uuid", + "nullable": true, + "deprecated": true }, - "redirectUri": { + "enterpriseId": { "type": "string", - "description": "The redirect uri used for step one of the OAuth2.0 flow.", - "default": null, - "nullable": true + "description": "For convenience, this field indicates the top-level parent company. This can be used\r\nto jump directly to the top parent in complex organizational hierarchies.", + "format": "uuid", + "deprecated": true }, - "email": { + "groupKey": { "type": "string", - "description": "The email an email connection is being created for.", - "default": null, - "nullable": true + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", + "format": "uuid", + "readOnly": true }, - "username": { + "isActive": { + "type": "boolean", + "description": "This flag indicates whether the company is currently active. An inactive company\r\nshould be hidden from the user interface but will still be available for querying." + }, + "defaultCurrencyCode": { + "maxLength": 3, + "minLength": 0, "type": "string", - "description": "The username of the web services account with access permissions.", - "default": null, + "description": "The default currency code used by this business entity. This value can be overridden\r\nfor invoices in a different currency code.\r\n \r\nFor a list of defined currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies)", "nullable": true }, - "password": { + "companyLogoUrl": { + "maxLength": 512, + "minLength": 0, "type": "string", - "description": "The password for the web services account with access permissions.", - "default": null, - "nullable": true + "description": "The URL of this company's logo, if known.", + "nullable": true, + "deprecated": true + }, + "companyLogoStatus": { + "allOf": [ + { + "$ref": "#/components/schemas/ScanStatus" + } + ], + "description": "The scan status of the company's logo, if it exists", + "nullable": true, + "deprecated": true }, - "serverName": { + "primaryContactId": { "type": "string", - "description": "The server name a connection is being created for.", - "default": null, - "nullable": true - }, - "serverPort": { - "type": "integer", - "description": "The port number of the server a connection is being created for.", - "format": "int32", - "default": null, + "description": "The Accounting Data Service `ContactId` of the primary contact for this company. This contact must belong to this company.", + "format": "uuid", "nullable": true }, - "clientId": { + "address1": { + "maxLength": 170, + "minLength": 0, "type": "string", - "description": "The Client Id for the connection being created.", - "default": null, - "nullable": true + "description": "Address info", + "nullable": true, + "deprecated": true }, - "clientSecret": { + "address2": { + "maxLength": 170, + "minLength": 0, "type": "string", - "description": "The Secret for the connection being created.", - "default": null, - "nullable": true + "description": "Address info", + "nullable": true, + "deprecated": true }, - "tenant": { + "address3": { + "maxLength": 170, + "minLength": 0, "type": "string", - "description": "The TenantId for the connection being created.", - "default": null, - "nullable": true + "description": "Address info", + "nullable": true, + "deprecated": true }, - "authToken": { - "type": "string", - "description": "The AuthToken for the connection being created.", - "default": null, - "nullable": true - } - }, - "additionalProperties": false, - "description": "Represents all possible data required to set up an app enrollment for a connector.\r\nOnly send required fields for the given connector." - }, - "ContactModel": { - "required": [ - "contactName" - ], - "type": "object", - "properties": { - "contactId": { + "address4": { + "maxLength": 170, + "minLength": 0, "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", - "format": "uuid", - "readOnly": true + "description": "Address info", + "nullable": true, + "deprecated": true }, - "companyId": { + "city": { + "maxLength": 100, + "minLength": 0, "type": "string", - "description": "The ID of the company to which this contact belongs.", - "format": "uuid" + "description": "Address info", + "nullable": true, + "deprecated": true }, - "groupKey": { + "stateRegion": { + "maxLength": 60, + "minLength": 0, "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid", - "readOnly": true + "description": "Address info", + "nullable": true, + "deprecated": true }, - "erpKey": { - "title": "ERP Key", - "maxLength": 100, + "postalCode": { + "maxLength": 10, "minLength": 0, "type": "string", - "description": "The unique ID of this record as it was known in its originating financial system.\r\n \r\nIf this contact 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).", - "nullable": true + "description": "Address info", + "nullable": true, + "deprecated": true }, - "contactName": { + "country": { "maxLength": 100, - "minLength": 0, "type": "string", - "description": "The name of the contact." + "description": "Address info", + "nullable": true, + "deprecated": true }, - "contactCode": { - "maxLength": 20, + "timeZone": { + "maxLength": 40, "minLength": 0, "type": "string", - "description": "A friendly human-readable code that describes this Contact.", + "description": "Time zone", "nullable": true, "deprecated": true }, - "title": { - "maxLength": 50, + "phoneNumber": { + "maxLength": 20, "minLength": 0, "type": "string", - "description": "The title of the contact.", + "description": "Phone number", "nullable": true, "deprecated": true }, - "roleCode": { + "faxNumber": { "maxLength": 20, "minLength": 0, "type": "string", - "description": "The role code for the contact.", + "description": "Fax number", "nullable": true, "deprecated": true }, - "emailAddress": { - "maxLength": 200, + "created": { + "type": "string", + "description": "The date this company was created", + "format": "date-time", + "readOnly": true + }, + "createdUserId": { + "type": "string", + "description": "The ID of the user who created this company", + "format": "uuid", + "readOnly": true + }, + "modified": { + "type": "string", + "description": "The date this company was last modified", + "format": "date-time", + "readOnly": true + }, + "modifiedUserId": { + "type": "string", + "description": "The ID of the user who last modified this company", + "format": "uuid", + "readOnly": true + }, + "taxId": { + "maxLength": 30, "minLength": 0, "type": "string", - "description": "The email address of the contact.", - "format": "email", + "description": "Federal Tax ID", "nullable": true, - "example": "mail@example.com" + "deprecated": true }, - "phone": { - "maxLength": 20, + "dunsNumber": { + "maxLength": 10, "minLength": 0, "type": "string", - "description": "The phone number of the contact.", + "description": "Dun & Bradstreet Number", "nullable": true, "deprecated": true }, - "fax": { + "preferredDeliveryMethod": { "maxLength": 20, "minLength": 0, "type": "string", - "description": "The fax number of the contact.", + "description": "Indicates the preferred invoice delivery method. Examples include Print, Email, Fax", "nullable": true, "deprecated": true }, - "locale": { - "maxLength": 48, + "domainName": { + "maxLength": 254, "minLength": 0, "type": "string", - "description": "The IETF language tag for the contact's locale.", + "description": "For companies that use a custom domain name for their email system, this is\r\nthe domain name used by this company. If this value is known, new emails that\r\ncome in from this domain will be connected to this company.", "nullable": true, "deprecated": true }, - "address1": { - "maxLength": 80, - "minLength": 0, + "companyClassificationCodeDefId": { "type": "string", - "description": "The first line of the address.", + "description": "Identifier for classification of this company.", + "format": "uuid", "nullable": true, "deprecated": true }, - "address2": { - "maxLength": 80, + "description": { + "maxLength": 254, "minLength": 0, "type": "string", - "description": "The second line of the address.", + "description": "Description of the company.", "nullable": true, "deprecated": true }, - "address3": { - "maxLength": 80, + "website": { + "maxLength": 512, "minLength": 0, "type": "string", - "description": "The third line of the address.", + "description": "Website URL for this company.", "nullable": true, "deprecated": true }, - "address4": { - "maxLength": 80, - "minLength": 0, + "appEnrollmentId": { "type": "string", - "description": "The fourth line of the address.", + "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.", + "format": "uuid", "nullable": true, - "deprecated": true + "readOnly": true }, - "city": { + "emailAddress": { + "maxLength": 254, + "minLength": 0, + "type": "string", + "description": "Company Email Address", + "format": "email", + "nullable": true + }, + "publicUrlSlug": { "maxLength": 100, "minLength": 0, "type": "string", - "description": "The city of the address.", + "description": "The public url slug for the Company.", "nullable": true, "deprecated": true }, - "stateRegion": { - "maxLength": 60, + "primaryContactSet": { + "type": "boolean", + "description": "Indicates if the primary contact has been set by the user.", + "readOnly": true, + "deprecated": true + }, + "stateTaxId": { + "maxLength": 20, "minLength": 0, "type": "string", - "description": "The state/region of the address.", + "description": "State Tax ID", "nullable": true, "deprecated": true }, - "postalCode": { - "maxLength": 10, + "stateOfIncorporation": { + "maxLength": 20, "minLength": 0, "type": "string", - "description": "The postal/zip code of the address.", + "description": "The state where the company was registered.", "nullable": true, "deprecated": true }, - "countryCode": { - "maxLength": 2, - "minLength": 2, + "linkedInUrlSlug": { + "maxLength": 100, + "minLength": 0, "type": "string", - "description": "The two character country code of the address. This will be validated by the /api/v1/definitions/countries data set", + "description": "Linkedin Url", "nullable": true, "deprecated": true }, - "isActive": { + "isVerified": { "type": "boolean", - "description": "Flag indicating if the contact is active.", - "default": true + "description": "This flag indicates whether the company is verified.", + "default": false, + "readOnly": true, + "deprecated": true }, - "webpageUrl": { - "maxLength": 512, - "minLength": 0, + "lastVerifiedDate": { "type": "string", - "description": "The webpage url of the contact.", - "format": "uri", + "description": "The date this company was last verified.", + "format": "date-time", "nullable": true, - "example": "https://example.com", + "readOnly": true, "deprecated": true }, - "pictureUrl": { - "maxLength": 512, - "minLength": 0, - "type": "string", - "description": "The picture/avatar url of the contact.", - "format": "uri", + "viewBoxSettings": { + "allOf": [ + { + "$ref": "#/components/schemas/ViewBoxSettingsModel" + } + ], + "description": "View box settings for the company logo.", "nullable": true, - "example": "https://example.com/pictureUrl", + "readOnly": true, "deprecated": true }, - "created": { + "serviceFabricOrgId": { "type": "string", - "description": "The date on which this record was created.", - "format": "date-time", + "description": "The unique ID of the Service Fabric organisation to which this record belongs.", + "format": "uuid", + "nullable": true, "readOnly": true }, - "createdUserId": { + "serviceFabricCompanyId": { "type": "string", - "description": "The ID of the user who created this contact.", + "description": "The unique ID of this record within Service Fabric.", "format": "uuid", + "nullable": true, "readOnly": true }, - "modified": { + "companyRegistrationNumber": { + "maxLength": 20, + "minLength": 0, "type": "string", - "description": "The date on which this record was last modified.", - "format": "date-time", - "readOnly": true + "description": "A unique identification number assigned to the company by the national registration office.", + "nullable": true, + "deprecated": true }, - "modifiedUserId": { + "profileReferenceId": { "type": "string", - "description": "The ID of the user who last modified this contact.", + "description": "An optional reference to a real company, making this a profile.", "format": "uuid", - "readOnly": true + "nullable": true, + "readOnly": true, + "deprecated": true }, - "appEnrollmentId": { + "companyIdentifiers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CompanyIdentifierModel" + }, + "description": "Company identifiers for this company.", + "nullable": true, + "deprecated": true + }, + "referenceCode": { + "maxLength": 30, + "minLength": 0, "type": "string", - "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.", - "format": "uuid", + "description": "A reference code for this company. This code is used to identify this company in external ERP systems.", "nullable": true, "readOnly": true }, @@ -23872,7 +19091,7 @@ "items": { "$ref": "#/components/schemas/NoteModel" }, - "description": "A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the\r\n`include` parameter when retrieving data.\r\n \r\nTo create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes)\r\nendpoint with the `TableKey` to `Contact` and the `ObjectKey` set to the `ContactId` 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).", + "description": "A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the\r\n`include` parameter when retrieving data.\r\n \r\nTo create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes)\r\nendpoint with the `TableKey` to `Company` and the `ObjectKey` set to the `CompanyId` 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).", "nullable": true, "readOnly": true }, @@ -23881,7 +19100,23 @@ "items": { "$ref": "#/components/schemas/AttachmentModel" }, - "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 `Contact` and the `ObjectKey` set to the `ContactId` 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).", + "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 `Company` and the `ObjectKey` set to the `CompanyId` 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).", + "nullable": true, + "readOnly": true + }, + "contacts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ContactModel" + }, + "description": "All contacts attached to this company.\r\n \r\nTo retrieve this collection, specify `Contacts` in the \"Include\" parameter for your query.", + "nullable": true, + "readOnly": true + }, + "invoices": { + "type": "array", + "items": { }, + "description": "All invoices attached to this company.\r\n \r\nTo 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).", "nullable": true, "readOnly": true }, @@ -23890,7 +19125,7 @@ "items": { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, - "description": "A collection of custom fields linked to this record. To retrieve this collection, specify\r\n`CustomFieldDefinitions` 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 `Contact` and the `ObjectKey` set to the `ContactId` 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).", + "description": "A collection of custom fields linked to this record. To retrieve this collection, specify\r\n`CustomFieldDefinitions` 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 `Company` and the `ObjectKey` set to the `CompanyId` 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).", "nullable": true, "readOnly": true }, @@ -23899,15 +19134,25 @@ "items": { "$ref": "#/components/schemas/CustomFieldValueModel" }, - "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 `Contact` and the `ObjectKey` set to the `ContactId` 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).", + "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 `Company` and the `ObjectKey` set to the `CompanyId` 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).", + "nullable": true, + "readOnly": true + }, + "companyClassificationCodeDefinition": { + "allOf": [ + { + "$ref": "#/components/schemas/CodeDefinitionModel" + } + ], + "description": "Classification code definition for this company.\r\n \r\nTo retrieve this collection, specify `Classification` in the \"Include\" parameter for your query.", "nullable": true, "readOnly": true } }, "additionalProperties": false, - "description": "A Contact contains information about a person or role within a Company.\r\nYou can use Contacts to track information about who is responsible for a specific project,\r\nwho handles invoices, or information about which role at a particular customer or\r\nvendor you should speak with about invoices." + "description": "A Company represents a customer, a vendor, or a company within the organization of the account holder.\r\nCompanies can have parents and children, representing an organizational hierarchy of corporate entities.\r\nYou can use Companies to track projects and financial data under this Company label.\r\n \r\nSee [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information." }, - "ContactModelFetchResult": { + "CompanyModelFetchResult": { "type": "object", "properties": { "totalCount": { @@ -23928,16 +19173,17 @@ "records": { "type": "array", "items": { - "$ref": "#/components/schemas/ContactModel" + "$ref": "#/components/schemas/CompanyModel" }, "nullable": true } }, "additionalProperties": false }, - "ContactSyncModel": { + "CompanySyncModel": { "required": [ - "companyErpKey", + "companyName", + "companyType", "erpKey", "isActive" ], @@ -23953,116 +19199,106 @@ }, "networkId": { "type": "string", - "description": "The unique identifier of this object in the Sage Network platform.", + "description": "The unique identifier of this object in the Accounting Data Service.", "format": "uuid", "nullable": true }, "erpKey": { "type": "string", - "description": "This is the primary key of the Contact record. For this field, you should use whatever the contact's unique\r\nidentifying number is in the originating system. Search for a unique, non-changing number within the\r\noriginating financial system for this record.\r\n \r\nExample: If you store your contact records in a database, whatever the primary key for the contact table is\r\nin the database should be the \"ErpKey\".\r\n \r\nAs some ERP systems don't maintain a unique key for Contacts, we also support syncing Contacts with ERP keys\r\nof the form {prefix}|{index}, for example ContactPrefix|1, ContactPrefix|2 and so on.\r\n \r\nFor this reason, please ensure that your Contact ERP keys don't otherwise contain the '|' symbol or that it\r\nis replaced by an alternate symbol if they do.\r\n \r\nFor more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns)." - }, - "companyErpKey": { - "type": "string", - "description": "The original primary key or unique ID of the company to which this contact belongs. This value should\r\nmatch the [Company ErpKey](https://developer.lockstep.io/docs/importing-companies#erpkey) field on the\r\n[CompanySyncModel](https://developer.lockstep.io/docs/importing-companies)." + "description": "This is the primary key of the Company record. For this field, you should use whatever the company's unique\r\nidentifying number is in the originating system. Search for a unique, non-changing number within the\r\noriginating financial system for this record.\r\n \r\nExample: If you store your company records in a database, whatever the primary key for the company table is\r\nin the database should be the `ErpKey`.\r\n \r\nFor more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns)." }, - "companyNetworkId": { + "companyName": { "type": "string", - "description": "The network id of the related Company.", - "format": "uuid", - "nullable": true + "description": "A friendly, short name of the company." }, - "contactName": { + "companyType": { "type": "string", - "description": "The name of the contact.", - "nullable": true + "description": "This field indicates the type of company. It can be one of a limited number of values: `Company`,\r\n`Customer`, `Group`, `Vendor`, or `Third Party`. A company that represents both a customer and a vendor is\r\nidentified as a `CustomerVendor`.\r\n \r\nWhen loading data into ADS, you should focus on the distinction between a company that is part of\r\nyour own enterprise, or a company that is external to your enterprise.\r\n \r\nFor a company that is within your enterprise, you should set this value to be `Company`.\r\n \r\nFor a company that is external to your enterprise, you should set this value to either `Customer`,\r\n`Vendor`, `Third Party`, or `CustomerVendor`. If you don't know what value to choose, select\r\n`CustomerVendor`." }, - "contactCode": { + "parentCompanyErpKey": { "type": "string", - "description": "A friendly human-readable code that describes this Contact.", + "description": "If this company has a parent company, identify the parent company's `ErpKey` value here. This value should\r\nbe the original primary key or unique ID of the parent company to this company belongs. This value should\r\nmatch the original ErpKey field on the parent company.\r\n \r\nIf this company is not a child company, leave this field null.", "nullable": true }, - "title": { + "parentCompanyNetworkId": { "type": "string", - "description": "The title of the contact.", + "description": "The network id of the parent Company.", + "format": "uuid", "nullable": true }, - "roleCode": { - "type": "string", - "description": "The role code for the contact.", - "nullable": true + "isActive": { + "type": "boolean", + "description": "This flag indicates whether the company is currently active. An inactive company will be hidden from the\r\nuser interface but will still be available for querying." }, - "emailAddress": { + "defaultCurrencyCode": { "type": "string", - "description": "The email address of the contact.", + "description": "The default currency code for transactions related to this company. For a list of currency codes, see\r\n[Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies).", "nullable": true }, - "phone": { + "companyLogoUrl": { "type": "string", - "description": "The phone number of the contact.", + "description": "The URL of this company's logo, if known.", "nullable": true }, - "fax": { + "primaryContactErpKey": { "type": "string", - "description": "The fax number of the contact.", + "description": "The `ErpKey` of the primary contact for this company. This value should match the `ErpKey` value of the\r\n[Importing Contacts](https://developer.lockstep.io/docs/importing-contacts) record for the contact table.", "nullable": true }, - "locale": { + "primaryContactNetworkId": { "type": "string", - "description": "The IETF language tag for the contact's locale.", + "description": "The network id of the primary Contact.", + "format": "uuid", "nullable": true }, "address1": { "type": "string", - "description": "The mailing address information for this contact.", + "description": "The company's primary mailing address information", "nullable": true }, "address2": { "type": "string", - "description": "The mailing address information for this contact.", + "description": "The company's primary mailing address information", "nullable": true }, "address3": { "type": "string", - "description": "The mailing address information for this contact.", + "description": "The company's primary mailing address information", "nullable": true }, "address4": { "type": "string", - "description": "The mailing address information for this contact.", + "description": "The company's primary mailing address information", "nullable": true }, "city": { "type": "string", - "description": "The mailing address information for this contact.", + "description": "The company's primary mailing address information", "nullable": true }, "stateRegion": { "type": "string", - "description": "The mailing address information for this contact.", + "description": "The company's primary mailing address information", "nullable": true }, "postalCode": { "type": "string", - "description": "The mailing address information for this contact.", + "description": "The company's primary mailing address information", "nullable": true }, - "countryCode": { + "country": { "type": "string", - "description": "The mailing address information for this contact.", + "description": "The company's primary mailing address information", "nullable": true }, - "isActive": { - "type": "boolean", - "description": "True if this contact is considered \"active\"." - }, - "webpageUrl": { + "phoneNumber": { "type": "string", - "description": "A webpage URL for more information about this contact.", + "description": "The main phone number of this company.", "nullable": true }, - "pictureUrl": { + "faxNumber": { "type": "string", - "description": "If available, the URL of a photograph that shows this contact.", + "description": "The main fax number of this company.", "nullable": true }, "created": { @@ -24076,204 +19312,282 @@ "description": "If known, the date when this record was most recently modified according to the originating\r\nfinancial system in which this record is maintained. If the originating financial system does\r\nnot maintain a most-recently-modified-date, leave this field null.", "format": "date-time", "nullable": true + }, + "taxId": { + "type": "string", + "description": "The company's Tax ID number for the appropriate government for this company.", + "nullable": true + }, + "dunsNumber": { + "type": "string", + "description": "The Dun and Bradstreet number for this company, if known.", + "nullable": true + }, + "preferredDeliveryMethod": { + "type": "string", + "description": "Indicates the preferred invoice delivery method. Examples include Print, Email, Fax", + "nullable": true + }, + "emailAddress": { + "type": "string", + "description": "The company email address.", + "nullable": true + }, + "externalReference": { + "type": "string", + "description": "An external reference that identifies the Company from the originating ERP system, separate from the ErpKey.", + "nullable": true + }, + "companyRegistrationNumber": { + "type": "string", + "description": "A unique identification number assigned to the company by the national registration office.", + "nullable": true + }, + "companyIdentifiers": { + "type": "string", + "description": "The set of identifiers for the Company.", + "nullable": true + }, + "referenceCode": { + "type": "string", + "description": "A reference code for the Company. This code is used to identify this company in external ERP systems.", + "nullable": true } }, - "additionalProperties": {}, - "description": "The ContactSyncModel represents information coming into ADS 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 ContactSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the ADS Platform API as a [ContactModel](https://developer.lockstep.io/docs/contactmodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." + "additionalProperties": { }, + "description": "The CompanySyncModel represents information coming into ADS 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 CompanySyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the Accounting Data Service API as a [CompanyModel](https://developer.lockstep.io/docs/companymodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." }, - "CountryModel": { + "ConnectorInfoModel": { "type": "object", "properties": { - "name": { - "maxLength": 100, - "minLength": 0, + "realmId": { "type": "string", - "description": "Name of the country", + "description": "The realm id of the account being granted permissions to access", + "default": null, "nullable": true }, - "alpha2": { - "maxLength": 2, - "minLength": 0, + "username": { "type": "string", - "description": "2 letter alphabetic code for the given country", + "description": "The username of the web services account with access permissions.", + "default": null, "nullable": true }, - "alpha3": { - "maxLength": 3, - "minLength": 0, + "password": { "type": "string", - "description": "3 letter alphabetic code for the given country", + "description": "The password for the web services account with access permissions.", + "default": null, "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents all possible data required to set up an app enrollment for a connector.\r\nOnly send required fields for the given connector." + }, + "ContactModel": { + "required": [ + "companyId" + ], + "type": "object", + "properties": { + "contactId": { + "type": "string", + "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", + "format": "uuid", + "readOnly": true }, - "countryCode": { - "type": "integer", - "description": "Unique 3 digit number for the given country", - "format": "int32" + "companyId": { + "minLength": 1, + "type": "string", + "description": "The ID of the company to which this contact belongs.", + "format": "uuid" + }, + "groupKey": { + "type": "string", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", + "format": "uuid", + "readOnly": true }, - "region": { + "erpKey": { + "title": "ERP Key", "maxLength": 100, "minLength": 0, "type": "string", - "description": "Region of the country", + "description": "The unique ID of this record as it was known in its originating financial system.\r\n \r\nIf this contact 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).", "nullable": true }, - "subRegion": { + "contactName": { "maxLength": 100, "minLength": 0, "type": "string", - "description": "Subregion of the country", + "description": "The name of the contact.", "nullable": true }, - "intermediateRegion": { - "maxLength": 100, + "contactCode": { + "maxLength": 20, "minLength": 0, "type": "string", - "description": "Intermediate region of the country", - "nullable": true + "description": "A friendly human-readable code that describes this Contact.", + "nullable": true, + "deprecated": true }, - "regionCode": { - "type": "integer", - "description": "Numeric code for a region", - "format": "int32" + "title": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "description": "The title of the contact.", + "nullable": true, + "deprecated": true }, - "subRegionCode": { - "type": "integer", - "description": "Numeric code for a subregion", - "format": "int32" + "roleCode": { + "maxLength": 20, + "minLength": 0, + "type": "string", + "description": "The role code for the contact.", + "nullable": true, + "deprecated": true }, - "intermediateRegionCode": { - "type": "integer", - "description": "Numeric code for an intermediate region", - "format": "int32" + "emailAddress": { + "maxLength": 200, + "minLength": 0, + "type": "string", + "description": "The email address of the contact.", + "format": "email", + "nullable": true, + "example": "mail@example.com" }, - "frenchName": { - "maxLength": 100, + "phone": { + "maxLength": 20, "minLength": 0, "type": "string", - "description": "French name of the country", - "nullable": true + "description": "The phone number of the contact.", + "nullable": true, + "deprecated": true }, - "aliases": { + "fax": { + "maxLength": 20, + "minLength": 0, "type": "string", - "description": "A different name for a country", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Country model for ISO-3166" - }, - "CountryModelFetchResult": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "nullable": true + "description": "The fax number of the contact.", + "nullable": true, + "deprecated": true }, - "pageSize": { - "type": "integer", - "format": "int32", - "nullable": true + "locale": { + "maxLength": 48, + "minLength": 0, + "type": "string", + "description": "The IETF language tag for the contact's locale.", + "nullable": true, + "deprecated": true }, - "pageNumber": { - "type": "integer", - "format": "int32", - "nullable": true + "address1": { + "maxLength": 80, + "minLength": 0, + "type": "string", + "description": "The first line of the address.", + "nullable": true, + "deprecated": true }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CountryModel" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "CreditMemoAppliedModel": { - "type": "object", - "properties": { - "creditMemoAppliedId": { + "address2": { + "maxLength": 80, + "minLength": 0, "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", - "format": "uuid", - "readOnly": true + "description": "The second line of the address.", + "nullable": true, + "deprecated": true }, - "groupKey": { + "address3": { + "maxLength": 80, + "minLength": 0, "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid", - "readOnly": true + "description": "The third line of the address.", + "nullable": true, + "deprecated": true }, - "invoiceId": { + "address4": { + "maxLength": 80, + "minLength": 0, "type": "string", - "description": "The ADS Platform ID of the Invoice to which this credit memo was applied. This Invoice's outstanding balance\r\nwas reduced by the value of the field `CreditMemoAppliedAmount` on the date `ApplyToInvoiceDate`.\r\n \r\nExample: Company ABC received a credit memo, CM000123 for $500. Company ABC then chooses to apply this\r\ncredit memo to reduce the balance of the invoice PO1000578. The `InvoiceErpKey` is the ADS Platform\r\nID number of Invoice `PO1000578`.", - "format": "uuid" + "description": "The fourth line of the address.", + "nullable": true, + "deprecated": true }, - "creditMemoInvoiceId": { + "city": { + "maxLength": 100, + "minLength": 0, "type": "string", - "description": "The ADS Platform ID of the Invoice of type \"Credit Memo\" that was consumed in this payment application event.\r\n \r\nExample: Company ABC received a credit memo, CM000123 for $500. Company ABC then chooses to apply this\r\ncredit memo to reduce the balance of the invoice PO1000578. The `CreditMemoInvoiceId` is the ADS\r\nPlatform ID number of Invoice `CM000123`.", - "format": "uuid" + "description": "The city of the address.", + "nullable": true, + "deprecated": true }, - "erpKey": { - "maxLength": 255, + "stateRegion": { + "maxLength": 60, + "minLength": 0, "type": "string", - "description": "The unique ID of this record as it was known in its originating financial system.\r\n \r\nIf this company 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).", - "nullable": true + "description": "The state/region of the address.", + "nullable": true, + "deprecated": true }, - "erpUpdateStatus": { - "allOf": [ - { - "$ref": "#/components/schemas/ErpUpdateStatus" - } - ], - "description": "Possible statuses for a record that supports ERP Update." + "postalCode": { + "maxLength": 10, + "minLength": 0, + "type": "string", + "description": "The postal/zip code of the address.", + "nullable": true, + "deprecated": true }, - "erpUpdateAction": { - "allOf": [ - { - "$ref": "#/components/schemas/ErpUpdateAction" - } - ], - "description": "Possible actions for a record that supports ERP Update.", - "readOnly": true + "countryCode": { + "maxLength": 2, + "minLength": 2, + "type": "string", + "description": "The two character country code of the address. This will be validated by the /api/v1/definitions/countries data set", + "nullable": true, + "deprecated": true }, - "entryNumber": { - "type": "integer", - "description": "Reference number for the applied credit memo.", - "format": "int32" + "isActive": { + "type": "boolean", + "description": "Flag indicating if the contact is active.", + "default": true }, - "applyToInvoiceDate": { + "webpageUrl": { + "maxLength": 512, + "minLength": 0, "type": "string", - "description": "The date on which this credit memo was applied to the Invoice represented by `InvoiceId`.", - "format": "date-time" + "description": "The webpage url of the contact.", + "format": "uri", + "nullable": true, + "example": "https://example.com", + "deprecated": true }, - "creditMemoAppliedAmount": { - "type": "number", - "description": "The amount of the credit memo that was applied to the Invoice represented by `InvoiceId`.", - "format": "double" + "pictureUrl": { + "maxLength": 512, + "minLength": 0, + "type": "string", + "description": "The picture/avatar url of the contact.", + "format": "uri", + "nullable": true, + "example": "https://example.com/pictureUrl", + "deprecated": true }, "created": { "type": "string", - "description": "Date credit memo applied record was created.", + "description": "The date on which this record was created.", "format": "date-time", "readOnly": true }, "createdUserId": { "type": "string", - "description": "The id of the user who created this applied credit memo.", + "description": "The ID of the user who created this contact.", "format": "uuid", "readOnly": true }, "modified": { "type": "string", - "description": "Date credit memo applied record was modified.", + "description": "The date on which this record was last modified.", "format": "date-time", "readOnly": true }, "modifiedUserId": { "type": "string", - "description": "The id of the user who modified this applied credit memo.", + "description": "The ID of the user who last modified this contact.", "format": "uuid", "readOnly": true }, @@ -24284,37 +19598,21 @@ "nullable": true, "readOnly": true }, - "sourceModifiedDate": { - "type": "string", - "description": "The date on which this record was last modified in source ERP.", - "format": "date-time", - "nullable": true, - "readOnly": true - }, - "erpSystemAttributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "Additional attributes that may be required by the source system.", - "nullable": true - }, - "attachments": { + "notes": { "type": "array", "items": { - "$ref": "#/components/schemas/AttachmentModel" + "$ref": "#/components/schemas/NoteModel" }, - "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 `CreditMemoApplied` and the `ObjectKey` set to the `CreditMemoAppliedId` 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).", + "description": "A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the\r\n`include` parameter when retrieving data.\r\n \r\nTo create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes)\r\nendpoint with the `TableKey` to `Contact` and the `ObjectKey` set to the `ContactId` 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).", "nullable": true, "readOnly": true }, - "notes": { + "attachments": { "type": "array", "items": { - "$ref": "#/components/schemas/NoteModel" + "$ref": "#/components/schemas/AttachmentModel" }, - "description": "A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the\r\n`include` parameter when retrieving data.\r\n \r\nTo create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes)\r\nendpoint with the `TableKey` to `CreditMemoApplied` and the `ObjectKey` set to the `CreditMemoAppliedId` 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).", + "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 `Contact` and the `ObjectKey` set to the `ContactId` 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).", "nullable": true, "readOnly": true }, @@ -24323,7 +19621,7 @@ "items": { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, - "description": "A collection of custom fields linked to this record. To retrieve this collection, specify\r\n`CustomFieldDefinitions` 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 `CreditMemoApplied` and the `ObjectKey` set to the `CreditMemoAppliedId` 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).", + "description": "A collection of custom fields linked to this record. To retrieve this collection, specify\r\n`CustomFieldDefinitions` 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 `Contact` and the `ObjectKey` set to the `ContactId` 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).", "nullable": true, "readOnly": true }, @@ -24332,35 +19630,15 @@ "items": { "$ref": "#/components/schemas/CustomFieldValueModel" }, - "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 `CreditMemoApplied` and the `ObjectKey` set to the `CreditMemoAppliedId` 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).", - "nullable": true, - "readOnly": true - }, - "creditMemoInvoice": { - "allOf": [ - { - "$ref": "#/components/schemas/InvoiceModel" - } - ], - "description": "The credit memo invoice associated with this applied credit memo", - "nullable": true, - "readOnly": true - }, - "invoice": { - "allOf": [ - { - "$ref": "#/components/schemas/InvoiceModel" - } - ], - "description": "The invoice associated with this applied credit memo", + "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 `Contact` and the `ObjectKey` set to the `ContactId` 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).", "nullable": true, "readOnly": true } }, "additionalProperties": false, - "description": "Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds.\r\nCredit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice,\r\nADS Platform creates a Credit Memo Application record to track the amount from the Credit Memo that was applied\r\nas payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid\r\nusing this Credit." + "description": "A Contact contains information about a person or role within a Company.\r\nYou can use Contacts to track information about who is responsible for a specific project,\r\nwho handles invoices, or information about which role at a particular customer or\r\nvendor you should speak with about invoices." }, - "CreditMemoAppliedModelFetchResult": { + "ContactModelFetchResult": { "type": "object", "properties": { "totalCount": { @@ -24381,21 +19659,18 @@ "records": { "type": "array", "items": { - "$ref": "#/components/schemas/CreditMemoAppliedModel" + "$ref": "#/components/schemas/ContactModel" }, "nullable": true } }, "additionalProperties": false }, - "CreditMemoAppliedSyncModel": { + "ContactSyncModel": { "required": [ - "applyToInvoiceDate", - "creditMemoAppliedAmount", - "creditMemoInvoiceErpKey", - "entryNumber", + "companyErpKey", "erpKey", - "invoiceErpKey" + "isActive" ], "type": "object", "properties": { @@ -24409,42 +19684,117 @@ }, "networkId": { "type": "string", - "description": "The unique identifier of this object in the Sage Network platform.", + "description": "The unique identifier of this object in the Accounting Data Service.", "format": "uuid", "nullable": true }, "erpKey": { "type": "string", - "description": "This is the primary key of the Credit Memo Application record. For this field, you should use whatever this\r\ntransaction's unique identifying number is in the originating system. Search for a unique, non-changing\r\nnumber within the originating financial system for this record.\r\n \r\nSince Credit Memo Applications are often considered transactions, a typical value to look for will be\r\nthe transaction ID number, the payment confirmation number, or some other record of this payment.\r\n \r\nFor more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns)." + "description": "This is the primary key of the Contact record. For this field, you should use whatever the contact's unique\r\nidentifying number is in the originating system. Search for a unique, non-changing number within the\r\noriginating financial system for this record.\r\n \r\nExample: If you store your contact records in a database, whatever the primary key for the contact table is\r\nin the database should be the \"ErpKey\".\r\n \r\nAs some ERP systems don't maintain a unique key for Contacts, we also support syncing Contacts with ERP keys\r\nof the form {prefix}|{index}, for example ContactPrefix|1, ContactPrefix|2 and so on.\r\n \r\nFor this reason, please ensure that your Contact ERP keys don't otherwise contain the '|' symbol or that it\r\nis replaced by an alternate symbol if they do.\r\n \r\nFor more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns)." }, - "invoiceErpKey": { + "companyErpKey": { "type": "string", - "description": "This field indicates which Invoice had its balanced reduced by applying a credit memo. In this field,\r\nidentify the original primary key or unique ID of the Invoice which had its balanced reduced.\r\n \r\nExample: Company ABC received a credit memo, CM000123 for $500. Company ABC then chooses to apply this\r\ncredit memo to reduce the balance of the invoice PO1000578. The `InvoiceErpKey` is `PO1000578`." + "description": "The original primary key or unique ID of the company to which this contact belongs. This value should\r\nmatch the [Company ErpKey](https://developer.lockstep.io/docs/importing-companies#erpkey) field on the\r\n[CompanySyncModel](https://developer.lockstep.io/docs/importing-companies)." }, - "invoiceNetworkId": { + "companyNetworkId": { "type": "string", - "description": "The network id of the parent Invoice.", + "description": "The network id of the related Company.", "format": "uuid", "nullable": true }, - "creditMemoInvoiceErpKey": { + "contactName": { "type": "string", - "description": "This field indicates which Invoice is the original credit memo that was used to make this payment\r\napplication event. In this field, identify the original primary key or unique ID of the Invoice which\r\ncreated the credit memo that was consumed in this event.\r\n \r\nExample: Company ABC received a credit memo, CM000123 for $500. Company ABC then chooses to apply this\r\ncredit memo to reduce the balance of the invoice PO1000578. The `CreditMemoInvoiceErpKey` is `CM000123`." + "description": "The name of the contact.", + "nullable": true }, - "entryNumber": { - "type": "integer", - "description": "Reference number for the applied credit memo.", - "format": "int32" + "contactCode": { + "type": "string", + "description": "A friendly human-readable code that describes this Contact.", + "nullable": true }, - "applyToInvoiceDate": { + "title": { "type": "string", - "description": "The date on which this credit memo was applied to the Invoice.", - "format": "date-time" + "description": "The title of the contact.", + "nullable": true }, - "creditMemoAppliedAmount": { - "type": "number", - "description": "The amount of this credit memo that was applied to this Invoice.", - "format": "double" + "roleCode": { + "type": "string", + "description": "The role code for the contact.", + "nullable": true + }, + "emailAddress": { + "type": "string", + "description": "The email address of the contact.", + "nullable": true + }, + "phone": { + "type": "string", + "description": "The phone number of the contact.", + "nullable": true + }, + "fax": { + "type": "string", + "description": "The fax number of the contact.", + "nullable": true + }, + "locale": { + "type": "string", + "description": "The IETF language tag for the contact's locale.", + "nullable": true + }, + "address1": { + "type": "string", + "description": "The mailing address information for this contact.", + "nullable": true + }, + "address2": { + "type": "string", + "description": "The mailing address information for this contact.", + "nullable": true + }, + "address3": { + "type": "string", + "description": "The mailing address information for this contact.", + "nullable": true + }, + "address4": { + "type": "string", + "description": "The mailing address information for this contact.", + "nullable": true + }, + "city": { + "type": "string", + "description": "The mailing address information for this contact.", + "nullable": true + }, + "stateRegion": { + "type": "string", + "description": "The mailing address information for this contact.", + "nullable": true + }, + "postalCode": { + "type": "string", + "description": "The mailing address information for this contact.", + "nullable": true + }, + "countryCode": { + "type": "string", + "description": "The mailing address information for this contact.", + "nullable": true + }, + "isActive": { + "type": "boolean", + "description": "True if this contact is considered \"active\"." + }, + "webpageUrl": { + "type": "string", + "description": "A webpage URL for more information about this contact.", + "nullable": true + }, + "pictureUrl": { + "type": "string", + "description": "If available, the URL of a photograph that shows this contact.", + "nullable": true }, "created": { "type": "string", @@ -24452,191 +19802,298 @@ "format": "date-time", "nullable": true }, - "modified": { - "type": "string", - "description": "If known, the date when this record was most recently modified according to the originating\r\nfinancial system in which this record is maintained. If the originating financial system does\r\nnot maintain a most-recently-modified-date, leave this field null.", - "format": "date-time", + "modified": { + "type": "string", + "description": "If known, the date when this record was most recently modified according to the originating\r\nfinancial system in which this record is maintained. If the originating financial system does\r\nnot maintain a most-recently-modified-date, leave this field null.", + "format": "date-time", + "nullable": true + } + }, + "additionalProperties": { }, + "description": "The ContactSyncModel represents information coming into ADS 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 ContactSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the Accounting Data Service API as a [ContactModel](https://developer.lockstep.io/docs/contactmodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." + }, + "CountryModel": { + "type": "object", + "properties": { + "name": { + "maxLength": 100, + "minLength": 0, + "type": "string", + "description": "Name of the country", + "nullable": true + }, + "alpha2": { + "maxLength": 2, + "minLength": 0, + "type": "string", + "description": "2 letter alphabetic code for the given country", + "nullable": true + }, + "alpha3": { + "maxLength": 3, + "minLength": 0, + "type": "string", + "description": "3 letter alphabetic code for the given country", + "nullable": true + }, + "countryCode": { + "type": "integer", + "description": "Unique 3 digit number for the given country", + "format": "int32" + }, + "region": { + "maxLength": 100, + "minLength": 0, + "type": "string", + "description": "Region of the country", + "nullable": true + }, + "subRegion": { + "maxLength": 100, + "minLength": 0, + "type": "string", + "description": "Subregion of the country", + "nullable": true + }, + "intermediateRegion": { + "maxLength": 100, + "minLength": 0, + "type": "string", + "description": "Intermediate region of the country", + "nullable": true + }, + "regionCode": { + "type": "integer", + "description": "Numeric code for a region", + "format": "int32" + }, + "subRegionCode": { + "type": "integer", + "description": "Numeric code for a subregion", + "format": "int32" + }, + "intermediateRegionCode": { + "type": "integer", + "description": "Numeric code for an intermediate region", + "format": "int32" + }, + "frenchName": { + "maxLength": 100, + "minLength": 0, + "type": "string", + "description": "French name of the country", + "nullable": true + }, + "aliases": { + "type": "string", + "description": "A different name for a country", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Country model for ISO-3166" + }, + "CountryModelFetchResult": { + "type": "object", + "properties": { + "totalCount": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "pageSize": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "pageNumber": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryModel" + }, "nullable": true } }, - "additionalProperties": {}, - "description": "The CreditMemoAppliedSyncModel represents information coming into ADS from an external financial system or\r\nother enterprise resource planning system. To import data from an external system, convert your original data\r\ninto the CreditMemoAppliedSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the ADS Platform API as a [CreditMemoAppliedModel](https://developer.lockstep.io/docs/creditmemoappliedmodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." + "additionalProperties": false }, - "CreditMemoInvoiceModel": { - "required": [ - "creditMemoAppliedAmount", - "creditMemoAppliedId", - "creditMemoInvoiceId", - "invoiceId" - ], + "CreditMemoAppliedModel": { "type": "object", "properties": { - "groupKey": { - "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid" - }, - "baseCurrencyCode": { - "maxLength": 3, - "minLength": 0, - "type": "string", - "description": "The base currency code of the group.", - "nullable": true - }, - "currencyCode": { - "maxLength": 3, - "minLength": 0, + "creditMemoAppliedId": { "type": "string", - "description": "The currency code of the credit memo invoice.", - "nullable": true + "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", + "format": "uuid", + "readOnly": true }, - "creditMemoAppliedId": { + "groupKey": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.", - "format": "uuid" + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", + "format": "uuid", + "readOnly": true }, "invoiceId": { "type": "string", - "description": "The id of the invoice", + "description": "The Accounting Data Service ID of the Invoice to which this credit memo was applied. This Invoice's outstanding balance\r\nwas reduced by the value of the field `CreditMemoAppliedAmount` on the date `ApplyToInvoiceDate`.\r\n \r\nExample: Company ABC received a credit memo, CM000123 for $500. Company ABC then chooses to apply this\r\ncredit memo to reduce the balance of the invoice PO1000578. The `InvoiceErpKey` is the Accounting Data Service\r\nID number of Invoice `PO1000578`.", "format": "uuid" }, "creditMemoInvoiceId": { "type": "string", - "description": "The id of the credit memo invoice", + "description": "The Accounting Data Service ID of the Invoice of type \"Credit Memo\" that was consumed in this payment application event.\r\n \r\nExample: Company ABC received a credit memo, CM000123 for $500. Company ABC then chooses to apply this\r\ncredit memo to reduce the balance of the invoice PO1000578. The `CreditMemoInvoiceId` is the ADS\r\nNetwork Id number of Invoice `CM000123`.", "format": "uuid" }, - "applyToInvoiceDate": { + "erpKey": { + "maxLength": 255, "type": "string", - "description": "Date invoice applied to credit memo.", - "format": "date", + "description": "The unique ID of this record as it was known in its originating financial system.\r\n \r\nIf this company 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).", "nullable": true }, - "creditMemoAppliedAmount": { - "type": "number", - "description": "Amount applied to credit memo.", - "format": "double" + "erpUpdateStatus": { + "allOf": [ + { + "$ref": "#/components/schemas/ErpUpdateStatus" + } + ], + "description": "Possible statuses for a record that supports ERP Update." }, - "baseCurrencyCreditMemoAppliedAmount": { + "erpUpdateAction": { + "allOf": [ + { + "$ref": "#/components/schemas/ErpUpdateAction" + } + ], + "description": "Possible actions for a record that supports ERP Update.", + "readOnly": true + }, + "entryNumber": { + "type": "integer", + "description": "Reference number for the applied credit memo.", + "format": "int32" + }, + "applyToInvoiceDate": { + "type": "string", + "description": "The date on which this credit memo was applied to the Invoice represented by `InvoiceId`.", + "format": "date-time" + }, + "creditMemoAppliedAmount": { "type": "number", - "description": "The amount applied to credit memo in the group's base currency.", + "description": "The amount of the credit memo that was applied to the Invoice represented by `InvoiceId`.", "format": "double" }, - "referenceCode": { + "created": { "type": "string", - "description": "An additional reference code that is sometimes used to identify this invoice.\r\nThe meaning of this field is specific to the ERP or accounting system used by the user.", - "nullable": true + "description": "Date credit memo applied record was created.", + "format": "date-time", + "readOnly": true }, - "companyId": { + "createdUserId": { "type": "string", - "description": "The ID number of the company that created this invoice.", + "description": "The id of the user who created this applied credit memo.", "format": "uuid", - "nullable": true + "readOnly": true }, - "customerId": { + "modified": { "type": "string", - "description": "The ID number of the counterparty for the invoice, for example, a customer or vendor.", - "format": "uuid", - "nullable": true + "description": "Date credit memo applied record was modified.", + "format": "date-time", + "readOnly": true }, - "invoiceStatusCode": { + "modifiedUserId": { "type": "string", - "description": "A code identifying the status of this invoice.", - "nullable": true - }, - "totalAmount": { - "type": "number", - "description": "The total value of this invoice, inclusive of all taxes and line items.", - "format": "double", - "nullable": true - }, - "outstandingBalanceAmount": { - "type": "number", - "description": "The remaining balance value of this invoice.", - "format": "double", - "nullable": true - }, - "baseCurrencyTotalAmount": { - "type": "number", - "description": "The total value of this invoice, inclusive of all taxes and line items in the group's base currency.", - "format": "double", - "nullable": true + "description": "The id of the user who modified this applied credit memo.", + "format": "uuid", + "readOnly": true }, - "baseCurrencyOutstandingBalanceAmount": { - "type": "number", - "description": "The remaining balance value of this invoice in the group's base currency.", - "format": "double", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Contains information about a credit memo invoice" - }, - "CreditorAccount": { - "type": "object", - "properties": { - "name": { + "appEnrollmentId": { "type": "string", - "description": "The name of the creditor account." + "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.", + "format": "uuid", + "nullable": true, + "readOnly": true }, - "servicerId": { + "sourceModifiedDate": { "type": "string", - "description": "The unique identifier of the provider used to execute this payment submission.", - "nullable": true + "description": "The date on which this record was last modified in source ERP.", + "format": "date-time", + "nullable": true, + "readOnly": true }, - "servicerName": { - "type": "string", - "description": "The name of the payment servicing organisation (for example, Stripe and PayPal).", - "nullable": true + "erpSystemAttributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true + }, + "description": "Additional attributes that may be required by the source system.", + "nullable": true, + "readOnly": true, + "deprecated": true }, - "companyId": { - "type": "string", - "description": "The unique identifier of the company.", - "nullable": true + "attachments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttachmentModel" + }, + "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 `CreditMemoApplied` and the `ObjectKey` set to the `CreditMemoAppliedId` 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).", + "nullable": true, + "readOnly": true }, - "accountId": { - "type": "string", - "description": "The unique identifier of the creditor account in Payments Acceptance Service.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "A Service Fabric Creditor Account." - }, - "CurrencyModel": { - "type": "object", - "properties": { - "alphaCode": { - "type": "string", - "description": "Alphabetic code for the given currency", - "nullable": true + "notes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NoteModel" + }, + "description": "A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the\r\n`include` parameter when retrieving data.\r\n \r\nTo create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes)\r\nendpoint with the `TableKey` to `CreditMemoApplied` and the `ObjectKey` set to the `CreditMemoAppliedId` 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).", + "nullable": true, + "readOnly": true }, - "numericCode": { - "type": "string", - "description": "Numeric code for the given currency", - "nullable": true + "customFieldDefinitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldDefinitionModel" + }, + "description": "A collection of custom fields linked to this record. To retrieve this collection, specify\r\n`CustomFieldDefinitions` 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 `CreditMemoApplied` and the `ObjectKey` set to the `CreditMemoAppliedId` 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).", + "nullable": true, + "readOnly": true }, - "currencyName": { - "type": "string", - "description": "Name of currency", - "nullable": true + "customFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldValueModel" + }, + "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 `CreditMemoApplied` and the `ObjectKey` set to the `CreditMemoAppliedId` 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).", + "nullable": true, + "readOnly": true }, - "minorUnit": { - "type": "integer", - "description": "Number of places after the decimal for this currency", - "format": "int32" + "creditMemoInvoice": { + "allOf": [ + { + "$ref": "#/components/schemas/InvoiceModel" + } + ], + "description": "The credit memo invoice associated with this applied credit memo", + "nullable": true, + "readOnly": true }, - "symbol": { - "maxLength": 4, - "minLength": 0, - "type": "string", - "description": "Symbol for the given currency", - "nullable": true + "invoice": { + "allOf": [ + { + "$ref": "#/components/schemas/InvoiceModel" + } + ], + "description": "The invoice associated with this applied credit memo", + "nullable": true, + "readOnly": true } }, "additionalProperties": false, - "description": "Represents an ISO-4217 currency code definition" + "description": "Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds.\r\nCredit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice,\r\nAccounting Data Service creates a Credit Memo Application record to track the amount from the Credit Memo that was applied\r\nas payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid\r\nusing this Credit." }, - "CurrencyModelFetchResult": { + "CreditMemoAppliedModelFetchResult": { "type": "object", "properties": { "totalCount": { @@ -24657,329 +20114,279 @@ "records": { "type": "array", "items": { - "$ref": "#/components/schemas/CurrencyModel" + "$ref": "#/components/schemas/CreditMemoAppliedModel" }, "nullable": true } }, "additionalProperties": false }, - "CurrencyRateModel": { + "CreditMemoAppliedSyncModel": { "required": [ - "destinationCurrency", - "sourceCurrency" + "applyToInvoiceDate", + "creditMemoAppliedAmount", + "creditMemoInvoiceErpKey", + "entryNumber", + "erpKey", + "invoiceErpKey" ], "type": "object", "properties": { - "sourceCurrency": { - "minLength": 1, + "onMatchAction": { + "allOf": [ + { + "$ref": "#/components/schemas/MatchAction" + } + ], + "description": "Indicates what action to take when an existing object has been found during the sync process." + }, + "networkId": { + "type": "string", + "description": "The unique identifier of this object in the Accounting Data Service.", + "format": "uuid", + "nullable": true + }, + "erpKey": { "type": "string", - "description": "The source currency" + "description": "This is the primary key of the Credit Memo Application record. For this field, you should use whatever this\r\ntransaction's unique identifying number is in the originating system. Search for a unique, non-changing\r\nnumber within the originating financial system for this record.\r\n \r\nSince Credit Memo Applications are often considered transactions, a typical value to look for will be\r\nthe transaction ID number, the payment confirmation number, or some other record of this payment.\r\n \r\nFor more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns)." }, - "destinationCurrency": { - "minLength": 1, + "invoiceErpKey": { "type": "string", - "description": "The destination currency" + "description": "This field indicates which Invoice had its balanced reduced by applying a credit memo. In this field,\r\nidentify the original primary key or unique ID of the Invoice which had its balanced reduced.\r\n \r\nExample: Company ABC received a credit memo, CM000123 for $500. Company ABC then chooses to apply this\r\ncredit memo to reduce the balance of the invoice PO1000578. The `InvoiceErpKey` is `PO1000578`." }, - "date": { + "invoiceNetworkId": { "type": "string", - "description": "The date for the currency rate", - "format": "date" + "description": "The network id of the parent Invoice.", + "format": "uuid", + "nullable": true }, - "currencyRate": { + "creditMemoInvoiceErpKey": { + "type": "string", + "description": "This field indicates which Invoice is the original credit memo that was used to make this payment\r\napplication event. In this field, identify the original primary key or unique ID of the Invoice which\r\ncreated the credit memo that was consumed in this event.\r\n \r\nExample: Company ABC received a credit memo, CM000123 for $500. Company ABC then chooses to apply this\r\ncredit memo to reduce the balance of the invoice PO1000578. The `CreditMemoInvoiceErpKey` is `CM000123`." + }, + "entryNumber": { + "type": "integer", + "description": "Reference number for the applied credit memo.", + "format": "int32" + }, + "applyToInvoiceDate": { + "type": "string", + "description": "The date on which this credit memo was applied to the Invoice.", + "format": "date-time" + }, + "creditMemoAppliedAmount": { "type": "number", - "description": "The currency rate value", - "format": "double", - "nullable": true, - "readOnly": true + "description": "The amount of this credit memo that was applied to this Invoice.", + "format": "double" + }, + "created": { + "type": "string", + "description": "If known, the date when this record was created according to the originating financial system\r\nin which this record is maintained. If the originating financial system does not maintain a\r\ncreated-date, leave this field null.", + "format": "date-time", + "nullable": true + }, + "modified": { + "type": "string", + "description": "If known, the date when this record was most recently modified according to the originating\r\nfinancial system in which this record is maintained. If the originating financial system does\r\nnot maintain a most-recently-modified-date, leave this field null.", + "format": "date-time", + "nullable": true } }, - "additionalProperties": false, - "description": "Represents a currency rate for specific currencies and date" + "additionalProperties": { }, + "description": "The CreditMemoAppliedSyncModel represents information coming into ADS from an external financial system or\r\nother enterprise resource planning system. To import data from an external system, convert your original data\r\ninto the CreditMemoAppliedSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the Accounting Data Service API as a [CreditMemoAppliedModel](https://developer.lockstep.io/docs/creditmemoappliedmodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." }, - "CustomFieldDefinitionModel": { + "CreditMemoInvoiceModel": { + "required": [ + "creditMemoAppliedAmount", + "creditMemoAppliedId", + "creditMemoInvoiceId", + "invoiceId" + ], "type": "object", "properties": { "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid", - "readOnly": true + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", + "format": "uuid" }, - "customFieldDefinitionId": { + "baseCurrencyCode": { + "maxLength": 3, + "minLength": 0, "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.", - "format": "uuid", - "readOnly": true + "description": "The base currency code of the group.", + "nullable": true }, - "tableKey": { - "maxLength": 40, + "currencyCode": { + "maxLength": 3, "minLength": 0, "type": "string", - "description": "Table to which this definition belongs", + "description": "The currency code of the credit memo invoice.", "nullable": true }, - "appId": { + "creditMemoAppliedId": { "type": "string", - "description": "Id of app this definition belongs to", - "format": "uuid", - "nullable": true + "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.", + "format": "uuid" }, - "customFieldLabel": { - "maxLength": 256, - "minLength": 0, + "invoiceId": { "type": "string", - "description": "Text to display in-application for custom field", - "nullable": true + "description": "The id of the invoice", + "format": "uuid" }, - "dataType": { - "maxLength": 10, - "minLength": 0, + "creditMemoInvoiceId": { "type": "string", - "description": "Data type of this definition", + "description": "The id of the credit memo invoice", + "format": "uuid" + }, + "applyToInvoiceDate": { + "type": "string", + "description": "Date invoice applied to credit memo.", + "format": "date", "nullable": true }, - "sortOrder": { - "type": "integer", - "description": "Used for display logic when multiple custom fields exist", - "format": "int32" + "creditMemoAppliedAmount": { + "type": "number", + "description": "Amount applied to credit memo.", + "format": "double" }, - "created": { - "type": "string", - "description": "Date created", - "format": "date-time", - "readOnly": true + "baseCurrencyCreditMemoAppliedAmount": { + "type": "number", + "description": "The amount applied to credit memo in the group's base currency.", + "format": "double" }, - "createdUserId": { + "referenceCode": { "type": "string", - "description": "Id of user who created this definition", - "format": "uuid", - "readOnly": true + "description": "An additional reference code that is sometimes used to identify this invoice.\r\nThe meaning of this field is specific to the ERP or accounting system used by the user.", + "nullable": true }, - "modified": { + "companyId": { "type": "string", - "description": "Date modified", - "format": "date-time", - "readOnly": true + "description": "The ID number of the company that created this invoice.", + "format": "uuid", + "nullable": true }, - "modifiedUserId": { + "customerId": { "type": "string", - "description": "Id of user who modified this definition", + "description": "The ID number of the counterparty for the invoice, for example, a customer or vendor.", "format": "uuid", - "readOnly": true + "nullable": true }, - "appEnrollmentId": { + "invoiceStatusCode": { "type": "string", - "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.", - "format": "uuid", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false, - "description": "A Custom Field represents metadata added to an object within the ADS Platform. ADS provides a\r\ncore definition for each object. The core definition is intended to represent a level of compatibility\r\nthat provides support across most accounting systems and products. When a user or developer requires\r\ninformation beyond this core definition, you can use Custom Fields to represent this information.\r\n \r\nSee [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information." - }, - "CustomFieldDefinitionModelFetchResult": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", + "description": "A code identifying the status of this invoice.", "nullable": true }, - "pageSize": { - "type": "integer", - "format": "int32", + "totalAmount": { + "type": "number", + "description": "The total value of this invoice, inclusive of all taxes and line items.", + "format": "double", "nullable": true }, - "pageNumber": { - "type": "integer", - "format": "int32", + "outstandingBalanceAmount": { + "type": "number", + "description": "The remaining balance value of this invoice.", + "format": "double", "nullable": true }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldDefinitionModel" - }, + "baseCurrencyTotalAmount": { + "type": "number", + "description": "The total value of this invoice, inclusive of all taxes and line items in the group's base currency.", + "format": "double", "nullable": true - } - }, - "additionalProperties": false - }, - "CustomFieldSyncModel": { - "required": [ - "customFieldLabel", - "erpKey", - "tableKey" - ], - "type": "object", - "properties": { - "onMatchAction": { + }, + "baseCurrencyOutstandingBalanceAmount": { + "type": "number", + "description": "The remaining balance value of this invoice in the group's base currency.", + "format": "double", + "nullable": true + }, + "erpUpdateStatus": { "allOf": [ { - "$ref": "#/components/schemas/MatchAction" + "$ref": "#/components/schemas/ErpUpdateStatus" } ], - "description": "Indicates what action to take when an existing object has been found during the sync process." - }, - "erpKey": { - "type": "string", - "description": "This is the primary key of the record to which you will attach this custom field. You should provide the\r\nidentifying number as it is stored in the originating financial system. Search for a unique, non-changing\r\nnumber within the originating financial system for this record.\r\n \r\nCustom Fields are identified by the `TableKey` and `ErpKey` values together.\r\n \r\nExample: You have an invoice whose ID number is 100047878, and you wish to store a custom field on that\r\ninvoice named \"ApprovalStatusCode\". For the `ErpKey` field, specify the value `100047878`.\r\n \r\nFor more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns)." - }, - "tableKey": { - "type": "string", - "description": "Custom Fields are identified by the `TableKey` and `ErpKey` values together.\r\n \r\nExample: You have an invoice whose ID number is 100047878, and you wish to store a custom field on that\r\ninvoice named \"ApprovalStatusCode\". For the `TableKey` field, specify the value `Invoice`.\r\n \r\nRecognized types include:\r\n* `Company` - Link this custom field to a CompanySyncModel\r\n* `Contact` - Link this custom field to a ContactSyncModel\r\n* `Invoice` - Link this custom field to an InvoiceSyncModel\r\n* `InvoiceLine` - Link this custom field to an InvoiceLineSyncModel\r\n* `Payment` - Link this custom field to a PaymentSyncModel" + "description": "Possible statuses for a record that supports ERP Update." }, - "customFieldLabel": { + "erpUpdateAction": { + "allOf": [ + { + "$ref": "#/components/schemas/ErpUpdateAction" + } + ], + "description": "Possible actions for a record that supports ERP Update.", + "readOnly": true + } + }, + "additionalProperties": false, + "description": "Contains information about a credit memo invoice" + }, + "CreditorAccount": { + "type": "object", + "properties": { + "name": { "type": "string", - "description": "A label that uniquely identifies this custom field within your software.\r\n \r\nExample: You have an invoice whose ID number is 100047878, and you wish to store a custom field on that\r\ninvoice named \"ApprovalStatusCode\". For the `CustomFieldLabel` field, specify the value `ApprovalStatusCode`." + "description": "The name of the creditor account." }, - "stringValue": { + "servicerId": { "type": "string", - "description": "The value of this custom field, if it is stored in string format.", - "nullable": true, - "deprecated": true - }, - "numericValue": { - "type": "number", - "description": "The value of this custom field, if it is stored in numeric format.", - "format": "double", - "nullable": true, - "deprecated": true + "description": "The unique identifier of the provider used to execute this payment submission.", + "nullable": true }, - "value": { + "servicerName": { "type": "string", - "description": "The value of this custom field.", + "description": "The name of the payment servicing organisation (for example, Stripe and PayPal).", "nullable": true }, - "created": { + "companyId": { "type": "string", - "description": "If known, the date when this record was created according to the originating financial system\r\nin which this record is maintained. If the originating financial system does not maintain a\r\ncreated-date, leave this field null.", - "format": "date-time", + "description": "The unique identifier of the company.", "nullable": true }, - "modified": { + "accountId": { "type": "string", - "description": "If known, the date when this record was most recently modified according to the originating\r\nfinancial system in which this record is maintained. If the originating financial system does\r\nnot maintain a most-recently-modified-date, leave this field null.", - "format": "date-time", + "description": "The unique identifier of the creditor account in Payments Acceptance Service.", "nullable": true } }, - "additionalProperties": {}, - "description": "The CustomFieldSyncModel represents information coming into ADS from an external financial system or other\r\nenterprise resource planning system. [Custom Fields](https://developer.lockstep.io/docs/custom-fields#custom-fields)\r\nrepresent custom data extensions that you can use with the ADS Platform. If you need to store extra\r\ninformation about an object that does not match ADS's official schema, you can store it in the Custom\r\nField system using CustomFieldSyncModel.\r\n \r\nTo store a custom field for an object, create a CustomFieldSyncModel record containing the `TableKey` and\r\n`ErpKey` of the entity to which you will attach a custom field. Next specify the field's `CustomFieldLabel`\r\nand either a `StringValue` or `NumericValue`.\r\n \r\nOnce imported, this record will be available in the ADS Platform API as a [CustomFieldValueModel](https://developer.lockstep.io/docs/customfieldvaluemodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." + "additionalProperties": false, + "description": "A Service Fabric Creditor Account." }, - "CustomFieldValueModel": { - "required": [ - "customFieldLabel", - "tableKey" - ], + "CurrencyModel": { "type": "object", "properties": { - "groupKey": { - "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid", - "readOnly": true - }, - "customFieldDefinitionId": { - "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.", - "format": "uuid", - "deprecated": true - }, - "recordKey": { - "type": "string", - "description": "Additional key if source table doesn't have a unique id", - "format": "uuid" - }, - "tableKey": { - "maxLength": 40, - "minLength": 1, - "type": "string", - "description": "Table to which this definition belongs" - }, - "customFieldLabel": { - "maxLength": 256, - "minLength": 1, - "type": "string", - "description": "Text to display in-application for custom field" - }, - "dataType": { - "maxLength": 10, - "minLength": 0, + "alphaCode": { "type": "string", - "description": "Data type of this definition", - "default": "String", + "description": "Alphabetic code for the given currency", "nullable": true }, - "stringValue": { - "maxLength": 2048, - "type": "string", - "description": "String of data for field", - "nullable": true, - "deprecated": true - }, - "numericValue": { - "type": "number", - "description": "Number data for field", - "format": "double", - "nullable": true, - "deprecated": true - }, - "created": { - "type": "string", - "description": "Date created", - "format": "date-time", - "readOnly": true - }, - "createdUserId": { - "type": "string", - "description": "Id of user who created this value", - "format": "uuid", - "readOnly": true - }, - "modified": { + "numericCode": { "type": "string", - "description": "Date modified", - "format": "date-time", - "readOnly": true + "description": "Numeric code for the given currency", + "nullable": true }, - "modifiedUserId": { + "currencyName": { "type": "string", - "description": "Id of user who modified this value", - "format": "uuid", - "readOnly": true + "description": "Name of currency", + "nullable": true }, - "appEnrollmentId": { - "type": "string", - "description": "The AppEnrollmentId of the application that imported this attachment 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.", - "format": "uuid", - "nullable": true, - "readOnly": true + "minorUnit": { + "type": "integer", + "description": "Number of places after the decimal for this currency", + "format": "int32" }, - "value": { - "maxLength": 2048, + "symbol": { + "maxLength": 4, "minLength": 0, "type": "string", - "description": "The value of this custom field.", + "description": "Symbol for the given currency", "nullable": true - }, - "customFieldDefinition": { - "allOf": [ - { - "$ref": "#/components/schemas/CustomFieldDefinitionModel" - } - ], - "description": "Definition of the value", - "nullable": true, - "readOnly": true } }, "additionalProperties": false, - "description": "A Custom Field represents metadata added to an object within the ADS Platform. ADS provides a\r\ncore definition for each object. The core definition is intended to represent a level of compatibility\r\nthat provides support across most accounting systems and products. When a user or developer requires\r\ninformation beyond this core definition, you can use Custom Fields to represent this information.\r\n \r\nSee [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information." + "description": "Represents an ISO-4217 currency code definition" }, - "CustomFieldValueModelFetchResult": { + "CurrencyModelFetchResult": { "type": "object", "properties": { "totalCount": { @@ -25000,168 +20407,96 @@ "records": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldValueModel" + "$ref": "#/components/schemas/CurrencyModel" }, "nullable": true } }, "additionalProperties": false }, - "CustomerSummaryModel": { + "CustomFieldDefinitionModel": { "type": "object", "properties": { "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid" - }, - "companyId": { - "type": "string", - "description": "The unique ID of this company.", - "format": "uuid" + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", + "format": "uuid", + "readOnly": true }, - "companyName": { + "customFieldDefinitionId": { "type": "string", - "description": "The name of the company.", - "nullable": true + "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.", + "format": "uuid", + "readOnly": true }, - "primaryContact": { + "tableKey": { + "maxLength": 40, + "minLength": 0, "type": "string", - "description": "The name of the primary contact.", + "description": "Table to which this definition belongs", "nullable": true }, - "appEnrollmentId": { + "appId": { "type": "string", - "description": "The app enrollment ID this Customer is associated with", + "description": "Id of app this definition belongs to", "format": "uuid", "nullable": true }, - "outstandingInvoices": { - "type": "integer", - "description": "The number of outstanding invoices for this customer.", - "format": "int32", - "nullable": true - }, - "totalInvoicesOpen": { - "type": "integer", - "description": "The number of open invoices.", - "format": "int32", - "nullable": true, - "deprecated": true - }, - "totalInvoicesPastDue": { - "type": "integer", - "description": "The number of past due invoices.", - "format": "int32", - "nullable": true, - "deprecated": true - }, - "closedInvoices": { - "type": "integer", - "description": "The number of closed invoices for this customer.", - "format": "int32", - "nullable": true, - "deprecated": true - }, - "closedInvoicesPastThirtyDays": { - "type": "integer", - "description": "The number of closed invoices for this customer in the past thirty days.", - "format": "int32", - "nullable": true, - "deprecated": true - }, - "amountCollected": { - "type": "number", - "description": "The total from collected payments.", - "format": "double", - "nullable": true, - "deprecated": true - }, - "amountCollectedPastThirtyDays": { - "type": "number", - "description": "The total from collected payments in the past thirty days.", - "format": "double", - "nullable": true, - "deprecated": true - }, - "outstandingAmount": { - "type": "number", - "description": "The total balance of outstanding invoices.", - "format": "double", + "customFieldLabel": { + "maxLength": 256, + "minLength": 0, + "type": "string", + "description": "Text to display in-application for custom field", "nullable": true }, - "invoicedAmountPastThirtyDays": { - "type": "number", - "description": "The total amount invoiced in the past thirty days.", - "format": "double", - "nullable": true, - "deprecated": true - }, - "outstandingAmountPastThirtyDays": { - "type": "number", - "description": "The total amount outstanding from the invoices invoiced in the past thirty days.", - "format": "double", - "nullable": true, - "deprecated": true - }, - "invoicesPastThirtyDays": { - "type": "integer", - "description": "The number of invoices invoiced in the past thirty days.", - "format": "int32", - "nullable": true, - "deprecated": true - }, - "amountPastDue": { - "type": "number", - "description": "The total amount past due for this customer.", - "format": "double", + "dataType": { + "maxLength": 10, + "minLength": 0, + "type": "string", + "description": "Data type of this definition", "nullable": true }, - "unappliedPayments": { - "type": "number", - "description": "The total value of unapplied Payments for this Customer.", - "format": "double", - "nullable": true, - "deprecated": true + "sortOrder": { + "type": "integer", + "description": "Used for display logic when multiple custom fields exist", + "format": "int32" }, - "unappliedAmountPastThirtyDays": { - "type": "number", - "description": "The total value of unapplied Payments for this Customer in the past thirty days.", - "format": "double", - "nullable": true, - "deprecated": true + "created": { + "type": "string", + "description": "Date created", + "format": "date-time", + "readOnly": true }, - "percentOfTotalAr": { - "type": "number", - "description": "Portion of Total AR for this Customer that is Past due. (TotalPastDue / Total AR).", - "format": "double", - "nullable": true, - "deprecated": true + "createdUserId": { + "type": "string", + "description": "Id of user who created this definition", + "format": "uuid", + "readOnly": true }, - "dso": { - "type": "number", - "description": "Daily sales outstanding value for this Customer.", - "format": "double", - "nullable": true, - "deprecated": true + "modified": { + "type": "string", + "description": "Date modified", + "format": "date-time", + "readOnly": true }, - "newestActivity": { + "modifiedUserId": { "type": "string", - "description": "The date stamp for the newest Activity on this Customer.", - "format": "date", - "nullable": true, - "deprecated": true + "description": "Id of user who modified this definition", + "format": "uuid", + "readOnly": true }, - "modified": { + "appEnrollmentId": { "type": "string", - "description": "The modified date of the customer.", - "format": "date-time" + "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.", + "format": "uuid", + "nullable": true, + "readOnly": true } }, "additionalProperties": false, - "description": "Contains summarized data for a customer" + "description": "A Custom Field represents metadata added to an object within the Accounting Data Service. ADS provides a\r\ncore definition for each object. The core definition is intended to represent a level of compatibility\r\nthat provides support across most accounting systems and products. When a user or developer requires\r\ninformation beyond this core definition, you can use Custom Fields to represent this information.\r\n \r\nSee [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information." }, - "CustomerSummaryModelFetchResult": { + "CustomFieldDefinitionModelFetchResult": { "type": "object", "properties": { "totalCount": { @@ -25182,307 +20517,380 @@ "records": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSummaryModel" + "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, "nullable": true } }, "additionalProperties": false }, - "DebtorAccount": { + "CustomFieldSyncModel": { + "required": [ + "customFieldLabel", + "erpKey", + "tableKey" + ], "type": "object", "properties": { - "customerId": { + "onMatchAction": { + "allOf": [ + { + "$ref": "#/components/schemas/MatchAction" + } + ], + "description": "Indicates what action to take when an existing object has been found during the sync process." + }, + "erpKey": { "type": "string", - "description": "The unique identifier of an existing customer. Will be used to match to a reusable payment\r\nmethod if one exists. If specified, the other properties on this object will be ignored.\r\nTrying to create a payment with an unknown customer will result in a 400 status code response.", - "nullable": true + "description": "This is the primary key of the record to which you will attach this custom field. You should provide the\r\nidentifying number as it is stored in the originating financial system. Search for a unique, non-changing\r\nnumber within the originating financial system for this record.\r\n \r\nCustom Fields are identified by the `TableKey` and `ErpKey` values together.\r\n \r\nExample: You have an invoice whose ID number is 100047878, and you wish to store a custom field on that\r\ninvoice named \"ApprovalStatusCode\". For the `ErpKey` field, specify the value `100047878`.\r\n \r\nFor more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns)." }, - "accountId": { + "tableKey": { "type": "string", - "description": "The merchant's unique identifier of the debtor who will receive the payment request.", - "nullable": true + "description": "Custom Fields are identified by the `TableKey` and `ErpKey` values together.\r\n \r\nExample: You have an invoice whose ID number is 100047878, and you wish to store a custom field on that\r\ninvoice named \"ApprovalStatusCode\". For the `TableKey` field, specify the value `Invoice`.\r\n \r\nRecognized types include:\r\n* `Company` - Link this custom field to a CompanySyncModel\r\n* `Contact` - Link this custom field to a ContactSyncModel\r\n* `Invoice` - Link this custom field to an InvoiceSyncModel\r\n* `InvoiceLine` - Link this custom field to an InvoiceLineSyncModel\r\n* `Payment` - Link this custom field to a PaymentSyncModel" }, - "name": { + "customFieldLabel": { "type": "string", - "description": "The name of the debtor who will receive the payment request.", + "description": "A label that uniquely identifies this custom field within your software.\r\n \r\nExample: You have an invoice whose ID number is 100047878, and you wish to store a custom field on that\r\ninvoice named \"ApprovalStatusCode\". For the `CustomFieldLabel` field, specify the value `ApprovalStatusCode`." + }, + "stringValue": { + "type": "string", + "description": "The value of this custom field, if it is stored in string format.", + "nullable": true, + "deprecated": true + }, + "numericValue": { + "type": "number", + "description": "The value of this custom field, if it is stored in numeric format.", + "format": "double", + "nullable": true, + "deprecated": true + }, + "value": { + "type": "string", + "description": "The value of this custom field.", "nullable": true }, - "emailAddress": { + "created": { "type": "string", - "description": "The email address of the debtor who will receive the payment request.", + "description": "If known, the date when this record was created according to the originating financial system\r\nin which this record is maintained. If the originating financial system does not maintain a\r\ncreated-date, leave this field null.", + "format": "date-time", "nullable": true }, - "debtorAgentAccount": { - "allOf": [ - { - "$ref": "#/components/schemas/DebtorAgentAccount" - } - ], - "description": "Debtor Agent Account object.", + "modified": { + "type": "string", + "description": "If known, the date when this record was most recently modified according to the originating\r\nfinancial system in which this record is maintained. If the originating financial system does\r\nnot maintain a most-recently-modified-date, leave this field null.", + "format": "date-time", "nullable": true } }, - "additionalProperties": false, - "description": "A Service Fabric Debtor Account." + "additionalProperties": { }, + "description": "The CustomFieldSyncModel represents information coming into ADS from an external financial system or other\r\nenterprise resource planning system. [Custom Fields](https://developer.lockstep.io/docs/custom-fields#custom-fields)\r\nrepresent custom data extensions that you can use with the Accounting Data Service. If you need to store extra\r\ninformation about an object that does not match ADS's official schema, you can store it in the Custom\r\nField system using CustomFieldSyncModel.\r\n \r\nTo store a custom field for an object, create a CustomFieldSyncModel record containing the `TableKey` and\r\n`ErpKey` of the entity to which you will attach a custom field. Next specify the field's `CustomFieldLabel`\r\nand either a `StringValue` or `NumericValue`.\r\n \r\nOnce imported, this record will be available in the Accounting Data Service API as a [CustomFieldValueModel](https://developer.lockstep.io/docs/customfieldvaluemodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." }, - "DebtorAgentAccount": { + "CustomFieldValueModel": { + "required": [ + "customFieldLabel", + "tableKey" + ], "type": "object", "properties": { - "schemaName": { + "groupKey": { "type": "string", - "description": "Name of the identification scheme." + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", + "format": "uuid", + "readOnly": true }, - "identification": { + "customFieldDefinitionId": { "type": "string", - "description": "The unique identifier of the underlying debtor account to which a debit entry will be made as a result of the transaction." + "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.", + "format": "uuid", + "readOnly": true, + "deprecated": true }, - "last4Digits": { + "recordKey": { "type": "string", - "description": "Last 4 digits of real-world account.", - "nullable": true + "description": "Additional key if source table doesn't have a unique id", + "format": "uuid", + "readOnly": true }, - "brand": { + "tableKey": { + "maxLength": 40, + "minLength": 1, "type": "string", - "description": "Real-world account brand name (for example, Visa, Mastercard, PayPal and so on)", + "description": "Table to which this definition belongs", + "readOnly": true + }, + "customFieldLabel": { + "maxLength": 256, + "minLength": 1, + "type": "string", + "allOf": [ + { + "pattern": "^[a-zA-Z0-9_.~\\- ]*$" + }, + { + "pattern": "^[a-zA-Z0-9_.~\\- ]*$" + } + ], + "description": "Text to display in-application for custom field", + "readOnly": true + }, + "dataType": { + "maxLength": 10, + "minLength": 0, + "type": "string", + "description": "Data type of this definition", + "default": "String", "nullable": true - } - }, - "additionalProperties": false, - "description": "A Service Fabric Debtor Agent Account." - }, - "DeleteResult": { - "type": "object", - "properties": { - "messages": { - "type": "array", - "items": { - "type": "string" - }, - "description": "If the API call produced messages, this element will contain a list of user-visible\r\ntext strings that contain information about what work occurred in the API.", + }, + "stringValue": { + "maxLength": 2048, + "type": "string", + "description": "String of data for field", + "nullable": true, + "deprecated": true + }, + "numericValue": { + "type": "number", + "description": "Number data for field", + "format": "double", + "nullable": true, + "deprecated": true + }, + "created": { + "type": "string", + "description": "Date created", + "format": "date-time", + "readOnly": true + }, + "createdUserId": { + "type": "string", + "description": "Id of user who created this value", + "format": "uuid", + "readOnly": true + }, + "modified": { + "type": "string", + "description": "Date modified", + "format": "date-time", + "readOnly": true + }, + "modifiedUserId": { + "type": "string", + "description": "Id of user who modified this value", + "format": "uuid", + "readOnly": true + }, + "appEnrollmentId": { + "type": "string", + "description": "The AppEnrollmentId of the application that imported this attachment 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.", + "format": "uuid", + "nullable": true, + "readOnly": true + }, + "value": { + "maxLength": 2048, + "minLength": 0, + "type": "string", + "description": "The value of this custom field.", "nullable": true + }, + "customFieldDefinition": { + "allOf": [ + { + "$ref": "#/components/schemas/CustomFieldDefinitionModel" + } + ], + "description": "Definition of the value", + "nullable": true, + "readOnly": true } }, "additionalProperties": false, - "description": "Information about result of delete operations" + "description": "A Custom Field represents metadata added to an object within the Accounting Data Service. ADS provides a\r\ncore definition for each object. The core definition is intended to represent a level of compatibility\r\nthat provides support across most accounting systems and products. When a user or developer requires\r\ninformation beyond this core definition, you can use Custom Fields to represent this information.\r\n \r\nSee [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information." }, - "DeveloperAccountSubmitModel": { - "required": [ - "companyName", - "email" - ], + "CustomFieldValueModelFetchResult": { "type": "object", "properties": { - "firstName": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "description": "The first name of the person requesting the developer account.", + "totalCount": { + "type": "integer", + "format": "int32", "nullable": true }, - "lastName": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "description": "The last name of the person requesting the developer account.", + "pageSize": { + "type": "integer", + "format": "int32", "nullable": true }, - "email": { - "maxLength": 99, - "minLength": 0, - "type": "string", - "description": "The email address of the developer.", - "format": "email" + "pageNumber": { + "type": "integer", + "format": "int32", + "nullable": true }, - "companyName": { - "maxLength": 100, - "minLength": 0, - "type": "string", - "description": "The company name of the developer." + "records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldValueModel" + }, + "nullable": true } }, - "additionalProperties": false, - "description": "Model containing information to create a new developer account." + "additionalProperties": false }, - "DirectoryCompany": { + "CustomerSummaryModel": { "type": "object", "properties": { - "dataSet": { - "allOf": [ - { - "$ref": "#/components/schemas/DirectoryDataSet" - } - ], - "description": "The field indicates the dataset type used to generate the directory company." - }, - "id": { + "groupKey": { "type": "string", - "description": "Unique identifier of this record based on the dataset.\r\n\r\nExamples of this would be:\r\n * DataSet = Siren, Identifier = string\r\n * DataSet = Siret, Identifier = string\r\n", - "nullable": true + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", + "format": "uuid" }, - "companyType": { + "companyId": { "type": "string", - "description": "This field indicates the type of company.", - "nullable": true + "description": "The unique ID of this company.", + "format": "uuid" }, - "name": { + "companyName": { "type": "string", - "description": "The name of the directory company entity.", + "description": "The name of the company.", "nullable": true }, - "address1": { + "primaryContact": { "type": "string", - "description": "Address info", + "description": "The name of the primary contact.", "nullable": true }, - "address2": { + "appEnrollmentId": { "type": "string", - "description": "Address info", + "description": "The app enrollment ID this Customer is associated with", + "format": "uuid", "nullable": true }, - "address3": { - "type": "string", - "description": "Address info", + "outstandingInvoices": { + "type": "integer", + "description": "The number of outstanding invoices for this customer.", + "format": "int32", "nullable": true }, - "city": { - "type": "string", - "description": "Address info", - "nullable": true + "totalInvoicesOpen": { + "type": "integer", + "description": "The number of open invoices.", + "format": "int32", + "nullable": true, + "deprecated": true }, - "country": { - "type": "string", - "description": "Address info", - "nullable": true + "totalInvoicesPastDue": { + "type": "integer", + "description": "The number of past due invoices.", + "format": "int32", + "nullable": true, + "deprecated": true }, - "postalCode": { - "type": "string", - "description": "Address info", - "nullable": true + "closedInvoices": { + "type": "integer", + "description": "The number of closed invoices for this customer.", + "format": "int32", + "nullable": true, + "deprecated": true }, - "phoneNumber": { - "type": "string", - "description": "Phone number", - "nullable": true + "closedInvoicesPastThirtyDays": { + "type": "integer", + "description": "The number of closed invoices for this customer in the past thirty days.", + "format": "int32", + "nullable": true, + "deprecated": true }, - "emailAddress": { - "type": "string", - "description": "Email address", + "amountCollected": { + "type": "number", + "description": "The total from collected payments.", + "format": "double", + "nullable": true, + "deprecated": true + }, + "amountCollectedPastThirtyDays": { + "type": "number", + "description": "The total from collected payments in the past thirty days.", + "format": "double", + "nullable": true, + "deprecated": true + }, + "outstandingAmount": { + "type": "number", + "description": "The total balance of outstanding invoices.", + "format": "double", "nullable": true }, - "createdDateTime": { - "type": "string", - "description": "The date this directory company entity was created", - "format": "date-time" + "invoicedAmountPastThirtyDays": { + "type": "number", + "description": "The total amount invoiced in the past thirty days.", + "format": "double", + "nullable": true, + "deprecated": true }, - "modifiedDateTime": { - "type": "string", - "description": "The date this directory company entity was modified", - "format": "date-time" - } - }, - "additionalProperties": false, - "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." - }, - "DirectoryDataSet": { - "enum": [ - 0, - 1, - 2 - ], - "type": "integer", - "description": "Different dataset types to retrieve information from the Directory Service", - "format": "int32" - }, - "EmailReplyGeneratorRequest": { - "required": [ - "body", - "date", - "subject" - ], - "type": "object", - "properties": { - "date": { - "minLength": 1, - "type": "string", - "description": "The date associated with the email", - "format": "date-time" + "outstandingAmountPastThirtyDays": { + "type": "number", + "description": "The total amount outstanding from the invoices invoiced in the past thirty days.", + "format": "double", + "nullable": true, + "deprecated": true }, - "body": { - "minLength": 1, - "type": "string", - "description": "The body associated with the email" + "invoicesPastThirtyDays": { + "type": "integer", + "description": "The number of invoices invoiced in the past thirty days.", + "format": "int32", + "nullable": true, + "deprecated": true }, - "subject": { - "minLength": 1, - "type": "string", - "description": "The subject associated with the email" - } - }, - "additionalProperties": false, - "description": "Represents the request to the SAGE GMS API" - }, - "EmailReplyGeneratorResponse": { - "type": "object", - "properties": { - "message_id": { - "type": "string", - "description": "The id for this request in the GMS system", - "format": "uuid", + "amountPastDue": { + "type": "number", + "description": "The total amount past due for this customer.", + "format": "double", "nullable": true }, - "suggestions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EmailReplyGeneratorSuggestions" - }, - "description": "A list of suggested email reply responses", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Represents the response from SAGE GMS API" - }, - "EmailReplyGeneratorSuggestions": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "description": "The kind of reply generated by the GMS Api", - "nullable": true + "unappliedPayments": { + "type": "number", + "description": "The total value of unapplied Payments for this Customer.", + "format": "double", + "nullable": true, + "deprecated": true }, - "body": { - "type": "string", - "description": "The body of the reply generated by the GMS Api", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Represents the email reply suggestion from the SAGE GMS API" - }, - "ErpModel": { - "type": "object", - "properties": { - "erpSystemId": { - "type": "string", - "description": "Unique ID for this ERP", - "format": "uuid" + "unappliedAmountPastThirtyDays": { + "type": "number", + "description": "The total value of unapplied Payments for this Customer in the past thirty days.", + "format": "double", + "nullable": true, + "deprecated": true }, - "name": { - "maxLength": 255, - "minLength": 0, + "percentOfTotalAr": { + "type": "number", + "description": "Portion of Total AR for this Customer that is Past due. (TotalPastDue / Total AR).", + "format": "double", + "nullable": true, + "deprecated": true + }, + "dso": { + "type": "number", + "description": "Daily sales outstanding value for this Customer.", + "format": "double", + "nullable": true, + "deprecated": true + }, + "newestActivity": { "type": "string", - "description": "Name of ERP", - "nullable": true + "description": "The date stamp for the newest Activity on this Customer.", + "format": "date", + "nullable": true, + "deprecated": true }, - "isSupported": { - "type": "boolean", - "description": "Flag to indicate if ERP is supported" + "modified": { + "type": "string", + "description": "The modified date of the customer.", + "format": "date-time" } }, "additionalProperties": false, - "description": "Represents unsupported ERP systems" + "description": "Contains summarized data for a customer" }, - "ErpModelFetchResult": { + "CustomerSummaryModelFetchResult": { "type": "object", "properties": { "totalCount": { @@ -25503,208 +20911,152 @@ "records": { "type": "array", "items": { - "$ref": "#/components/schemas/ErpModel" + "$ref": "#/components/schemas/CustomerSummaryModel" }, "nullable": true } }, "additionalProperties": false }, - "ErpUpdateAction": { - "enum": [ - 0, - 1, - 2, - 3 - ], - "type": "integer", - "description": "Possible actions for a record that supports ERP Update.", - "format": "int32" - }, - "ErpUpdateStatus": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 5, - 6, - 7 - ], - "type": "integer", - "description": "Possible statuses for a record that supports ERP Update.", - "format": "int32" - }, - "ErpWriteStatuses": { - "enum": [ - 0, - 1, - 2, - 3, - 4, - 5 - ], - "type": "integer", - "description": "Possible statuses for a record that supports ERP write.", - "format": "int32" - }, - "Error": { + "DebtorAccount": { "type": "object", "properties": { - "status": { - "type": "integer", - "description": "Status of error", - "format": "int32" - }, - "source": { - "allOf": [ - { - "$ref": "#/components/schemas/Source" - } - ], - "description": "Source of Error", + "customerId": { + "type": "string", + "description": "The unique identifier of an existing customer. Will be used to match to a reusable payment\r\nmethod if one exists. If specified, the other properties on this object will be ignored.\r\nTrying to create a payment with an unknown customer will result in a 400 status code response.", "nullable": true }, - "detail": { + "accountId": { "type": "string", - "description": "Error Detail", + "description": "The merchant's unique identifier of the debtor who will receive the payment request.", "nullable": true }, - "title": { + "name": { "type": "string", - "description": "Errors Title", + "description": "The name of the debtor who will receive the payment request.", "nullable": true }, - "code": { + "emailAddress": { "type": "string", - "description": "Errors code", + "description": "The email address of the debtor who will receive the payment request.", "nullable": true }, - "entityMeta": { + "debtorAgentAccount": { "allOf": [ { - "$ref": "#/components/schemas/Meta" + "$ref": "#/components/schemas/DebtorAgentAccount" } ], - "description": "Contains meta about entity", + "description": "Debtor Agent Account object.", "nullable": true } }, "additionalProperties": false, - "description": "Contains Errors details" + "description": "A Service Fabric Debtor Account." }, - "ExternalConnector": { + "DebtorAgentAccount": { "type": "object", "properties": { - "id": { - "type": "string", - "description": "External Connector ID", - "nullable": true - }, - "name": { + "schemaName": { "type": "string", - "description": "External connector name", - "nullable": true + "description": "Name of the identification scheme." }, - "onboardingUrl": { + "identification": { "type": "string", - "description": "URL to start onboarding with the given external connector", - "nullable": true + "description": "The unique identifier of the underlying debtor account to which a debit entry will be made as a result of the transaction." }, - "description": { + "last4Digits": { "type": "string", - "description": "Information about the external connector.", + "description": "Last 4 digits of real-world account.", "nullable": true }, - "categories": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Categories external connector is associated with", - "nullable": true - } - }, - "additionalProperties": false, - "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." - }, - "ExternalConnectorAuth": { - "type": "object", - "properties": { - "authenticationUrl": { + "brand": { "type": "string", - "description": "The URL to open a browser with. This begins the user authentication process driven by a provider.", + "description": "Real-world account brand name (for example, Visa, Mastercard, PayPal and so on)", "nullable": true } }, "additionalProperties": false, - "description": "An ExternalConnectorAuth represents the authentication starting point of the Sage Connections Service workflow to connect\r\nthe customer to an external connector." + "description": "A Service Fabric Debtor Agent Account." }, - "ExternalConnectorAuthRequest": { + "DeleteResult": { "type": "object", "properties": { - "scopes": { + "messages": { "type": "array", "items": { "type": "string" }, - "description": "An array of scopes requested from 3rd-party provider.", - "nullable": true - }, - "redirectUrl": { - "type": "string", - "description": "The URL the browser is redirected to after a user grants, or denies, permissions for Sage software.", - "nullable": true - }, - "connectionContextId": { - "type": "string", - "description": "Opaque value that a secret will be tagged with on the service side when created", + "description": "If the API call produced messages, this element will contain a list of user-visible\r\ntext strings that contain information about what work occurred in the API.", "nullable": true } }, "additionalProperties": false, - "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." + "description": "Information about result of delete operations" }, - "ExternalConnectorToken": { + "DeveloperAccountSubmitModel": { + "required": [ + "companyName", + "email" + ], "type": "object", "properties": { - "id": { + "firstName": { + "maxLength": 50, + "minLength": 0, "type": "string", - "description": "ID of the token reference.", + "description": "The first name of the person requesting the developer account.", "nullable": true }, - "authenticatedAt": { + "lastName": { + "maxLength": 50, + "minLength": 0, "type": "string", - "description": "When the user was authenticated.", - "format": "date-time" - }, - "scopes": { - "type": "array", - "items": { - "type": "string" - }, - "description": "An array of scopes requested from 3rd-party external connector.", + "description": "The last name of the person requesting the developer account.", "nullable": true }, - "expiresAt": { - "type": "string", - "description": "When the token expires. This can be earlier if the token is revoked.", - "format": "date-time" - }, - "externalConnectorId": { + "email": { + "maxLength": 99, + "minLength": 0, "type": "string", - "description": "External Connector ID", - "nullable": true + "description": "The email address of the developer.", + "format": "email" }, - "connectionContextId": { + "companyName": { + "maxLength": 100, + "minLength": 0, "type": "string", - "description": "Connection context ID set by the product when starting onboarding with a external connector", - "nullable": true + "description": "The company name of the developer." } }, "additionalProperties": false, - "description": "An ExternalConnectorToken represents the token information for a customer's valid, expired or revoked connection to\r\nan external connector." + "description": "Model containing information to create a new developer account." + }, + "ErpUpdateAction": { + "enum": [ + 0, + 1, + 2, + 3 + ], + "type": "integer", + "description": "Possible actions for a record that supports ERP Update.", + "format": "int32" + }, + "ErpUpdateStatus": { + "enum": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7 + ], + "type": "integer", + "description": "Possible statuses for a record that supports ERP Update.", + "format": "int32" }, "FeatureFlagsRequestModel": { "type": "object", @@ -25728,8 +21080,7 @@ "values": { "type": "object", "additionalProperties": { - "type": "boolean", - "nullable": true + "type": "boolean" }, "description": "State of the requested Feature Flags", "nullable": true @@ -25746,13 +21097,13 @@ "properties": { "financialAccountBalanceHistoryId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.", + "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.", "format": "uuid", "readOnly": true }, "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "readOnly": true }, @@ -25887,7 +21238,7 @@ }, "financialAccountErpKey": { "type": "string", - "description": "This is the primary key of the FinancialAccount record. For this field, you should use whatever the company's unique\r\nidentifying number is in the originating system. Search for a unique, non-changing number within the\r\noriginating financial system for this record.\r\nExample: If you store your company records in a database, whatever the primary key for the company table is\r\nin the database should be the ErpKey.\r\nExample: If you use a financial system such as QuickBooks or Xero, look for the primary ID number of the\r\ncompany record within that financial system.", + "description": "This is the primary key of the FinancialAccount record. For this field, you should use whatever the company's unique\r\nidentifying number is in the originating system. Search for a unique, non-changing number within the\r\noriginating financial system for this record.\r\nExample: If you store your company records in a database, whatever the primary key for the company table is\r\nin the database should be the ErpKey.", "nullable": true }, "financialYear": { @@ -25929,8 +21280,8 @@ "nullable": true } }, - "additionalProperties": {}, - "description": "The FinancialAccountBalanceHistorySyncModel represents information coming into ADS 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 FinancialAccountBalanceHistorySyncModel 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 ADS\r\nPlatform.\r\n \r\nIf the FinancialAccountBalanceHistorySyncModels are imported via a connector instead, please ensure that all records are passed in\r\non every sync. Records that are not passed in will be assumed to be deleted.\r\n \r\nOnce imported, this record will be available in the ADS Platform API as a [FinancialAccountBalanceHistoryModel](https://developer.lockstep.io/docs/financialaccountbalancehistorymodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." + "additionalProperties": { }, + "description": "The FinancialAccountBalanceHistorySyncModel represents information coming into ADS 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 FinancialAccountBalanceHistorySyncModel 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 ADS\r\nPlatform.\r\n \r\nIf the FinancialAccountBalanceHistorySyncModels are imported via a connector instead, please ensure that all records are passed in\r\non every sync. Records that are not passed in will be assumed to be deleted.\r\n \r\nOnce imported, this record will be available in the Accounting Data Service API as a [FinancialAccountBalanceHistoryModel](https://developer.lockstep.io/docs/financialaccountbalancehistorymodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." }, "FinancialAccountBalanceType": { "enum": [ @@ -25952,7 +21303,7 @@ }, "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "readOnly": true }, @@ -26153,8 +21504,8 @@ "nullable": true } }, - "additionalProperties": {}, - "description": "The FinancialAccountSyncModel represents information coming into ADS 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 FinancialAccountSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the ADS Platform API as a [FinancialAccountModel](https://developer.lockstep.io/docs/financialaccountmodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." + "additionalProperties": { }, + "description": "The FinancialAccountSyncModel represents information coming into ADS 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 FinancialAccountSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the Accounting Data Service API as a [FinancialAccountModel](https://developer.lockstep.io/docs/financialaccountmodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." }, "FinancialInstitutionAccountModel": { "type": "object", @@ -26167,7 +21518,7 @@ }, "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "readOnly": true }, @@ -26206,173 +21557,88 @@ "description": "The status of the Financial Institution Account. Possible values are active,\r\ninactive, deleted or archived.", "nullable": true }, - "description": { - "maxLength": 500, - "minLength": 0, - "type": "string", - "description": "The description for the Financial Institution Account.", - "nullable": true - }, - "accountType": { - "maxLength": 10, - "minLength": 0, - "type": "string", - "description": "The classification for the Financial Institution Account. Possible values are Asset, Equity,\r\nExpense, Liability or Income.", - "nullable": true - }, - "created": { - "type": "string", - "description": "The date the Financial Institution Account was created.", - "format": "date-time", - "readOnly": true - }, - "createdUserId": { - "type": "string", - "description": "The user that has created the Financial Institution Account.", - "format": "uuid", - "readOnly": true - }, - "modified": { - "type": "string", - "description": "The date the Financial Institution Account was modified.", - "format": "date-time", - "readOnly": true - }, - "modifiedUserId": { - "type": "string", - "description": "The user that has modified the Financial Institution Account.", - "format": "uuid", - "readOnly": true - } - }, - "additionalProperties": false, - "description": "An Financial Institution Account represents an account used for monetary transactions. E.g. - checking, savings, or credit card accounts." - }, - "FinancialInstitutionAccountModelFetchResult": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageSize": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageNumber": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FinancialInstitutionAccountModel" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "FinancialReportCellModel": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "The value of the financial report cell", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Represents a cell of a financial report" - }, - "FinancialReportModel": { - "type": "object", - "properties": { - "reportName": { + "description": { + "maxLength": 500, + "minLength": 0, "type": "string", - "description": "The name of the report (\"*Report Type* for *Company*\")", + "description": "The description for the Financial Institution Account.", "nullable": true }, - "groupKey": { + "accountType": { + "maxLength": 10, + "minLength": 0, "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid" + "description": "The classification for the Financial Institution Account. Possible values are Asset, Equity,\r\nExpense, Liability or Income.", + "nullable": true }, - "reportStartDate": { + "created": { "type": "string", - "description": "The start date of the financial report", - "format": "date-time" + "description": "The date the Financial Institution Account was created.", + "format": "date-time", + "readOnly": true }, - "reportEndDate": { + "createdUserId": { "type": "string", - "description": "The end date of the financial report", - "format": "date-time" + "description": "The user that has created the Financial Institution Account.", + "format": "uuid", + "readOnly": true }, - "reportCreatedDate": { + "modified": { "type": "string", - "description": "The created date of the financial report", - "format": "date-time" + "description": "The date the Financial Institution Account was modified.", + "format": "date-time", + "readOnly": true }, - "rows": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FinancialReportRowModel" - }, - "description": "The rows of the financial report", - "nullable": true + "modifiedUserId": { + "type": "string", + "description": "The user that has modified the Financial Institution Account.", + "format": "uuid", + "readOnly": true } }, "additionalProperties": false, - "description": "Represents a Financial Report" + "description": "An Financial Institution Account represents an account used for monetary transactions. E.g. - checking, savings, or credit card accounts." }, - "FinancialReportRowModel": { + "FinancialInstitutionAccountModelFetchResult": { "type": "object", "properties": { - "rowType": { - "type": "string", - "description": "Describes what type of row this row is (Header, Summary, Classification, Category, Subcategory, Data)", + "totalCount": { + "type": "integer", + "format": "int32", "nullable": true }, - "label": { - "type": "string", - "description": "The label for the row if it is a Classification, Category, or Subcategory.", + "pageSize": { + "type": "integer", + "format": "int32", "nullable": true }, - "rows": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FinancialReportRowModel" - }, - "description": "The sub rows of this row if it is a Classification, Category, or Subcategory.", + "pageNumber": { + "type": "integer", + "format": "int32", "nullable": true }, - "cells": { + "records": { "type": "array", "items": { - "$ref": "#/components/schemas/FinancialReportCellModel" + "$ref": "#/components/schemas/FinancialInstitutionAccountModel" }, - "description": "The cells of the row", "nullable": true } }, - "additionalProperties": false, - "description": "Represents a row of a financial Report report" + "additionalProperties": false }, "FinancialYearSettingModel": { "type": "object", "properties": { "financialYearSettingId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.", + "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.", "format": "uuid", "readOnly": true }, "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "readOnly": true }, @@ -26496,8 +21762,8 @@ "description": "The end date of the financial year. Should be entered in MM-DD format." } }, - "additionalProperties": {}, - "description": "The FinancialYearSettingSyncModel represents information coming into ADS 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 FinancialYearSettingSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the ADS Platform API as a [FinancialYearSettingModel](https://developer.lockstep.io/docs/financialyearsettingmodel).\r\nSync is supported for only one FinancialYearSetting per app enrollment and one FinancialYearSetting imported outside of\r\nan app enrollment - please submit only one model here. If multiple models are submitted, only the latest one is considered for Sync.\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." + "additionalProperties": { }, + "description": "The FinancialYearSettingSyncModel represents information coming into ADS 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 FinancialYearSettingSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the Accounting Data Service API as a [FinancialYearSettingModel](https://developer.lockstep.io/docs/financialyearsettingmodel).\r\nSync is supported for only one FinancialYearSetting per app enrollment and one FinancialYearSetting imported outside of\r\nan app enrollment - please submit only one model here. If multiple models are submitted, only the latest one is considered for Sync.\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." }, "GroupAccountModel": { "required": [ @@ -26511,7 +21777,7 @@ "properties": { "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "readOnly": true }, @@ -26576,91 +21842,17 @@ "minLength": 2, "type": "string", "description": "The 2-letter ISO country code for the group" - } - }, - "additionalProperties": false, - "description": "Represents an account for an entire group" - }, - "InboundSyncReportData": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique Id of this resource in system.", - "nullable": true }, - "type": { + "eInvoiceSyncWorkflowStatus": { "type": "string", - "description": "A known resource type.", - "nullable": true - }, - "attributes": { - "allOf": [ - { - "$ref": "#/components/schemas/InboundSyncReportSummaryModel" - } - ], - "description": "Attributes of the resource to explain the object.", - "nullable": true - }, - "relationships": { - "allOf": [ - { - "$ref": "#/components/schemas/Relationship" - } - ], - "description": "Relationships of the resource.", - "nullable": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Error" - }, - "description": "Contains list of Errors", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Contains Errors collection" - }, - "InboundSyncReportDataJsonApiDataModel": { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/InboundSyncReportData" - } - ], - "description": "Json API data.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Standard Json API data model.\r\nhttps://jsonapi.org/" - }, - "InboundSyncReportSummaryModel": { - "type": "object", - "properties": { - "totalCreated": { - "type": "integer", - "description": "Total Created entities", - "format": "int32" - }, - "totalUpdate": { - "type": "integer", - "description": "Total Updated entities", - "format": "int32" - }, - "totalDeleted": { - "type": "integer", - "description": "Total Deleted entities", - "format": "int32" + "description": "Workflow status when ERP sync is started for e-Invoices", + "format": "uuid", + "nullable": true, + "readOnly": true } }, "additionalProperties": false, - "description": "Contains manifest summary details" + "description": "Represents an account for an entire group" }, "InstructedAmount": { "type": "object", @@ -26769,12 +21961,12 @@ "properties": { "invoiceAddressId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.", + "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.", "format": "uuid" }, "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid" }, "invoiceId": { @@ -26914,13 +22106,13 @@ "properties": { "invoiceLineId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", + "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", "format": "uuid", "readOnly": true }, "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "readOnly": true }, @@ -27062,24 +22254,6 @@ "format": "date", "nullable": true }, - "overrideOriginAddressId": { - "type": "string", - "description": "An optional ID number for the line's origin address.", - "format": "uuid", - "nullable": true - }, - "overrideBillToAddressId": { - "type": "string", - "description": "An optional ID number for the line's bill to address.", - "format": "uuid", - "nullable": true - }, - "overrideShipToAddressId": { - "type": "string", - "description": "An optional ID number for the line's ship to address.", - "format": "uuid", - "nullable": true - }, "created": { "type": "string", "description": "The date on which this line was created.", @@ -27142,7 +22316,9 @@ "nullable": true }, "description": "Additional attributes that may be required by the source system.", - "nullable": true + "nullable": true, + "readOnly": true, + "deprecated": true }, "notes": { "type": "array", @@ -27212,7 +22388,7 @@ }, "networkId": { "type": "string", - "description": "The unique identifier of this object in the Sage Network platform.", + "description": "The unique identifier of this object in the Accounting Data Service.", "format": "uuid", "nullable": true }, @@ -27297,188 +22473,47 @@ "taxRate": { "type": "number", "description": "The taxation rate for this line.", - "format": "double", - "nullable": true - }, - "salesTaxAmount": { - "type": "number", - "description": "The amount of sales tax for this line in the transaction's currency.", - "format": "double", - "nullable": true - }, - "baseCurrencySalesTaxAmount": { - "type": "number", - "description": "The amount of sales tax for this line in the base currency.", - "format": "double", - "nullable": true - }, - "netAmount": { - "type": "number", - "description": "The total value of this invoice line with deductions, excluding taxes.", - "format": "double", - "nullable": true - }, - "baseCurrencyNetAmount": { - "type": "number", - "description": "The total value of this invoice line with deductions, excluding taxes and in the invoice's base currency.", - "format": "double", - "nullable": true - }, - "exemptionCode": { - "type": "string", - "description": "If this line is tax exempt, this code indicates the reason for the exemption.", - "nullable": true - }, - "taxUid": { - "type": "string", - "description": "Unique identifier for tax purposes, used for reference, validation, or compliance.", - "nullable": true - }, - "reportingDate": { - "type": "string", - "description": "If null, the products specified on this line were delivered on the same date as all other lines.\r\nIf not null, this line was delivered or finalized on a different date than the overall invoice.", - "format": "date-time", - "nullable": true - }, - "originAddressLine1": { - "type": "string", - "description": "Origination address for this invoice line, if this line item was originated from a different address", - "nullable": true - }, - "originAddressLine2": { - "type": "string", - "description": "Origination address for this invoice line, if this line item was originated from a different address", - "nullable": true - }, - "originAddressLine3": { - "type": "string", - "description": "Origination address for this invoice line, if this line item was originated from a different address", - "nullable": true - }, - "originAddressCity": { - "type": "string", - "description": "Origination address for this invoice line, if this line item was originated from a different address", - "nullable": true - }, - "originAddressRegion": { - "type": "string", - "description": "Origination address for this invoice line, if this line item was originated from a different address", - "nullable": true - }, - "originAddressPostalCode": { - "type": "string", - "description": "Origination address for this invoice line, if this line item was originated from a different address", - "nullable": true - }, - "originAddressCountry": { - "type": "string", - "description": "Origination address for this invoice line, if this line item was originated from a different address", - "nullable": true - }, - "originAddressLatitude": { - "type": "number", - "description": "Origination address for this invoice line, if this line item was originated from a different address", - "format": "float", - "nullable": true - }, - "originAddressLongitude": { - "type": "number", - "description": "Origination address for this invoice line, if this line item was originated from a different address", - "format": "float", - "nullable": true - }, - "billToAddressLine1": { - "type": "string", - "description": "Billing address for this invoice line, if this line item is to be billed to a different address", - "nullable": true - }, - "billToAddressLine2": { - "type": "string", - "description": "Billing address for this invoice line, if this line item is to be billed to a different address", - "nullable": true - }, - "billToAddressLine3": { - "type": "string", - "description": "Billing address for this invoice line, if this line item is to be billed to a different address", - "nullable": true - }, - "billToAddressCity": { - "type": "string", - "description": "Billing address for this invoice line, if this line item is to be billed to a different address", - "nullable": true - }, - "billToAddressRegion": { - "type": "string", - "description": "Billing address for this invoice line, if this line item is to be billed to a different address", - "nullable": true - }, - "billToAddressPostalCode": { - "type": "string", - "description": "Billing address for this invoice line, if this line item is to be billed to a different address", - "nullable": true - }, - "billToAddressCountry": { - "type": "string", - "description": "Billing address for this invoice line, if this line item is to be billed to a different address", - "nullable": true - }, - "billToAddressLatitude": { - "type": "number", - "description": "Billing address for this invoice line, if this line item is to be billed to a different address", - "format": "float", - "nullable": true - }, - "billToAddressLongitude": { - "type": "number", - "description": "Billing address for this invoice line, if this line item is to be billed to a different address", - "format": "float", - "nullable": true - }, - "shipToAddressLine1": { - "type": "string", - "description": "Shipping address for this invoice line, if this line item is to be shipped to a different address", - "nullable": true - }, - "shipToAddressLine2": { - "type": "string", - "description": "Shipping address for this invoice line, if this line item is to be shipped to a different address", + "format": "double", "nullable": true }, - "shipToAddressLine3": { - "type": "string", - "description": "Shipping address for this invoice line, if this line item is to be shipped to a different address", + "salesTaxAmount": { + "type": "number", + "description": "The amount of sales tax for this line in the transaction's currency.", + "format": "double", "nullable": true }, - "shipToAddressCity": { - "type": "string", - "description": "Shipping address for this invoice line, if this line item is to be shipped to a different address", + "baseCurrencySalesTaxAmount": { + "type": "number", + "description": "The amount of sales tax for this line in the base currency.", + "format": "double", "nullable": true }, - "shipToAddressRegion": { - "type": "string", - "description": "Shipping address for this invoice line, if this line item is to be shipped to a different address", + "netAmount": { + "type": "number", + "description": "The total value of this invoice line with deductions, excluding taxes.", + "format": "double", "nullable": true }, - "shipToAddressPostalCode": { - "type": "string", - "description": "Shipping address for this invoice line, if this line item is to be shipped to a different address", + "baseCurrencyNetAmount": { + "type": "number", + "description": "The total value of this invoice line with deductions, excluding taxes and in the invoice's base currency.", + "format": "double", "nullable": true }, - "shipToAddressCountry": { + "exemptionCode": { "type": "string", - "description": "Shipping address for this invoice line, if this line item is to be shipped to a different address", + "description": "If this line is tax exempt, this code indicates the reason for the exemption.", "nullable": true }, - "shipToAddressLatitude": { - "type": "number", - "description": "Shipping address for this invoice line, if this line item is to be shipped to a different address", - "format": "float", + "taxUid": { + "type": "string", + "description": "Unique identifier for tax purposes, used for reference, validation, or compliance.", "nullable": true }, - "shipToAddressLongitude": { - "type": "number", - "description": "Shipping address for this invoice line, if this line item is to be shipped to a different address", - "format": "float", + "reportingDate": { + "type": "string", + "description": "If null, the products specified on this line were delivered on the same date as all other lines.\r\nIf not null, this line was delivered or finalized on a different date than the overall invoice.", + "format": "date-time", "nullable": true }, "created": { @@ -27494,21 +22529,21 @@ "nullable": true } }, - "additionalProperties": {}, - "description": "The InvoiceLineSyncModel represents information coming into ADS 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 InvoiceLineSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the ADS Platform API as an [InvoiceLineModel](https://developer.lockstep.io/docs/invoicelinemodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." + "additionalProperties": { }, + "description": "The InvoiceLineSyncModel represents information coming into ADS 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 InvoiceLineSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the Accounting Data Service API as an [InvoiceLineModel](https://developer.lockstep.io/docs/invoicelinemodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." }, "InvoiceModel": { "type": "object", "properties": { "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "readOnly": true }, "invoiceId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", + "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", "format": "uuid", "readOnly": true }, @@ -27533,42 +22568,49 @@ }, "erpKey": { "maxLength": 100, + "minLength": 0, "type": "string", "description": "The unique ID of this record as it was known in its originating financial system.\r\n \r\nIf this company 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).", "nullable": true }, "purchaseOrderCode": { "maxLength": 100, + "minLength": 0, "type": "string", "description": "The \"Purchase Order Code\" is a code that is sometimes used by companies to refer to the original PO\r\nthat was sent that caused this invoice to be written. If a customer sends a purchase order to a vendor,\r\nthe vendor can then create an invoice and refer back to the originating purchase order using this field.", "nullable": true }, "referenceCode": { "maxLength": 100, + "minLength": 0, "type": "string", "description": "An additional reference code that is sometimes used to identify this invoice.\r\nThe meaning of this field is specific to the ERP or accounting system used by the user.", "nullable": true }, "salespersonCode": { "maxLength": 50, + "minLength": 0, "type": "string", "description": "A code identifying the salesperson responsible for writing this quote, invoice, or order.", "nullable": true }, "salespersonName": { "maxLength": 50, + "minLength": 0, "type": "string", "description": "A name identifying the salesperson responsible for writing this quote, invoice, or order.", "nullable": true }, "invoiceTypeCode": { "maxLength": 50, + "minLength": 0, "type": "string", "description": "A code identifying the type of this invoice.\r\n \r\nRecognized Invoice types are:\r\n* `AR Invoice` - Represents an invoice sent by Company to the Customer\r\n* `AP Invoice` - Represents an invoice sent by Vendor to the Company\r\n* `AR Credit Memo` - Represents a credit memo generated by Company given to Customer\r\n* `AP Credit Memo` - Represents a credit memo generated by Vendor given to Company", "nullable": true }, "invoiceStatusCode": { "maxLength": 50, + "minLength": 0, "type": "string", "description": "A code identifying the status of this invoice.\r\n \r\nRecognized Invoice status codes are:\r\n* `Open` - Represents an invoice that is considered open and needs more work to complete\r\n* `Closed` - Represents an invoice that is considered closed and resolved", "nullable": true @@ -27581,30 +22623,35 @@ }, "workflowStatusNotes": { "maxLength": 2000, + "minLength": 0, "type": "string", "description": "A description of the current workflow status of this invoice.", "nullable": true }, "workflowStatusReasonCode": { "maxLength": 50, + "minLength": 0, "type": "string", "description": "The reason code for the current workflow status of this invoice.\r\n \r\nEmpty if workflow status does not require a reason code.", "nullable": true }, "termsCode": { "maxLength": 50, + "minLength": 0, "type": "string", "description": "A code identifying the terms given to the purchaser. This field is imported directly from the originating\r\nfinancial system and does not follow a specified format.", "nullable": true }, "specialTerms": { "maxLength": 200, + "minLength": 0, "type": "string", "description": "If the customer negotiated any special terms different from the standard terms above, describe them here.", "nullable": true }, "currencyCode": { "maxLength": 3, + "minLength": 0, "type": "string", "description": "The three-character ISO 4217 currency code used for this invoice.", "nullable": true @@ -27676,6 +22723,12 @@ "format": "date", "nullable": true }, + "plannedPaymentDate": { + "type": "string", + "description": "The date when payment is planned in Connect.", + "format": "date", + "nullable": true + }, "importedDate": { "type": "string", "description": "The date and time when this record was imported from the user's ERP or accounting system.", @@ -27758,6 +22811,8 @@ "description": "Should the invoice be excluded from aging calculations?" }, "preferredDeliveryMethod": { + "maxLength": 20, + "minLength": 0, "type": "string", "description": "Indicates the preferred delivery method for this invoice. Examples include Print, Email, Fax", "nullable": true @@ -27826,7 +22881,8 @@ "$ref": "#/components/schemas/InvoiceWorkflowStatusHistoryModel" }, "description": "All workflow status histories connected to this invoice.\r\nTo retrieve this collection, specify `WorkflowStatuses` in the \"Include\" parameter for your query.", - "nullable": true + "nullable": true, + "readOnly": true }, "addresses": { "type": "array", @@ -27945,7 +23001,9 @@ "nullable": true }, "description": "Additional attributes that may be required by the source system.", - "nullable": true + "nullable": true, + "readOnly": true, + "deprecated": true }, "taxSummary": { "type": "array", @@ -27960,20 +23018,33 @@ "minLength": 0, "type": "string", "description": "The source of the invoice (e.g ERP, Peppol, Email, Gov System)", - "nullable": true, - "readOnly": true + "nullable": true }, "jurisdiction": { "maxLength": 2, - "minLength": 2, + "minLength": 0, "type": "string", "description": "The jurisdiction or country from which the invoice originates (e.g., US, AU)", "nullable": true, "readOnly": true + }, + "createdSyncId": { + "type": "string", + "description": "The ID of the sync task that created this Invoice.", + "format": "uuid", + "nullable": true, + "readOnly": true + }, + "modifiedSyncId": { + "type": "string", + "description": "The ID of the sync task that modified this Invoice.", + "format": "uuid", + "nullable": true, + "readOnly": true } }, "additionalProperties": false, - "description": "An Invoice represents a bill sent from one company to another. The creator of the invoice is identified\r\nby the `CompanyId` field, and the recipient of the invoice is identified by the `CustomerId` field. Most\r\ninvoices are uniquely identified both by a ADS Platform ID number and a customer ERP \"key\" that was\r\ngenerated by the system that originated the invoice. Invoices have a total amount and a due date, and when\r\nsome payments have been made on the Invoice the `TotalAmount` and the `OutstandingBalanceAmount` may be\r\ndifferent." + "description": "An Invoice represents a bill sent from one company to another. The creator of the invoice is identified\r\nby the `CompanyId` field, and the recipient of the invoice is identified by the `CustomerId` field. Most\r\ninvoices are uniquely identified both by a Accounting Data Service ID number and a customer ERP \"key\" that was\r\ngenerated by the system that originated the invoice. Invoices have a total amount and a due date, and when\r\nsome payments have been made on the Invoice the `TotalAmount` and the `OutstandingBalanceAmount` may be\r\ndifferent." }, "InvoiceModelFetchResult": { "type": "object", @@ -27995,7 +23066,7 @@ }, "records": { "type": "array", - "items": {}, + "items": { }, "description": " For more information on Invoices, see [InvoiceModel](https://developer.lockstep.io/reference/get_api-v1-invoices-id).", "nullable": true } @@ -28014,7 +23085,7 @@ "properties": { "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid" }, "baseCurrencyCode": { @@ -28096,6 +23167,23 @@ "description": "The remaining balance value of this Payment in the group's base currency.", "format": "double", "nullable": true + }, + "erpUpdateStatus": { + "allOf": [ + { + "$ref": "#/components/schemas/ErpUpdateStatus" + } + ], + "description": "Possible statuses for a record that supports ERP Update." + }, + "erpUpdateAction": { + "allOf": [ + { + "$ref": "#/components/schemas/ErpUpdateAction" + } + ], + "description": "Possible actions for a record that supports ERP Update.", + "readOnly": true } }, "additionalProperties": false, @@ -28106,7 +23194,7 @@ "properties": { "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid" }, "customerId": { @@ -28333,7 +23421,7 @@ }, "networkId": { "type": "string", - "description": "The unique identifier of this object in the Sage Network platform.", + "description": "The unique identifier of this object in the Accounting Data Service.", "format": "uuid", "nullable": true }, @@ -28472,6 +23560,11 @@ "format": "date-time", "nullable": true }, + "plannedPaymentDate": { + "type": "string", + "description": "The date when payment is planned in Connect.", + "nullable": true + }, "importedDate": { "type": "string", "description": "The date and time when this record was imported from the user's ERP or accounting system.", @@ -28750,15 +23843,15 @@ "nullable": true } }, - "additionalProperties": {}, - "description": "The InvoiceSyncModel represents information coming into ADS 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the ADS Platform 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)." + "additionalProperties": { }, + "description": "The InvoiceSyncModel represents information coming into ADS 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the Accounting Data Service 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)." }, "InvoiceWorkflowStatusHistoryModel": { "type": "object", "properties": { "invoiceWorkflowStatusHistoryId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS Platform when this record is\r\nadded to the Accounting Data Services platform.", + "description": "The unique ID of this record, automatically assigned by Accounting Data Service when this record is\r\nadded to the Accounting Data Services network.", "format": "uuid", "readOnly": true }, @@ -28767,286 +23860,100 @@ "description": "The invoice ID associated with the invoice workflow status history.", "format": "uuid" }, - "workflowStatusId": { - "type": "string", - "description": "The workflow status ID associated with the invoice workflow status history.", - "format": "uuid" - }, - "workflowStatusName": { - "type": "string", - "description": "The workflow status name associated with the invoice workflow status history.", - "nullable": true - }, - "workflowTransitionId": { - "type": "string", - "description": "The workflow transition ID associated with the invoice workflow status history.", - "format": "uuid" - }, - "groupKey": { - "type": "string", - "description": "The GroupKey uniquely identifies a single Accounting Data Services 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).", - "format": "uuid", - "readOnly": true - }, - "workflowStatusNotes": { - "type": "string", - "description": "The notes for the invoice workflow status history.", - "nullable": true - }, - "workflowStatusReasonCode": { - "type": "string", - "description": "The reason code for the invoice workflow status history.\r\n \r\nSpecific reason codes are defined by the workflow status.", - "nullable": true - }, - "created": { - "type": "string", - "description": "The date that the invoice workflow status history was created.", - "format": "date-time", - "readOnly": true - }, - "createdUserId": { - "type": "string", - "description": "The ID of the user who created the invoice workflow status history.", - "format": "uuid", - "readOnly": true - } - }, - "additionalProperties": false, - "description": "A Invoice Workflow Status History represents prior workflow statuses of an E-Invoice." - }, - "InvoiceWorkflowStatusSyncModel": { - "required": [ - "created", - "invoiceErpKey" - ], - "type": "object", - "properties": { - "invoiceErpKey": { - "type": "string", - "description": "This is the primary key of the Invoice record. For this field, you should use whatever the invoice's unique\r\nidentifying number is in the originating system. Search for a unique, non-changing number within the\r\noriginating financial system for this record.\r\n \r\nExample: If you store your invoice records in a database, whatever the primary key for the invoice table is\r\nin the database should be the \"ErpKey\".\r\n \r\nFor more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns)." - }, - "workflowStatusId": { - "type": "string", - "description": "Workflow status of the invoice.", - "format": "uuid", - "nullable": true - }, - "notes": { - "type": "string", - "description": "Notes associated to workflow status", - "nullable": true - }, - "code": { - "type": "string", - "description": "Workflow status code dictated by government standards", - "nullable": true - }, - "created": { - "type": "string", - "description": "The date when the workflow status was updated for the e-invoice", - "format": "date-time" - } - }, - "additionalProperties": false, - "description": "The InvoiceWorkflowStatusSyncModel represents information coming into ADS 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 InvoiceWorkflowStatusSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the ADS Platform API as an [InvoiceWorkflowStatusHistoryModel](https://developer.lockstep.io/docs/invoiceworkflowstatushistorymodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." - }, - "JournalEntryLineModel": { - "required": [ - "accountName", - "accountNumber", - "baseCurrencyCode", - "currencyCode" - ], - "type": "object", - "properties": { - "journalEntryLineId": { - "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", - "format": "uuid", - "readOnly": true - }, - "journalEntryId": { - "type": "string", - "description": "The Journal Entry with which this line is associated.", - "format": "uuid" - }, - "groupKey": { - "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid", - "readOnly": true - }, - "appEnrollmentId": { - "type": "string", - "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.", - "format": "uuid", - "nullable": true, - "readOnly": true - }, - "erpKey": { - "maxLength": 100, - "type": "string", - "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).", - "nullable": true - }, - "financialAccountId": { - "type": "string", - "description": "The Financial Account with which this line is associated.", - "format": "uuid", - "nullable": true - }, - "accountNumber": { - "maxLength": 100, - "minLength": 1, - "type": "string", - "description": "The unique code/identifier assigned to each account in the chart of accounts." - }, - "accountName": { - "maxLength": 100, - "minLength": 1, - "type": "string", - "description": "The name of the account." - }, - "debit": { - "type": "number", - "description": "Debit to account.", - "format": "double" - }, - "credit": { - "type": "number", - "description": "Credit to account.", - "format": "double" - }, - "currencyCode": { - "maxLength": 3, - "minLength": 1, - "type": "string", - "description": "The transaction currency in which the entry is recorded, especially useful for multi-currency environments." - }, - "baseDebit": { - "type": "number", - "description": "The base currency debit amount for the account.", - "format": "double" - }, - "baseCredit": { - "type": "number", - "description": "The base currency credit amount for the account.", - "format": "double" - }, - "baseCurrencyCode": { - "maxLength": 3, - "minLength": 1, + "workflowStatusId": { "type": "string", - "description": "The base currency in which the entry is recorded, especially useful for multi-currency environments." + "description": "The workflow status ID associated with the invoice workflow status history.", + "format": "uuid" }, - "sourceCreatedUser": { - "maxLength": 100, + "workflowStatusName": { "type": "string", - "description": "The ERP’s identifier for the user who recorded the journal entry line.", + "description": "The workflow status name associated with the invoice workflow status history.", "nullable": true }, - "memo": { - "maxLength": 100, + "workflowTransitionId": { "type": "string", - "description": "A memo related to this line.", - "nullable": true + "description": "The workflow transition ID associated with the invoice workflow status history.", + "format": "uuid" }, - "dimensions": { - "type": "object", - "additionalProperties": { - "nullable": true - }, - "description": "Dimensions for this journal entry line.", - "nullable": true + "groupKey": { + "type": "string", + "description": "The GroupKey uniquely identifies a single Accounting Data Services Network 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).", + "format": "uuid", + "readOnly": true }, - "sourceObjectErpKey": { - "maxLength": 100, - "minLength": 0, + "workflowStatusNotes": { "type": "string", - "description": "The source object ERP key for this journal entry line.", + "description": "The notes for the invoice workflow status history.", "nullable": true }, - "sourceObjectType": { - "allOf": [ - { - "$ref": "#/components/schemas/SourceObjectType" - } - ], - "description": "The ID of the SourceObjectType for this journal entry line.", + "workflowStatusReasonCode": { + "type": "string", + "description": "The reason code for the invoice workflow status history.\r\n \r\nSpecific reason codes are defined by the workflow status.", "nullable": true }, "created": { "type": "string", - "description": "The date that the journal entry line was created.", + "description": "The date that the invoice workflow status history was created.", "format": "date-time", "readOnly": true }, "createdUserId": { "type": "string", - "description": "The ID of the user who created the journal entry line.", - "format": "uuid", - "readOnly": true - }, - "modified": { - "type": "string", - "description": "The date that the journal entry line was last modified.", - "format": "date-time", - "readOnly": true - }, - "modifiedUserId": { - "type": "string", - "description": "The ID of the user who last modified the journal entry line.", + "description": "The ID of the user who created the invoice workflow status history.", "format": "uuid", "readOnly": true }, - "sourceModifiedDate": { + "traceId": { "type": "string", - "description": "The date on which this record was last modified in source ERP.", - "format": "date-time", + "description": "The TraceId of the call made to create the invoice workflow status history.", "nullable": true, "readOnly": true }, - "journalEntry": { - "allOf": [ - { - "$ref": "#/components/schemas/JournalEntryModel" - } - ], - "description": "The journal entry for this journal entry line.\r\nTo retrieve this item, specify `JournalEntry` in the \"Include\" parameter for your query.", + "traceParent": { + "type": "string", + "description": "The span id of the parent call to create the invoice workflow status history.", "nullable": true, "readOnly": true } }, "additionalProperties": false, - "description": "Contains information about a journal entry line" + "description": "A Invoice Workflow Status History represents prior workflow statuses of an E-Invoice." }, - "JournalEntryLineModelFetchResult": { + "InvoiceWorkflowStatusSyncModel": { + "required": [ + "created", + "invoiceErpKey" + ], "type": "object", "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "nullable": true + "invoiceErpKey": { + "type": "string", + "description": "This is the primary key of the Invoice record. For this field, you should use whatever the invoice's unique\r\nidentifying number is in the originating system. Search for a unique, non-changing number within the\r\noriginating financial system for this record.\r\n \r\nExample: If you store your invoice records in a database, whatever the primary key for the invoice table is\r\nin the database should be the \"ErpKey\".\r\n \r\nFor more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns)." }, - "pageSize": { - "type": "integer", - "format": "int32", + "workflowStatusId": { + "type": "string", + "description": "Workflow status of the invoice.", + "format": "uuid", "nullable": true }, - "pageNumber": { - "type": "integer", - "format": "int32", + "notes": { + "type": "string", + "description": "Notes associated to workflow status", "nullable": true }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JournalEntryLineModel" - }, + "code": { + "type": "string", + "description": "Workflow status code dictated by government standards", "nullable": true + }, + "created": { + "type": "string", + "description": "The date when the workflow status was updated for the e-invoice", + "format": "date-time" } }, - "additionalProperties": false + "additionalProperties": false, + "description": "The InvoiceWorkflowStatusSyncModel represents information coming into ADS 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 InvoiceWorkflowStatusSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the Accounting Data Service API as an [InvoiceWorkflowStatusHistoryModel](https://developer.lockstep.io/docs/invoiceworkflowstatushistorymodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." }, "JournalEntryLineSyncModel": { "required": [ @@ -29138,7 +24045,7 @@ }, "dimensions": { "type": "object", - "additionalProperties": {}, + "additionalProperties": { }, "description": "A JSON string representing the dimensions for this journal entry line.", "nullable": true }, @@ -29148,194 +24055,29 @@ "nullable": true }, "sourceObjectType": { - "allOf": [ - { - "$ref": "#/components/schemas/SourceObjectType" - } - ], - "description": "The ID of the SourceObjectType for this journal entry line.", - "nullable": true - }, - "created": { - "type": "string", - "description": "If known, the date when this record was created according to the originating financial system\r\nin which this record is maintained. If the originating financial system does not maintain a\r\ncreated-date, leave this field null.", - "format": "date-time", - "nullable": true - }, - "modified": { - "type": "string", - "description": "If known, the date when this record was most recently modified according to the originating\r\nfinancial system in which this record is maintained. If the originating financial system does\r\nnot maintain a most-recently-modified-date, leave this field null.", - "format": "date-time", - "nullable": true - } - }, - "additionalProperties": {}, - "description": "The JournalEntryLineSyncModel represents information coming into ADS 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 JournalEntryLineSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the ADS Platform API as a JournalEntryLineModel\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." - }, - "JournalEntryModel": { - "required": [ - "lines" - ], - "type": "object", - "properties": { - "journalEntryId": { - "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", - "format": "uuid", - "readOnly": true - }, - "groupKey": { - "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", - "format": "uuid", - "readOnly": true - }, - "appEnrollmentId": { - "type": "string", - "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.", - "format": "uuid", - "nullable": true, - "readOnly": true - }, - "erpKey": { - "maxLength": 100, - "type": "string", - "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).", - "nullable": true - }, - "journalId": { - "maxLength": 100, - "type": "string", - "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.", - "nullable": true - }, - "source": { - "allOf": [ - { - "$ref": "#/components/schemas/JournalEntrySource" - } - ], - "description": "Possible sources for a Journal Entry.", - "readOnly": true - }, - "postingDate": { - "type": "string", - "description": "The UTC date and time when this journal entry was posted.", - "format": "date-time", - "readOnly": true - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/JournalEntryStatus" - } - ], - "description": "Possible statuses for a Journal Entry.", - "readOnly": true - }, - "description": { - "maxLength": 500, - "type": "string", - "description": "A brief description explaining the purpose of the journal entry.", - "nullable": true - }, - "comment": { - "maxLength": 250, - "type": "string", - "description": "An additional comment related to the entry.", - "nullable": true - }, - "referenceNumber": { - "maxLength": 100, - "type": "string", - "description": "Any reference number or identifier associated with the entry, such as an invoice number or purchase order.", - "nullable": true - }, - "sourcePostingDate": { - "type": "string", - "description": "The raw posting date from the source.", - "format": "date-time", - "readOnly": true - }, - "created": { - "type": "string", - "description": "The date that the journal entry was created.", - "format": "date-time", - "readOnly": true - }, - "createdUserId": { - "type": "string", - "description": "The ID of the user who created the journal entry.", - "format": "uuid", - "readOnly": true - }, - "modified": { - "type": "string", - "description": "The date that the journal entry was last modified.", - "format": "date-time", - "readOnly": true - }, - "modifiedUserId": { - "type": "string", - "description": "The ID of the user who last modified the journal entry.", - "format": "uuid", - "readOnly": true - }, - "sourceModifiedDate": { - "type": "string", - "description": "The date on which this record was last modified in source ERP.", - "format": "date-time", - "nullable": true, - "readOnly": true - }, - "lines": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/JournalEntryLineModel" - }, - "description": "All lines attached to this journal entry.\r\nTo retrieve this collection, specify `Lines` in the \"Include\" parameter for your query." - }, - "attachments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachmentModel" - }, - "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).", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Contains information about a journal entry" - }, - "JournalEntryModelFetchResult": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageSize": { - "type": "integer", - "format": "int32", + "allOf": [ + { + "$ref": "#/components/schemas/SourceObjectType" + } + ], + "description": "The ID of the SourceObjectType for this journal entry line.", "nullable": true }, - "pageNumber": { - "type": "integer", - "format": "int32", + "created": { + "type": "string", + "description": "If known, the date when this record was created according to the originating financial system\r\nin which this record is maintained. If the originating financial system does not maintain a\r\ncreated-date, leave this field null.", + "format": "date-time", "nullable": true }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JournalEntryModel" - }, + "modified": { + "type": "string", + "description": "If known, the date when this record was most recently modified according to the originating\r\nfinancial system in which this record is maintained. If the originating financial system does\r\nnot maintain a most-recently-modified-date, leave this field null.", + "format": "date-time", "nullable": true } }, - "additionalProperties": false + "additionalProperties": { }, + "description": "The JournalEntryLineSyncModel represents information coming into ADS 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 JournalEntryLineSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the Accounting Data Service API as a JournalEntryLineModel\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." }, "JournalEntrySource": { "enum": [ @@ -29475,38 +24217,21 @@ "nullable": true } }, - "additionalProperties": {}, - "description": "The JournalEntrySyncModel represents information coming into ADS 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 JournalEntrySyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the ADS Platform API as a JournalEntryModel\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." - }, - "JsonApiResourceHead": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique Id of this resource in system.", - "nullable": true - }, - "type": { - "type": "string", - "description": "A known resource type.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "A Json API resource head." + "additionalProperties": { }, + "description": "The JournalEntrySyncModel represents information coming into ADS 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 JournalEntrySyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the Accounting Data Service API as a JournalEntryModel\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." }, "MagicLinkModel": { "type": "object", "properties": { "magicLinkId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.", + "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.", "format": "uuid", "readOnly": true }, "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS Platform account. All records for this\r\naccount will share the same GroupKey value. GroupKey values cannot be changed once created.", + "description": "The GroupKey uniquely identifies a single Accounting Data Service account. All records for this\r\naccount will share the same GroupKey value. GroupKey values cannot be changed once created.", "format": "uuid", "readOnly": true }, @@ -29568,7 +24293,6 @@ "type": "string", "description": "The ID of the company associated to this magic link", "format": "uuid", - "nullable": true, "readOnly": true }, "accountingProfileId": { @@ -29576,7 +24300,8 @@ "description": "The ID of the accounting profile associated to this magic link", "format": "uuid", "nullable": true, - "readOnly": true + "readOnly": true, + "deprecated": true }, "magicLinkUrl": { "type": "string", @@ -29629,7 +24354,7 @@ } }, "additionalProperties": false, - "description": "Represents a magic link that can be used to log in to a ADS Platform application." + "description": "Represents a magic link that can be used to log in to a Accounting Data Service application." }, "MagicLinkModelFetchResult": { "type": "object", @@ -29693,7 +24418,8 @@ "type": "string", "description": "The id of the accounting profile for the Magic Link", "format": "uuid", - "nullable": true + "nullable": true, + "deprecated": true }, "expires": { "type": "string", @@ -29731,23 +24457,6 @@ "additionalProperties": false, "description": "A historic summary of all magic links sent in a given group" }, - "ManifestResponseModel": { - "type": "object", - "properties": { - "status": { - "type": "integer", - "description": "The status shows the response of return from requested data", - "format": "int32" - }, - "message": { - "type": "string", - "description": "Message containing information about the sync request results.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "The General Response model return the response of coming request after processing the requested data to the external financial system or other enterprise resource planning system." - }, "MatchAction": { "enum": [ 0, @@ -29758,23 +24467,6 @@ "description": "Enum defining which action to take for a model during the sync process.", "format": "int32" }, - "Meta": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type of entity", - "nullable": true - }, - "id": { - "type": "string", - "description": "UniqueID for entity", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Contains meta about entity" - }, "Metadata": { "type": "object", "properties": { @@ -29796,13 +24488,13 @@ "properties": { "noteId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the ADS Platform.", + "description": "The unique ID of this record, automatically assigned by ADS when this record is\r\nadded to the Accounting Data Service.", "format": "uuid", "readOnly": true }, "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "readOnly": true }, @@ -29810,13 +24502,13 @@ "maxLength": 40, "minLength": 1, "type": "string", - "description": "A Note is connected to an existing item within the ADS 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 ADS 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).", + "description": "A Note is connected to an existing item within the Accounting Data Service 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 Accounting Data Service 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).", "readOnly": true }, "objectKey": { "minLength": 1, "type": "string", - "description": "A Note is connected to an existing item within the ADS 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 ADS 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).", + "description": "A Note is connected to an existing item within the Accounting Data Service 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 Accounting Data Service 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).", "format": "uuid", "readOnly": true }, @@ -29882,7 +24574,7 @@ } }, "additionalProperties": false, - "description": "A note is a customizable text string that can be attached to various account attributes\r\nwithin ADS Platform. You can use notes for internal communication, correspondence with\r\nclients, or personal reminders. The Note Model represents a note and a number of\r\ndifferent 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." + "description": "A note is a customizable text string that can be attached to various account attributes\r\nwithin Accounting Data Service. You can use notes for internal communication, correspondence with\r\nclients, or personal reminders. The Note Model represents a note and a number of\r\ndifferent 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." }, "NoteModelFetchResult": { "type": "object", @@ -29942,13 +24634,90 @@ }, "serviceAttributes": { "type": "object", - "additionalProperties": {}, + "additionalProperties": { }, "description": "Specific info about this event" } }, "additionalProperties": false, "description": "Notification details" }, + "ObjectEventModel": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Identifier for event", + "nullable": true + }, + "source": { + "type": "string", + "description": "Identifies the context in which this event happened", + "nullable": true + }, + "specVersion": { + "type": "string", + "description": "Version of the CloudEvents specification which the event uses", + "nullable": true + }, + "type": { + "type": "string", + "description": "Value describing the type of even relating to the originating occurrence\r\nNOTE: Type format should be {entity type}.{event action}", + "nullable": true + }, + "traceParent": { + "type": "string", + "description": "Contains trace information such as version, trace ID, span ID and trace options", + "nullable": true + }, + "traceState": { + "type": "string", + "description": "Comma-delimited list of trace key value pairs", + "nullable": true + }, + "dataContentType": { + "type": "string", + "description": "Content type of data value", + "nullable": true + }, + "dataSchema": { + "type": "string", + "description": "Identifies the schema the data value adheres to", + "nullable": true + }, + "subject": { + "type": "string", + "description": "Identifies the subject of the event in the context of the even producer (identified by source)", + "nullable": true + }, + "time": { + "type": "string", + "description": "Timestamp of when the occurrence happened", + "format": "date-time", + "nullable": true + }, + "subscriptionId": { + "type": "string", + "description": "Subscription id related to the notification", + "nullable": true + }, + "accountId": { + "type": "string", + "description": "Account id related to the notification", + "nullable": true + }, + "datasetId": { + "type": "string", + "description": "Dataset related to the notification", + "format": "uuid" + }, + "data": { + "description": "Source domain-specific information about the occurrence to be deserialized based on the information in DataContentType\r\nor DataSchema or by default content type - application/json", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Data record expressing an occurrence and its context" + }, "PaymentAppliedModel": { "required": [ "paymentId" @@ -29957,13 +24726,13 @@ "properties": { "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "readOnly": true }, "paymentAppliedId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS Platform when this record is\r\nadded to the ADS Platform.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", + "description": "The unique ID of this record, automatically assigned by Accounting Data Service when this record is\r\nadded to the Accounting Data Service.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", "format": "uuid", "readOnly": true }, @@ -30098,7 +24867,9 @@ "nullable": true }, "description": "Additional attributes that may be required by the source system.", - "nullable": true + "nullable": true, + "readOnly": true, + "deprecated": true } }, "additionalProperties": false, @@ -30152,7 +24923,7 @@ }, "networkId": { "type": "string", - "description": "The unique identifier of this object in the Sage Network platform.", + "description": "The unique identifier of this object in the Accounting Data Service.", "format": "uuid", "nullable": true }, @@ -30220,15 +24991,15 @@ "nullable": true } }, - "additionalProperties": {}, - "description": "The PaymentAppliedSyncModel represents information coming into ADS from an external financial system or\r\nother enterprise resource planning system. To import data from an external system, convert your original data\r\ninto the PaymentAppliedSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the ADS Platform API as a [PaymentAppliedModel](https://developer.lockstep.io/docs/paymentappliedmodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." + "additionalProperties": { }, + "description": "The PaymentAppliedSyncModel represents information coming into ADS from an external financial system or\r\nother enterprise resource planning system. To import data from an external system, convert your original data\r\ninto the PaymentAppliedSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the Accounting Data Service API as a [PaymentAppliedModel](https://developer.lockstep.io/docs/paymentappliedmodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." }, "PaymentDetailModel": { "type": "object", "properties": { "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid" }, "paymentId": { @@ -30270,10 +25041,10 @@ "erpWriteStatus": { "allOf": [ { - "$ref": "#/components/schemas/ErpWriteStatuses" + "$ref": "#/components/schemas/ErpUpdateStatus" } ], - "description": "Possible statuses for a record that supports ERP write.", + "description": "Possible statuses for a record that supports ERP Update.", "readOnly": true }, "erpWriteStatusName": { @@ -30472,7 +25243,6 @@ }, "PaymentModel": { "required": [ - "companyId", "paymentDate", "paymentType", "postDate", @@ -30482,21 +25252,21 @@ "properties": { "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "readOnly": true }, "paymentId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS Platform when this record is\r\nadded to the ADS Platform.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", + "description": "The unique ID of this record, automatically assigned by Accounting Data Service when this record is\r\nadded to the Accounting Data Service.\r\n \r\nFor the ID of this record in its originating financial system, see `ErpKey`.", "format": "uuid", "readOnly": true }, "companyId": { - "minLength": 1, "type": "string", "description": "The ID of the company to which this payment belongs.", - "format": "uuid" + "format": "uuid", + "nullable": true }, "companyName": { "maxLength": 100, @@ -30508,6 +25278,7 @@ }, "erpKey": { "maxLength": 255, + "minLength": 0, "type": "string", "description": "The unique ID of this record as it was known in its originating financial system.\r\n \r\nIf this company 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).", "nullable": true @@ -30576,17 +25347,21 @@ }, "currencyCode": { "maxLength": 3, + "minLength": 0, "type": "string", "description": "The ISO 4217 currency code for this payment.\r\n \r\nFor a list of ISO 4217 currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies).", "nullable": true }, "bankAccountId": { + "maxLength": 50, + "minLength": 0, "type": "string", "description": "The Bank account id for the company to which this payment belongs.", "nullable": true }, "referenceCode": { "maxLength": 100, + "minLength": 0, "type": "string", "description": "Reference code for the payment for the given Erp system.", "nullable": true @@ -30648,6 +25423,8 @@ "format": "double" }, "serviceFabricStatus": { + "maxLength": 20, + "minLength": 0, "type": "string", "description": "The status of this payment within Service Fabric.\r\n\"UNAUTHORISED\" \"PENDING\" \"PAID\" \"PAID_OFFLINE\" \"FAILED\" \"CANCELLED\" \"REJECTED\" \"REFUNDED\" \"PARTIALLY\" \"PARTIALLY_REFUNDED\"", "nullable": true, @@ -30660,6 +25437,26 @@ "nullable": true, "readOnly": true }, + "taxCode": { + "maxLength": 15, + "minLength": 0, + "type": "string", + "description": "The tax code of this payment.", + "nullable": true + }, + "financialAccountCode": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "description": "The financial account code of this payment.", + "nullable": true + }, + "hasPdf": { + "type": "boolean", + "description": "Optional field to indicate if the payment has a PDF attached to it.", + "nullable": true, + "readOnly": true + }, "erpSystemAttributes": { "type": "object", "additionalProperties": { @@ -30667,7 +25464,9 @@ "nullable": true }, "description": "Additional attributes that may be required by the source system.", - "nullable": true + "nullable": true, + "readOnly": true, + "deprecated": true }, "applications": { "type": "array", @@ -30715,7 +25514,7 @@ } }, "additionalProperties": false, - "description": "A Payment represents money sent from one company to another. A single payment may contain payments for\r\none or more invoices; it is also possible for payments to be made in advance of an invoice, for example,\r\nas a deposit. The creator of the Payment is identified by the `CustomerId` field, and the recipient of\r\nthe Payment is identified by the `CompanyId` field. Most Payments are uniquely identified both by a\r\nADS Platform ID number and a customer ERP \"key\" that was generated by the system that originated\r\nthe Payment. Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which\r\nrepresents a deposit that has been paid and not yet applied to an Invoice." + "description": "A Payment represents money sent from one company to another. A single payment may contain payments for\r\none or more invoices; it is also possible for payments to be made in advance of an invoice, for example,\r\nas a deposit. The creator of the Payment is identified by the `CustomerId` field, and the recipient of\r\nthe Payment is identified by the `CompanyId` field. Most Payments are uniquely identified both by a\r\nAccounting Data Service ID number and a customer ERP \"key\" that was generated by the system that originated\r\nthe Payment. Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which\r\nrepresents a deposit that has been paid and not yet applied to an Invoice." }, "PaymentModelFetchResult": { "type": "object", @@ -30914,7 +25713,7 @@ "properties": { "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid" }, "paymentId": { @@ -31172,7 +25971,7 @@ }, "networkId": { "type": "string", - "description": "The unique identifier of this object in the Sage Network platform.", + "description": "The unique identifier of this object in the Accounting Data Service.", "format": "uuid", "nullable": true }, @@ -31279,161 +26078,47 @@ "type": "string", "description": "Bank account id for the payment.", "nullable": true - } - }, - "additionalProperties": {}, - "description": "The PaymentSyncModel represents information coming into ADS 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 PaymentSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the ADS Platform API as a [PaymentModel](https://developer.lockstep.io/docs/paymentmodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." - }, - "ProblemDetails": { - "type": "object", - "properties": { - "type": { - "type": "string", - "nullable": true - }, - "title": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer", - "format": "int32", - "nullable": true }, - "detail": { + "taxCode": { "type": "string", + "description": "The tax code of this payment.", "nullable": true }, - "instance": { + "financialAccountCode": { "type": "string", + "description": "The financial account code of this payment.", "nullable": true } }, - "additionalProperties": {} + "additionalProperties": { }, + "description": "The PaymentSyncModel represents information coming into ADS 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 PaymentSyncModel 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 ADS\r\nPlatform.\r\n \r\nOnce imported, this record will be available in the Accounting Data Service API as a [PaymentModel](https://developer.lockstep.io/docs/paymentmodel).\r\n \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)." }, - "PublicCompanyProfileModel": { + "ProblemDetails": { "type": "object", "properties": { - "companyId": { - "type": "string", - "description": "The unique ID of the company associated with this profile.", - "format": "uuid" - }, - "companyName": { - "maxLength": 100, - "minLength": 0, - "type": "string", - "description": "The short name of the company associated with this profile.", - "nullable": true - }, - "companyLogoUrl": { - "maxLength": 512, - "minLength": 0, - "type": "string", - "description": "The URL of this company's logo, if known.", - "nullable": true - }, - "website": { - "maxLength": 512, - "minLength": 0, - "type": "string", - "description": "Website URL for the company associated with this profile.", - "nullable": true - }, - "description": { - "maxLength": 254, - "minLength": 0, + "type": { "type": "string", - "description": "Description of the company associated with this profile.", "nullable": true }, - "publicUrlSlug": { - "maxLength": 100, - "minLength": 0, + "title": { "type": "string", - "description": "The public url slug for this Public Company Profile.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Contains Public Company Profile data." - }, - "PublicCompanyProfileModelFetchResult": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", "nullable": true }, - "pageSize": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageNumber": { + "status": { "type": "integer", - "format": "int32", - "nullable": true - }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PublicCompanyProfileModel" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "Relationship": { - "type": "object", - "properties": { - "created": { - "allOf": [ - { - "$ref": "#/components/schemas/RelationshipDetail" - } - ], - "description": "All created entities", - "nullable": true - }, - "updated": { - "allOf": [ - { - "$ref": "#/components/schemas/RelationshipDetail" - } - ], - "description": "All updated entities", + "format": "int32", "nullable": true }, - "deleted": { - "allOf": [ - { - "$ref": "#/components/schemas/RelationshipDetail" - } - ], - "description": "All deleted entities", + "detail": { + "type": "string", "nullable": true - } - }, - "additionalProperties": false, - "description": "Contains entities updated,delete,create" - }, - "RelationshipDetail": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiResourceHead" - }, - "description": "Array of relationship data", + }, + "instance": { + "type": "string", "nullable": true } }, - "additionalProperties": false, - "description": "Contains entities Relationship Detail" + "additionalProperties": { } }, "RemittanceInformation": { "type": "object", @@ -31451,17 +26136,6 @@ "additionalProperties": false, "description": "Information supplied to enable the matching of an entry with the\r\nitems that the transfer is intended to settle, such as a commercial invoice." }, - "ReportDepth": { - "enum": [ - 0, - 1, - 2, - 3 - ], - "type": "integer", - "description": "The different depths of describing an account. See the Financial Account Model for possible values for each depth\r\nEnum values are:\r\n \r\n0 - the classification of the account\r\n1 - the category of the account\r\n2 - the subcategory of the account\r\n3 - the account", - "format": "int32" - }, "ReportingAmount": { "type": "object", "properties": { @@ -31529,7 +26203,8 @@ "enum": [ "Upload Pending", "Uploaded", - "Upload Failed" + "Upload Failed", + "Upload Error" ], "type": "string", "description": "The different statuses of an attachment being scanned for viruses.", @@ -32653,18 +27328,6 @@ "additionalProperties": false, "description": "API version of SubmitPaymentInfo" }, - "Source": { - "type": "object", - "properties": { - "pointer": { - "type": "string", - "description": "Source of error's Pointer", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Source of Error" - }, "SourceObjectType": { "enum": [ 0, @@ -32865,12 +27528,12 @@ "$ref": "#/components/schemas/SupportAccessModel" } ], - "description": "Information allowing ADS Platform to offer direct support to the user", + "description": "Information allowing Accounting Data Service to offer direct support to the user", "nullable": true }, "isImpersonated": { "type": "boolean", - "description": "True if the user is being impersonated by the ADS Platform support team." + "description": "True if the user is being impersonated by the Accounting Data Service support team." }, "userGroups": { "type": "array", @@ -32926,7 +27589,7 @@ } }, "additionalProperties": false, - "description": "Contains information for ADS Platform to support/assist a user." + "description": "Contains information for Accounting Data Service to support/assist a user." }, "SupportAccessRequest": { "type": "object", @@ -33012,13 +27675,13 @@ "properties": { "syncRequestId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS Platform when this record is\r\nadded to the ADS Platform.", + "description": "The unique ID of this record, automatically assigned by Accounting Data Service when this record is\r\nadded to the Accounting Data Service.", "format": "uuid", "readOnly": true }, "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "readOnly": true }, @@ -33118,10 +27781,16 @@ "format": "int32", "nullable": true, "readOnly": true + }, + "traceParent": { + "type": "string", + "description": "An optional trace parent for the sync request", + "nullable": true, + "readOnly": true } }, "additionalProperties": false, - "description": "Represents a Sync action that loads data from a connector into the ADS Platform. Users can\r\nrequest Sync actions manually using ADS Inbox, or via the [Create Sync API](https://developer.lockstep.io/reference/post_api-v1-sync).\r\nEach Sync action is tied to an [AppEnrollment](https://developer.lockstep.io/docs/applications-and-enrollments).\r\nWhen the Sync action is complete, the field `StatusCode` will be set to either `Success` or `Failed`.\r\n \r\nYou can fetch a list of detailed results for the Sync API by calling Retrieve or Query with an `include`\r\nparameter of `details`. These detailed results contain line-by-line errors that were detected during\r\nprocessing of this sync." + "description": "Represents a Sync action that loads data from a connector into the Accounting Data Service. Users can\r\nrequest Sync actions manually using ADS Inbox, or via the [Create Sync API](https://developer.lockstep.io/reference/post_api-v1-sync).\r\nEach Sync action is tied to an [AppEnrollment](https://developer.lockstep.io/docs/applications-and-enrollments).\r\nWhen the Sync action is complete, the field `StatusCode` will be set to either `Success` or `Failed`.\r\n \r\nYou can fetch a list of detailed results for the Sync API by calling Retrieve or Query with an `include`\r\nparameter of `details`. These detailed results contain line-by-line errors that were detected during\r\nprocessing of this sync." }, "SyncRequestModelFetchResult": { "type": "object", @@ -33166,7 +27835,7 @@ } }, "additionalProperties": false, - "description": "A SyncSubmitModel represents a task that loads data from a connector to load into the ADS 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 ADS 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. ADS Platform 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." + "description": "A SyncSubmitModel represents a task that loads data from a connector to load into the Accounting Data Service. Data\r\ncontained in a sync will be merged with your existing data. Each record will be matched with existing data\r\ninside the Accounting Data Service 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. Accounting Data Service 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." }, "TaxSummaryModel": { "type": "object", @@ -33518,278 +28187,6 @@ "additionalProperties": false, "description": "Represents transaction summary information based on the query request within the group account." }, - "TranscriptionRequestSubmit": { - "type": "object", - "properties": { - "fileContent": { - "type": "string", - "description": "The base64 string of document content", - "nullable": true - }, - "fileUrl": { - "type": "string", - "description": "The location of the file provided", - "nullable": true, - "deprecated": true - }, - "fileContentUrl": { - "type": "string", - "description": "The location of the file provided", - "nullable": true - }, - "fileName": { - "maxLength": 200, - "type": "string", - "description": "The name of the file provided", - "nullable": true - }, - "invoiceTypeCode": { - "type": "string", - "description": "The type of TranscriptionRequestSubmit.InvoiceTypeCode requested to transcribe content to.", - "nullable": true - }, - "transcriptionValidationRequestId": { - "type": "string", - "description": "Group account transcription validation request item is associated with.", - "format": "uuid", - "nullable": true - } - }, - "additionalProperties": false, - "description": "A request to transcribe the provided file content to a ADS Platform object." - }, - "TranscriptionValidationRequestItemModel": { - "type": "object", - "properties": { - "transcriptionValidationRequestItemId": { - "type": "string", - "description": "The unique identifier of the transcription validation request item.", - "format": "uuid", - "readOnly": true - }, - "transcriptionValidationRequestId": { - "type": "string", - "description": "The ID number of the transcription validation request this item belongs to.", - "format": "uuid", - "readOnly": true - }, - "groupKey": { - "type": "string", - "description": "Group account transcription validation request item is associated with.", - "format": "uuid", - "readOnly": true - }, - "fileHash": { - "type": "string", - "description": "Generated hash of the file being validated.", - "nullable": true, - "readOnly": true - }, - "fileName": { - "type": "string", - "description": "Original name of the file on disk, without its extension.", - "nullable": true, - "readOnly": true - }, - "fileExt": { - "type": "string", - "description": "Original extension name of the file on disk.", - "nullable": true, - "readOnly": true - }, - "fileLocation": { - "type": "string", - "description": "Location of file in blob storage to be validated.", - "nullable": true, - "readOnly": true - }, - "transcriptionResult": { - "type": "string", - "description": "Transcription result", - "nullable": true, - "readOnly": true - }, - "processStart": { - "type": "string", - "description": "Transcription process start date", - "format": "date-time", - "nullable": true, - "readOnly": true - }, - "processEnd": { - "type": "string", - "description": "Transcription process end date", - "format": "date-time", - "nullable": true, - "readOnly": true - }, - "retryCount": { - "type": "integer", - "description": "Amount of times item was processed to retrieve the transcription data", - "format": "int32", - "readOnly": true - }, - "feedbackResult": { - "maxLength": 20, - "minLength": 0, - "type": "string", - "description": "Feedback result specified by the client when the transcription result is not correct. This feedback result will be sent back to the transcription services to retrain and improve models over time.", - "nullable": true - }, - "feedbackSent": { - "type": "string", - "description": "Date when feedback result was sent back to transcription service.", - "format": "date-time", - "nullable": true, - "readOnly": true - }, - "statusCode": { - "type": "string", - "description": "A code identifying the status of this transcription validation request item.\r\n \r\nRecognized Transcription Validation Request status codes are:\r\n* `New` - Represents a transcription validation request item that is considered new and needs work to complete\r\n* `In Progress` - Represents a transcription validation request item that is currently being worked on\r\n* `Failed` - Represents a transcription validation request item that could not complete the validation process\r\n* `Complete` - Represents a transcription validation request item that is considered complete and does not need any further work", - "nullable": true, - "readOnly": true - }, - "created": { - "type": "string", - "description": "The date on which this transcription validation request item was created.", - "format": "date-time", - "readOnly": true - }, - "createdUserId": { - "type": "string", - "description": "The ID number of the user who created this transcription validation request item.", - "format": "uuid", - "readOnly": true - }, - "modified": { - "type": "string", - "description": "The date on which this transcription validation request item was last modified.", - "format": "date-time", - "readOnly": true - }, - "modifiedUserId": { - "type": "string", - "description": "The ID number of the user who most recently modified this transcription validation request item.", - "format": "uuid", - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Represents a transcription validation request item to be validated." - }, - "TranscriptionValidationRequestItemModelFetchResult": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageSize": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageNumber": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranscriptionValidationRequestItemModel" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "TranscriptionValidationRequestModel": { - "type": "object", - "properties": { - "transcriptionValidationRequestId": { - "type": "string", - "description": "The unique identifier of the transcription validation request.", - "format": "uuid", - "readOnly": true - }, - "groupKey": { - "type": "string", - "description": "Group account transcription validation request is associated with.", - "format": "uuid", - "readOnly": true - }, - "statusCode": { - "type": "string", - "description": "A code identifying the status of this transcription validation request.\r\n \r\nRecognized Transcription Validation Request status codes are:\r\n* `New` - Represents a transcription validation request that is considered new and needs work to complete\r\n* `In Progress` - Represents a transcription validation request that is currently being worked on\r\n* `Failed` - Represents a transcription validation request that could not complete the validation process\r\n* `Complete` - Represents a transcription validation request that is considered complete and does not need any further work", - "nullable": true - }, - "created": { - "type": "string", - "description": "The date on which this transcription validation request was created.", - "format": "date-time", - "readOnly": true - }, - "createdUserId": { - "type": "string", - "description": "The ID number of the user who created this transcription validation request.", - "format": "uuid", - "readOnly": true - }, - "modified": { - "type": "string", - "description": "The date on which this transcription validation request was last modified.", - "format": "date-time", - "readOnly": true - }, - "modifiedUserId": { - "type": "string", - "description": "The ID number of the user who most recently modified this transcription validation request.", - "format": "uuid", - "readOnly": true - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranscriptionValidationRequestItemModel" - }, - "description": "All items attached to this transcription validation request.\r\nTo retrieve this collection, specify `Items` in the \"Include\" parameter for your query.", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Represents a transcription validation request that is used to validate if file is of a specific type." - }, - "TranscriptionValidationRequestModelFetchResult": { - "type": "object", - "properties": { - "totalCount": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageSize": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "pageNumber": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranscriptionValidationRequestModel" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "TransferOwnerModel": { "type": "object", "properties": { @@ -33852,13 +28249,13 @@ "properties": { "userId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS Platform when this record is\r\nadded to the ADS Platform.\r\n \r\nThis record provides a link to the user's Azure AD B2C OID.", + "description": "The unique ID of this record, automatically assigned by Accounting Data Service when this record is\r\nadded to the Accounting Data Service.\r\n \r\nThis record provides a link to the user's Azure AD B2C OID.", "format": "uuid", "readOnly": true }, "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "nullable": true, "readOnly": true @@ -34082,7 +28479,7 @@ } }, "additionalProperties": false, - "description": "A User represents a person who has the ability to authenticate against the ADS Platform and use\r\nservices such as ADS Inbox. A User is uniquely identified by an Azure identity, and each user must\r\nhave an email address defined within their account. All Users must validate their email to make use of\r\nADS Platform services. Users may have different privileges and access control rights within the\r\nADS Platform." + "description": "A User represents a person who has the ability to authenticate against the Accounting Data Service and use\r\nservices such as ADS Inbox. A User is uniquely identified by an Azure identity, and each user must\r\nhave an email address defined within their account. All Users must validate their email to make use of\r\nAccounting Data Service services. Users may have different privileges and access control rights within the\r\nAccounting Data Service." }, "UserAccountModelFetchResult": { "type": "object", @@ -34119,7 +28516,7 @@ "type": "object", "additionalProperties": { "type": "object", - "additionalProperties": {}, + "additionalProperties": { }, "nullable": true }, "description": "Data about the user, the properties returned will depend on the requested information.", @@ -34127,7 +28524,7 @@ }, "userId": { "type": "string", - "description": "The ADS Platform ID of the user", + "description": "The Accounting Data Service ID of the user", "format": "uuid" } }, @@ -34139,7 +28536,7 @@ "properties": { "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid" }, "userRole": { @@ -34169,13 +28566,13 @@ "properties": { "userRoleId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS Platform when this record is\r\nadded to the ADS Platform.", + "description": "The unique ID of this record, automatically assigned by Accounting Data Service when this record is\r\nadded to the Accounting Data Service.", "format": "uuid", "readOnly": true }, "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "readOnly": true }, @@ -34246,7 +28643,7 @@ "properties": { "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid" }, "vendorId": { @@ -34472,7 +28869,7 @@ "properties": { "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid" }, "webhookId": { @@ -34482,7 +28879,7 @@ }, "webhookHistoryId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS Platform when this record is\r\nadded to the ADS Platform.", + "description": "The unique ID of this record, automatically assigned by Accounting Data Service when this record is\r\nadded to the Accounting Data Service.", "format": "uuid" }, "eventType": { @@ -34578,13 +28975,13 @@ "properties": { "webhookId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS Platform when this record is\r\nadded to the ADS Platform.", + "description": "The unique ID of this record, automatically assigned by Accounting Data Service when this record is\r\nadded to the Accounting Data Service.", "format": "uuid", "readOnly": true }, "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "nullable": true, "readOnly": true @@ -34613,7 +29010,7 @@ "maxLength": 100, "minLength": 0, "type": "string", - "description": "An secret set during webhook creation that can be used to verify that the notification\r\nis coming from the ADS Platform API.", + "description": "An secret set during webhook creation that can be used to verify that the notification\r\nis coming from the Accounting Data Service API.", "nullable": true, "readOnly": true }, @@ -34635,7 +29032,7 @@ "maxLength": 250, "minLength": 0, "type": "string", - "description": "The URL where the notification will be sent via the method set in CallbackHttpMethod.\r\n \r\nWhen creating a webhook, the ADS Platform API will make a call to this url via the method\r\nset in the CallbackHttpMethod property with a query parameter of \"code\" set to an encoded\r\nstring. To successfully create the webhook, the call must return a successful status code\r\nwith the query parameter's value as the plain text content.", + "description": "The URL where the notification will be sent via the method set in CallbackHttpMethod.\r\n \r\nWhen creating a webhook, the Accounting Data Service API will make a call to this url via the method\r\nset in the CallbackHttpMethod property with a query parameter of \"code\" set to an encoded\r\nstring. To successfully create the webhook, the call must return a successful status code\r\nwith the query parameter's value as the plain text content.", "format": "uri" }, "expirationDate": { @@ -34732,7 +29129,7 @@ "properties": { "webhookRuleId": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS Platform when this record is\r\nadded to the ADS Platform.", + "description": "The unique ID of this record, automatically assigned by Accounting Data Service when this record is\r\nadded to the Accounting Data Service.", "format": "uuid", "readOnly": true }, @@ -34743,7 +29140,7 @@ }, "groupKey": { "type": "string", - "description": "The GroupKey uniquely identifies a single ADS 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).", + "description": "The GroupKey uniquely identifies a single Accounting Data Service 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).", "format": "uuid", "nullable": true, "readOnly": true @@ -34752,7 +29149,7 @@ "maxLength": 40, "minLength": 0, "type": "string", - "description": "A Webhook rule is setup to be fired based on `TableKey` and `EventType`.\r\nFor example, a Webhook setup for when an Invoice is Created would have a `TableKey` value of\r\n`Invoice` and an `EventType` value of `I` (Insert).\r\n \r\nThe `TableKey` value contains the name of the table within the ADS 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)." + "description": "A Webhook rule is setup to be fired based on `TableKey` and `EventType`.\r\nFor example, a Webhook setup for when an Invoice is Created would have a `TableKey` value of\r\n`Invoice` and an `EventType` value of `I` (Insert).\r\n \r\nThe `TableKey` value contains the name of the table within the Accounting Data Service 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)." }, "eventType": { "maxLength": 1, @@ -34830,7 +29227,7 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of this record, automatically assigned by ADS Platform when this record is\r\nadded to the Accounting Data Services platform.", + "description": "The unique ID of this record, automatically assigned by Accounting Data Service when this record is\r\nadded to the Accounting Data Services network.", "format": "uuid", "readOnly": true }, @@ -34978,16 +29375,16 @@ "description": "Azure B2C OAuth Authentication", "flows": { "implicit": { - "authorizationUrl": "https://login.eu.int.lockstep.io/login.eu.int.lockstep.io/B2C_1A_PLATFORMSIGNUP_SIGNIN/oauth2/v2.0/authorize", + "authorizationUrl": "https://login.eu.qa.lockstep.io/login.eu.qa.lockstep.io/B2C_1A_PLATFORMSIGNUP_SIGNIN/oauth2/v2.0/authorize", "scopes": { - "https://login.eu.int.lockstep.io/platform-api/api.call": "Call the Platform API" + "https://login.eu.qa.lockstep.io/platform-api/api.call": "Call the Platform API" } } } }, "api_key": { "type": "apiKey", - "description": "API Key authentication issued by the ADS Platform", + "description": "API Key authentication issued by the Accounting Data Service", "name": "Api-Key", "in": "header" }, diff --git a/lib/lockstep_rails/version.rb b/lib/lockstep_rails/version.rb index 3b70a40..0854526 100644 --- a/lib/lockstep_rails/version.rb +++ b/lib/lockstep_rails/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module LockstepRails - VERSION = '0.3.89' + VERSION = '0.3.90' end