lockstep_rails 0.3.88 → 0.3.90

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

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

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

data/app/platform_api/schema/financial_account.rb

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

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

data/app/platform_api/schema/financial_account_balance_history_sync.rb

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

data/app/platform_api/schema/financial_institution_account.rb

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

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

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

data/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 @@ end
   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
@@ -31,6 +31,10 @@ end
   # @format: uuid
   field :customer_id
 
+  # The name of the customer associated with this invoice.
+  # @type: string
+  field :customer_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`
@@ -87,6 +91,12 @@ end
   # @type: string
   field :workflow_status_notes
 
+  # The reason code for the current workflow status of this invoice.
+  #             
+  # Empty if workflow status does not require a reason code.
+  # @type: string
+  field :workflow_status_reason_code
+
   # A code identifying the terms given to the purchaser.  This field is imported directly from the originating
   # financial system and does not follow a specified format.
   # @type: string
@@ -120,6 +130,21 @@ end
   # @format: double
   field :outstanding_balance_amount
 
+  # The shipping amount of this invoice in it's tendered currency.
+  # @type: number
+  # @format: double
+  field :shipping_amount
+
+  # The total value of this invoice with deductions, excluding taxes.
+  # @type: number
+  # @format: double
+  field :net_amount
+
+  # The shipping amount of this invoice in it's tendered currency.
+  # @type: number
+  # @format: double
+  field :base_currency_shipping_amount
+
   # The reporting date for this invoice.
   # @type: string
   # @format: date
@@ -146,11 +171,21 @@ end
   # @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
   field :imported_date, Types::Params::DateTime
 
+  # The date when the tax becomes applicable; used for tax reporting.
+  # @type: string
+  # @format: date
+  field :tax_point_date
+
   # The ID number of the invoice's origination address
   # @type: string
   # @format: uuid
@@ -243,6 +278,11 @@ end
   # @format: double
   field :base_currency_outstanding_balance_amount
 
+  # The total value of this invoice with deductions, excluding taxes and in the invoice's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_net_amount
+
   # Possible statuses for a record that supports ERP Update.
   field :erp_update_status
 
@@ -278,6 +318,24 @@ end
   # @type: object
   field :erp_system_attributes
 
+  # The source of the invoice (e.g ERP, Peppol, Email, Gov System)
+  # @type: string
+  field :document_source
+
+  # The jurisdiction or country from which the invoice originates (e.g., US, AU)
+  # @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"}
@@ -294,5 +352,6 @@ end
   has_many :credit_memos, {:class_name=>"Schema::CreditMemoInvoice", :included=>true}
   has_many :custom_field_values, {:class_name=>"Schema::CustomFieldValue", :included=>true}
   has_many :custom_field_definitions, {:class_name=>"Schema::CustomFieldDefinition", :included=>true}
+  has_many :tax_summary, {:class_name=>"Schema::TaxSummary", :included=>true}
 
 end

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

data/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).
@@ -54,6 +54,10 @@ end
   # @type: string
   field :description
 
+  # The location to where specific items from an invoice will go.
+  # @type: string
+  field :location
+
   # For lines measured in a unit other than "quantity", this code indicates the measurement system for the quantity field.
   # If the line is measured in quantity, this field is null.
   # @type: string
@@ -84,6 +88,15 @@ end
   # @format: double
   field :total_amount
 
+  # The tax code used for taxation on this line.
+  # @type: string
+  field :tax_code
+
+  # The taxation rate for this line.
+  # @type: number
+  # @format: double
+  field :tax_rate
+
   # The amount of sales tax for this line in the transaction's currency.
   # @type: number
   # @format: double
@@ -94,31 +107,30 @@ end
   # @format: double
   field :base_currency_sales_tax_amount
 
+  # The total value of this invoice line with deductions, excluding taxes.
+  # @type: number
+  # @format: double
+  field :net_amount
+
+  # The total value of this invoice line with deductions, excluding taxes and in the invoice's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_net_amount
+
   # If this line is tax exempt, this code indicates the reason for the exemption.
   # @type: string
   field :exemption_code
 
+  # Unique identifier for tax purposes, used for reference, validation, or compliance.
+  # @type: string
+  field :tax_uid
+
   # If null, the products specified on this line were delivered on the same date as all other lines.
   # If not null, this line was delivered or finalized on a different date than the overall invoice.
   # @type: string
   # @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

data/app/platform_api/schema/invoice_line_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
@@ -52,6 +52,10 @@ end
   # @type: string
   field :description
 
+  # The location to where specific items from an invoice will go.
+  # @type: string
+  field :location
+
   # For lines measured in a unit other than "quantity", this code indicates the measurement system for the quantity field.
   # If the line is measured in quantity, this field is null.
   # @type: string
@@ -82,6 +86,15 @@ end
   # @format: double
   field :total_amount
 
+  # The tax code used for taxation on this line.
+  # @type: string
+  field :tax_code
+
+  # The taxation rate for this line.
+  # @type: number
+  # @format: double
+  field :tax_rate
+
   # The amount of sales tax for this line in the transaction's currency.
   # @type: number
   # @format: double
@@ -92,129 +105,29 @@ end
   # @format: double
   field :base_currency_sales_tax_amount
 
-  # If this line is tax exempt, this code indicates the reason for the exemption.
-  # @type: string
-  field :exemption_code
-
-  # If null, the products specified on this line were delivered on the same date as all other lines.
-  # If not null, this line was delivered or finalized on a different date than the overall invoice.
-  # @type: string
-  # @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
+  # The total value of this invoice line with deductions, excluding taxes.
   # @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
+  # @format: double
+  field :net_amount
 
-  # Billing address for this invoice line, if this line item is to be billed to a different address
+  # The total value of this invoice line with deductions, excluding taxes and in the invoice's base currency.
   # @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
+  # @format: double
+  field :base_currency_net_amount
 
-  # Shipping address for this invoice line, if this line item is to be shipped to a different address
+  # If this line is tax exempt, this code indicates the reason for the exemption.
   # @type: string
-  field :ship_to_address_region
+  field :exemption_code
 
-  # Shipping address for this invoice line, if this line item is to be shipped to a different address
+  # Unique identifier for tax purposes, used for reference, validation, or compliance.
   # @type: string
-  field :ship_to_address_postal_code
+  field :tax_uid
 
-  # Shipping address for this invoice line, if this line item is to be shipped to a different address
+  # If null, the products specified on this line were delivered on the same date as all other lines.
+  # If not null, this line was delivered or finalized on a different date than the overall invoice.
   # @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
+  # @format: date-time
+  field :reporting_date, Types::Params::DateTime
 
   # 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

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

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

data/app/platform_api/schema/invoice_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
@@ -127,6 +127,16 @@ end
   # @format: double
   field :outstanding_balance_amount
 
+  # The shipping amount of this invoice in it's tendered currency.
+  # @type: number
+  # @format: double
+  field :shipping_amount
+
+  # The total value of this invoice with deductions, excluding taxes.
+  # @type: number
+  # @format: double
+  field :net_amount
+
   # The reporting date for this invoice.
   # @type: string
   # @format: date-time
@@ -153,11 +163,20 @@ end
   # @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
   field :imported_date, Types::Params::DateTime
 
+  # The date when the tax becomes applicable; used for tax reporting.
+  # @type: string
+  # @format: date-time
+  field :tax_point_date, Types::Params::DateTime
+
   # The origination address for this invoice
   # @type: string
   field :origin_address_line1
@@ -331,6 +350,16 @@ end
   # @format: double
   field :base_currency_outstanding_balance_amount
 
+  # The shipping amount of this invoice in it's tendered currency.
+  # @type: number
+  # @format: double
+  field :base_currency_shipping_amount
+
+  # The total value of this invoice with deductions, excluding taxes and in the invoice's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_net_amount
+
   # True if the invoice is an E-Invoice
   # @type: boolean
   field :is_e_invoice
@@ -348,10 +377,28 @@ end
   # @type: string
   field :workflow_status_notes
 
+  # The reason code for the current workflow status of this invoice.
+  #             
+  # Empty if workflow status does not require a reason code.
+  # @type: string
+  field :workflow_status_reason_code
+
   # Workflow status code dictated by government standards
   # @type: string
   field :workflow_status_code
 
+  # A JSON string representing the tax information for this invoice
+  # @type: string
+  field :tax_summary
+
+  # The source of the invoice (e.g ERP, Peppol, Email, Gov System)
+  # @type: string
+  field :document_source
+
+  # The jurisdiction or country from which the invoice originates (e.g., US, AU)
+  # @type: string
+  field :jurisdiction
+
 
 
 end