lockstep_rails 0.3.88 → 0.3.90

data/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
@@ -25,7 +25,12 @@ end
   # @type: string
   field :workflow_status_name
 
-  # The GroupKey uniquely identifies a single Accounting Data Services Platform account.  All records for this
+  # The workflow transition ID associated with the invoice workflow status history.
+  # @type: string
+  # @format: uuid
+  field :workflow_transition_id
+
+  # 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).
@@ -37,6 +42,12 @@ end
   # @type: string
   field :workflow_status_notes
 
+  # The reason code for the invoice workflow status history.
+  #             
+  # Specific reason codes are defined by the workflow status.
+  # @type: string
+  field :workflow_status_reason_code
+
   # The date that the invoice workflow status history was created.
   # @type: string
   # @format: date-time
@@ -47,6 +58,14 @@ end
   # @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"}
 
 

data/app/platform_api/schema/invoice_workflow_status_sync.rb

@@ -0,0 +1,39 @@
+class Schema::InvoiceWorkflowStatusSync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # This is the primary key of the Invoice record. For this field, you should use whatever the invoice's unique
+  # 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 invoice records in a database, whatever the primary key for the invoice table is
+  # in the database should be the "ErpKey".
+  #             
+  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+  # @type: string
+  field :invoice_erp_key
+
+  # Workflow status of the invoice.
+  # @type: string
+  # @format: uuid
+  field :workflow_status_id
+
+  # Notes associated to workflow status
+  # @type: string
+  field :notes
+
+  # Workflow status code dictated by government standards
+  # @type: string
+  field :code
+
+  # The date when the workflow status was updated for the e-invoice
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+
+
+end

data/app/platform_api/schema/journal_entry_line_sync.rb

@@ -51,6 +51,11 @@ end
   # @type: string
   field :currency_code
 
+  # The CurrencyRate of the connected Payment
+  # @type: number
+  # @format: double
+  field :currency_rate
+
   # The base currency debit amount for the account.
   # @type: number
   # @format: double

data/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

data/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 @@ end
   # @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).

data/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

data/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 @@ end
   # @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
@@ -26,6 +26,10 @@ end
   # @format: uuid
   field :company_id
 
+  # The name of the company associated with this payment.
+  # @type: string
+  field :company_name
+
   # The unique ID of this record as it was known in its originating financial system.
   #             
   # If this company record was imported from a financial system, it will have the value `ErpKey`
@@ -169,6 +173,18 @@ end
   # @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

data/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 @@ end
   # @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
@@ -26,7 +26,12 @@ end
   # @format: uuid
   field :invoice_id
 
-  # The Payment applied to the invoice.
+  # The refund Payment that funded the payment.
+  # @type: string
+  # @format: uuid
+  field :refund_id
+
+  # The Payment applied to the invoice or receiving funding from a refund.
   # @type: string
   # @format: uuid
   field :payment_id
@@ -102,6 +107,9 @@ end
   # The invoice associated with this applied payment.
   field :invoice
 
+  # The refund payment associated with this applied payment
+  field :refund
+
   # Additional attributes that may be required by the source system.
   # @type: object
   field :erp_system_attributes

data/app/platform_api/schema/payment_applied_sync.rb

@@ -8,7 +8,7 @@ end
   # 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
@@ -40,9 +40,25 @@ end
   # @format: uuid
   field :invoice_network_id
 
-  # This field indicates which Payment was used to provide the funds for this payment application. In this
-  # field, identify the original primary key or unique ID of the Payment that was used for this payment
-  # application.
+  # This field indicates which Payment is being used to provide the funds for a the payment.  In this field,
+  # identify the original primary key or unique ID of the Payment which will be supplying the funds.
+  #             
+  # This information lets you track how a payment was funded. You can identify what proportion of an payment's
+  # balance was paid by which methods by joining this field to the Payment.
+  #             
+  # This value should match the [Payment ErpKey](https://developer.lockstep.io/docs/importing-payments#erpkey)
+  # field on the [PaymentSyncModel](https://developer.lockstep.io/docs/importing-payments).
+  # @type: string
+  field :refund_erp_key
+
+  # The network id of the related refund Payment.
+  # @type: string
+  # @format: uuid
+  field :refund_network_id
+
+  # This field indicates which Payment was used to provide the funds for this payment application, or the payment that
+  # is being funded in the case of a refund. In this field, identify the original primary key or unique ID of the
+  # Payment that was used for this payment or the Payment that is being refunded.
   #             
   # This information lets you track how an invoice was paid. You can identify what proportion of an payment's
   # balance was paid by which methods by joining this field to the Payment.

data/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 @@ end
   # @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

data/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).

data/app/platform_api/schema/payment_sync.rb

@@ -8,7 +8,7 @@ end
   # 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 @@ end
   # @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

data/app/platform_api/schema/status.rb

@@ -91,10 +91,10 @@ end
   # 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
 

data/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 @@ end
   # @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"}
 
 

data/app/platform_api/schema/tax_summary.rb

@@ -0,0 +1,29 @@
+class Schema::TaxSummary < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The tax code for this invoice
+  # @type: string
+  field :tax_code
+
+  # The tax rate for this invoice
+  # @type: number
+  # @format: double
+  field :tax_rate
+
+  # The tax total for this invoice
+  # @type: number
+  # @format: double
+  field :tax_total
+
+  # The base currency tax total for this invoice
+  # @type: number
+  # @format: double
+  field :base_currency_tax_total
+
+
+
+end

data/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).
@@ -54,10 +54,6 @@ end
   # @format: uuid
   field :modified_user_id
 
-  # The name of the user who last modified the user account
-  # @type: string
-  field :modified_user_name
-
   # The ID of the user in Azure B2C
   # @type: string
   # @format: uuid

data/app/platform_api/schema/user_data_response.rb

@@ -9,7 +9,7 @@ end
   # @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

data/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).

data/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).

data/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).

data/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 @@ end
   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 @@ end
 
   # 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.

data/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 @@ end
   # @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

data/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 @@ end
   # @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 @@ end
   # 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).