lockstep_rails 0.3.87 → 0.3.89

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcefbcd84186a76490ec812d59c2cab17f7ff081a79585792b3418fa7d13b262
-  data.tar.gz: 734d52eeb0306582135c94d35329f429ded9c57373dcf33b5b1a729e5dace116
+  metadata.gz: 1008eefb914dcab235285b2999755c9242e8d05534f9384c52206f3b058e1862
+  data.tar.gz: c85cd4993e3fc9c93aa0e0e547c9d3779c5896abbf53e41cd10c373c5f020dd0
 SHA512:
-  metadata.gz: b6e9354d23de33cb388330f55fc28320ccb11c2c7b02e0317c99fedb88f8a1bdeff06494071c131ea7a6e24f318bf74a0868cd7102f253c76815d9449c852f21
-  data.tar.gz: e600d47dea0f90d304cea657d2fea6e7a40888808663208f8b3a63c1dca692d3cb592eef95df57d25bd13f22696dbb64249fb664563f59ef208c27182d453d9c
+  metadata.gz: 9562d96a4d771cfaeed3158afaf26a73b470e1f14b363650a4d30ec150d67f0dcd3c8cf10bf2e2954994bb908ab51577e8ef204cdae26d625b9258d767ee6b1e
+  data.tar.gz: a9b258a6e704fbc0d58dec9491bf9e3d91a7df0642c9c25226679d34593904b6c320a94e57a70d84ed4f4393d37362ccfefa41be47f405d107a7a91d187c1467

data/app/models/lockstep/status.rb

@@ -1,8 +1,8 @@
 class Lockstep::Status
   Lockstep::ApiRecord.model_name_uri = 'v1/Status'
 
-  def self.ping
-    resp = Lockstep::ApiRecord.resource.get('')
+  def self.ping(query_params = {})
+    resp = Lockstep::ApiRecord.resource.get('', params: query_params)
     raise Lockstep::Exceptions::BadRequestError, 'Endpoint not found' if resp.code == '404'
 
     status = JSON.parse(resp.body)

data/app/platform_api/schema/aging.rb

@@ -5,20 +5,17 @@ def self.id_ref
   nil
 end
 
-  # Aging bucket of outstanding balance data (days past due date of invoice)
-  # @type: integer
-  # @format: int32
-  field :bucket
-
-  # Currency code of aging bucket
+  # The Group Key the aging data is calculated for.
   # @type: string
-  field :currency_code
+  # @format: uuid
+  field :group_key
 
-  # Outstanding balance for the given aging bucket
+  # The total AR outstanding amount in the group's base currency.
   # @type: number
   # @format: double
-  field :outstanding_balance
+  field :total
 
 
+  has_many :buckets, {:class_name=>"Schema::AgingBucketResult", :included=>true}
 
 end

data/app/platform_api/schema/aging_bucket_result.rb

@@ -0,0 +1,18 @@
+class Schema::AgingBucketResult < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The different buckets used for aging.
+  field :bucket
+
+  # The outstanding amount for the given bucket in the group's base currency.
+  # @type: number
+  # @format: double
+  field :value
+
+
+
+end

data/app/platform_api/schema/batch_sync.rb

@@ -35,6 +35,7 @@ end
   has_many :credit_memo_applications, {:class_name=>"Schema::CreditMemoAppliedSync", :included=>true}
   has_many :invoices, {:class_name=>"Schema::InvoiceSync", :included=>true}
   has_many :invoice_lines, {:class_name=>"Schema::InvoiceLineSync", :included=>true}
+  has_many :invoice_workflow_statuses, {:class_name=>"Schema::InvoiceWorkflowStatusSync", :included=>true}
   has_many :custom_fields, {:class_name=>"Schema::CustomFieldSync", :included=>true}
   has_many :payments, {:class_name=>"Schema::PaymentSync", :included=>true}
   has_many :payment_applications, {:class_name=>"Schema::PaymentAppliedSync", :included=>true}

data/app/platform_api/schema/company.rb

@@ -151,10 +151,6 @@ end
   # @format: uuid
   field :modified_user_id
 
-  # The name of the user who last modified this company
-  # @type: string
-  field :modified_user_name
-
   # Federal Tax ID
   # @type: string
   field :tax_id
@@ -276,6 +272,7 @@ end
   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"}
 
+  has_many :company_identifiers, {:class_name=>"Schema::CompanyIdentifier", :included=>true}
   has_many :notes, {:class_name=>"Lockstep::Note", :included=>true, :foreign_key=>:object_key, :polymorphic=>{:table_key=>"Company"}}
   has_many :attachments, {:class_name=>"Schema::Attachment", :included=>true}
   has_many :contacts, {:class_name=>"Schema::Contact", :included=>true}

data/app/platform_api/schema/company_identifier.rb

@@ -0,0 +1,26 @@
+class Schema::CompanyIdentifier < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The type of identifier.
+  # @type: string
+  field :type
+
+  # The value of the identifier.
+  # @type: string
+  field :value
+
+  # The jurisdiction of the identifier.
+  # @type: string
+  field :jurisdiction
+
+  # The sub-jurisdiction of the identifier, ISO3166-1 or ISO3166-2 code.
+  # @type: string
+  field :subjurisdiction
+
+
+
+end

data/app/platform_api/schema/company_magic_link_summary.rb

@@ -115,6 +115,10 @@ end
   # @format: uuid
   field :invite_status_modified_user_id
 
+  # This flag indicates whether the company is currently active.
+  # @type: boolean
+  field :is_active
+
   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.rb

@@ -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
@@ -151,6 +176,11 @@ end
   # @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 +273,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 +313,14 @@ 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
+
   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 +337,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_line.rb

@@ -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,10 +107,24 @@ 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

data/app/platform_api/schema/invoice_line_sync.rb

@@ -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,10 +105,24 @@ 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

data/app/platform_api/schema/invoice_sync.rb

@@ -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
@@ -158,6 +168,11 @@ end
   # @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 +346,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 +373,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

data/app/platform_api/schema/invoice_workflow_status_history.rb

@@ -25,6 +25,11 @@ end
   # @type: string
   field :workflow_status_name
 
+  # 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 Platform account.  All records for this
   # account will share the same GroupKey value.  GroupKey values cannot be changed once created.
   #             
@@ -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

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/payment.rb

@@ -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`

data/app/platform_api/schema/payment_applied.rb

@@ -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

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

@@ -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/workflow_status.rb

@@ -36,6 +36,10 @@ end
   # @type: boolean
   field :is_notes_required
 
+  # Indicates whether a reason is required or not.
+  # @type: boolean
+  field :is_reason_required
+
   # Indicates whether the status change should be reported to the ERP or not.
   # @type: boolean
   field :promote_to_erp
@@ -67,6 +71,7 @@ end
   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"}
 
+  has_many :parents, {:class_name=>"Schema::WorkflowStatus", :included=>true}
   has_many :children, {:class_name=>"Schema::WorkflowStatus", :included=>true}
 
 end