lockstep_rails 0.3.52 → 0.3.54

data/app/platform_api/schema/attachment_link_fetch_result.rb

@@ -0,0 +1,26 @@
+class Schema::AttachmentLinkFetchResult < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  
+  # @type: integer
+  # @format: int32
+  field :total_count
+
+  
+  # @type: integer
+  # @format: int32
+  field :page_size
+
+  
+  # @type: integer
+  # @format: int32
+  field :page_number
+
+
+  has_many :records, {:class_name=>"Schema::AttachmentLink", :included=>true}
+
+end

data/app/platform_api/schema/base_currency_sync.rb

@@ -0,0 +1,16 @@
+class Schema::BaseCurrencySync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The default currency code used by this business entity.
+  #             
+  # For a list of defined currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies)
+  # @type: string
+  field :base_currency_code
+
+
+
+end

data/app/platform_api/schema/batch_sync.rb

@@ -5,6 +5,15 @@ def self.id_ref
   nil
 end
 
+  # The optional existing app enrollment to associate with the data in this batch.
+  # @type: string
+  # @format: uuid
+  field :app_enrollment_id
+
+  # True if this is a full sync, false if this is a partial sync. Defaults to false.
+  # @type: boolean
+  field :is_full_sync
+
 
   has_many :companies, {:class_name=>"Schema::CompanySync", :included=>true}
   has_many :contacts, {:class_name=>"Schema::ContactSync", :included=>true}
@@ -17,5 +26,6 @@ end
   has_many :financial_year_settings, {:class_name=>"Schema::FinancialYearSettingSync", :included=>true}
   has_many :financial_accounts, {:class_name=>"Schema::FinancialAccountSync", :included=>true}
   has_many :financial_account_balance_histories, {:class_name=>"Schema::FinancialAccountBalanceHistorySync", :included=>true}
+  has_many :base_currencies, {:class_name=>"Schema::BaseCurrencySync", :included=>true}
 
 end

data/app/platform_api/schema/company.rb

@@ -205,9 +205,44 @@ end
   # @type: string
   field :public_url_slug
 
+  # State Tax ID
+  # @type: string
+  field :state_tax_id
+
+  # The state where the company was registered.
+  # @type: string
+  field :state_of_incorporation
+
+  # Linkedin Url
+  # @type: string
+  field :linked_in_url_slug
+
+  # This flag indicates whether the company is verified.
+  # @type: boolean
+  field :is_verified
+
+  # The date this company was last verified.
+  # @type: string
+  # @format: date-time
+  field :last_verified_date, Types::Params::DateTime
+
   # View box settings for the company logo.
   field :view_box_settings
 
+  # The unique ID of the Service Fabric organisation to which this record belongs.
+  # @type: string
+  # @format: uuid
+  field :service_fabric_org_id
+
+  # The unique ID of this record within Service Fabric.
+  # @type: string
+  # @format: uuid
+  field :service_fabric_company_id
+
+  # A unique identification number assigned to the company by the national registration office.
+  # @type: string
+  field :company_registration_number
+
   # 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).

data/app/platform_api/schema/company_details.rb

@@ -80,12 +80,16 @@ end
   # @format: int32
   field :outstanding_invoices
 
-  # Company total outstanding invoice amount
+  # The group's base currency code.
+  # @type: string
+  field :group_base_currency_code
+
+  # Company total outstanding invoice amount in the group's base currency.
   # @type: number
   # @format: double
   field :outstanding_amount
 
-  # Company total past due amount
+  # Company total past due amount in the group's base currency.
   # @type: number
   # @format: double
   field :amount_past_due

data/app/platform_api/schema/company_details_payment.rb

@@ -40,6 +40,10 @@ end
   # @type: string
   field :invoice_reference_code
 
+  # The currency code of the invoice the payment is associated with.
+  # @type: string
+  field :invoice_currency_code
+
   # Invoice total amount payment is associated with
   # @type: number
   # @format: double
@@ -50,6 +54,10 @@ end
   # @format: date-time
   field :payment_date, Types::Params::DateTime
 
+  # The currency code of the payment.
+  # @type: string
+  field :payment_currency_code
+
   # Amount payment was made for
   # @type: number
   # @format: double

data/app/platform_api/schema/company_sync.rb

@@ -5,7 +5,7 @@ def self.id_ref
   nil
 end
 
-  # Indicates what action to take when a sync model has been found during the sync process.
+  # Indicates what action to take when an existing object has been found during the sync process.
   field :on_match_action
 
   # This is the primary key of the Company record. For this field, you should use whatever the company's unique
@@ -148,6 +148,10 @@ end
   # @type: string
   field :external_reference
 
+  # A unique identification number assigned to the company by the national registration office.
+  # @type: string
+  field :company_registration_number
+
 
 
 end

data/app/platform_api/schema/contact_sync.rb

@@ -5,6 +5,9 @@ def self.id_ref
   nil
 end
 
+  # Indicates what action to take when an existing object has been found during the sync process.
+  field :on_match_action
+
   # This is the primary key of the Contact record. For this field, you should use whatever the contact's unique
   # identifying number is in the originating system. Search for a unique, non-changing number within the
   # originating financial system for this record.

data/app/platform_api/schema/credit_memo_applied_sync.rb

@@ -5,6 +5,9 @@ def self.id_ref
   nil
 end
 
+  # Indicates what action to take when an existing object has been found during the sync process.
+  field :on_match_action
+
   # This is the primary key of the Credit Memo Application record. For this field, you should use whatever this
   # transaction's unique identifying number is in the originating system. Search for a unique, non-changing
   # number within the originating financial system for this record.

data/app/platform_api/schema/credit_memo_invoice.rb

@@ -13,6 +13,14 @@ end
   # @format: uuid
   field :group_key
 
+  # The base currency code of the group.
+  # @type: string
+  field :base_currency_code
+
+  # The currency code of the credit memo invoice.
+  # @type: string
+  field :currency_code
+
   # The unique ID of this record, automatically assigned by Lockstep when this record is
   # added to the Lockstep platform.
   # @type: string
@@ -39,6 +47,11 @@ end
   # @format: double
   field :credit_memo_applied_amount
 
+  # The amount applied to credit memo in the group's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_credit_memo_applied_amount
+
   # An additional reference code that is sometimes used to identify this invoice.
   # The meaning of this field is specific to the ERP or accounting system used by the user.
   # @type: string
@@ -68,6 +81,16 @@ end
   # @format: double
   field :outstanding_balance_amount
 
+  # The total value of this invoice, inclusive of all taxes and line items in the group's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_total_amount
+
+  # The remaining balance value of this invoice in the group's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_outstanding_balance_amount
+
   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"}

data/app/platform_api/schema/creditor_account.rb

@@ -0,0 +1,32 @@
+class Schema::CreditorAccount < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The name of the creditor account.
+  # @type: string
+  field :name
+
+  # The unique identifier of the provider used to execute this payment submission.
+  # @type: string
+  field :servicer_id
+
+  # The name of the payment servicing organisation (for example, Stripe and PayPal).
+  # @type: string
+  field :servicer_name
+
+  # The unique identifier of the company.
+  # @type: string
+  field :company_id
+
+  # The unique identifier of the creditor account in Payments Acceptance Service.
+  # @type: string
+  field :account_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"}
+
+
+end

data/app/platform_api/schema/custom_field_sync.rb

@@ -5,6 +5,9 @@ def self.id_ref
   nil
 end
 
+  # Indicates what action to take when an existing object has been found during the sync process.
+  field :on_match_action
+
   # This is the primary key of the record to which you will attach this custom field. You should provide the
   # identifying number as it is stored in the originating financial system. Search for a unique, non-changing
   # number within the originating financial system for this record.

data/app/platform_api/schema/debtor_account.rb

@@ -0,0 +1,33 @@
+class Schema::DebtorAccount < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique identifier of an existing customer. Will be used to match to a reusable payment
+  # method if one exists. If specified, the other properties on this object will be ignored.
+  # Trying to create a payment with an unknown customer will result in a 400 status code response.
+  # @type: string
+  field :customer_id
+
+  # The merchant's unique identifier of the debtor who will receive the payment request.
+  # @type: string
+  field :account_id
+
+  # The name of the debtor who will receive the payment request.
+  # @type: string
+  field :name
+
+  # The email address of the debtor who will receive the payment request.
+  # @type: string
+  field :email_address
+
+  # Debtor Agent Account object.
+  field :debtor_agent_account
+
+  belongs_to :customer, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"}
+  belongs_to :connection, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"}
+
+
+end

data/app/platform_api/schema/debtor_agent_account.rb

@@ -0,0 +1,26 @@
+class Schema::DebtorAgentAccount < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Name of the identification scheme.
+  # @type: string
+  field :schema_name
+
+  # The unique identifier of the underlying debtor account to which a debit entry will be made as a result of the transaction.
+  # @type: string
+  field :identification
+
+  # Last 4 digits of real-world account.
+  # @type: string
+  field :last4_digits
+
+  # Real-world account brand name (for example, Visa, Mastercard, PayPal and so on)
+  # @type: string
+  field :brand
+
+
+
+end

data/app/platform_api/schema/developer_account_submit.rb

@@ -5,10 +5,6 @@ def self.id_ref
   nil
 end
 
-  # The name of the developer.
-  # @type: string
-  field :name
-
   # The first name of the person requesting the developer account.
   # @type: string
   field :first_name

data/app/platform_api/schema/dpo_summary.rb

@@ -31,7 +31,11 @@ end
   # @format: int32
   field :bills
 
-  # The total amount outstanding.
+  # The group's base currency code.
+  # @type: string
+  field :base_currency_code
+
+  # The total amount outstanding at the group's base currency.
   # @type: number
   # @format: double
   field :amount_outstanding

data/app/platform_api/schema/dpo_summary_group_total.rb

@@ -23,7 +23,11 @@ end
   # @format: int32
   field :bills
 
-  # The total amount outstanding
+  # The group's base currency code
+  # @type: string
+  field :base_currency_code
+
+  # The total amount outstanding at the group's base currency.
   # @type: number
   # @format: double
   field :amount_outstanding

data/app/platform_api/schema/financial_account_sync.rb

@@ -5,6 +5,9 @@ def self.id_ref
   nil
 end
 
+  # Indicates what action to take when an existing object has been found during the sync process.
+  field :on_match_action
+
   # The code for the Financial Account. Can either be a general ledger or
   # an account code.
   # @type: string

data/app/platform_api/schema/group_account.rb

@@ -59,6 +59,10 @@ end
   # @format: uuid
   field :modified_user_id
 
+  # The 2-letter ISO country code for the group
+  # @type: string
+  field :country_code
+
   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/instructed_amount.rb

@@ -0,0 +1,19 @@
+class Schema::InstructedAmount < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The amount of the charge, in minor units (e.g. $10.50 would be sent as 1050).
+  # @type: number
+  # @format: double
+  field :amount
+
+  # The currency, in ISO 4217 format.
+  # @type: string
+  field :currency
+
+
+
+end

data/app/platform_api/schema/invoice.rb

@@ -5,17 +5,17 @@ def self.id_ref
   nil
 end
 
-  # The GroupKey uniquely identifies a single Lockstep Platform account.  All records for this
-  # account will share the same GroupKey value.  GroupKey values cannot be changed once created.
-  #             
+  # The GroupKey uniquely identifies a single Lockstep Platform 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).
   # @type: string
   # @format: uuid
   field :group_key
 
-  # The unique ID of this record, automatically assigned by Lockstep when this record is
-  # added to the Lockstep platform.
-  #             
+  # The unique ID of this record, automatically assigned by Lockstep when this record is
+  # added to the Lockstep platform.
+  #             
   # For the ID of this record in its originating financial system, see `ErpKey`.
   # @type: string
   # @format: uuid
@@ -31,23 +31,23 @@ end
   # @format: uuid
   field :customer_id
 
-  # 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`
-  # set to the original primary key number of the record as it was known in the originating financial
-  # system.  If this record was not imported, this value will be `null`.
-  #             
+  # 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`
+  # set to the original primary key number of the record as it was known in the originating financial
+  # system.  If this record was not imported, this value will be `null`.
+  #             
   # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
   # @type: string
   field :erp_key
 
-  # The "Purchase Order Code" is a code that is sometimes used by companies to refer to the original PO
-  # that was sent that caused this invoice to be written.  If a customer sends a purchase order to a vendor,
+  # The "Purchase Order Code" is a code that is sometimes used by companies to refer to the original PO
+  # that was sent that caused this invoice to be written.  If a customer sends a purchase order to a vendor,
   # the vendor can then create an invoice and refer back to the originating purchase order using this field.
   # @type: string
   field :purchase_order_code
 
-  # An additional reference code that is sometimes used to identify this invoice.
+  # An additional reference code that is sometimes used to identify this invoice.
   # The meaning of this field is specific to the ERP or accounting system used by the user.
   # @type: string
   field :reference_code
@@ -60,25 +60,25 @@ end
   # @type: string
   field :salesperson_name
 
-  # A code identifying the type of this invoice.
-  #             
-  # Recognized Invoice types are:
-  # * `AR Invoice` - Represents an invoice sent by Company to the Customer
-  # * `AP Invoice` - Represents an invoice sent by Vendor to the Company
-  # * `AR Credit Memo` - Represents a credit memo generated by Company given to Customer
+  # A code identifying the type of this invoice.
+  #             
+  # Recognized Invoice types are:
+  # * `AR Invoice` - Represents an invoice sent by Company to the Customer
+  # * `AP Invoice` - Represents an invoice sent by Vendor to the Company
+  # * `AR Credit Memo` - Represents a credit memo generated by Company given to Customer
   # * `AP Credit Memo` - Represents a credit memo generated by Vendor given to Company
   # @type: string
   field :invoice_type_code
 
-  # A code identifying the status of this invoice.
-  #             
-  # Recognized Invoice status codes are:
-  # * `Open` - Represents an invoice that is considered open and needs more work to complete
+  # A code identifying the status of this invoice.
+  #             
+  # Recognized Invoice status codes are:
+  # * `Open` - Represents an invoice that is considered open and needs more work to complete
   # * `Closed` - Represents an invoice that is considered closed and resolved
   # @type: string
   field :invoice_status_code
 
-  # A code identifying the terms given to the purchaser.  This field is imported directly from the originating
+  # 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
   field :terms_code
@@ -91,22 +91,22 @@ end
   # @type: string
   field :currency_code
 
-  # The total value of this invoice, inclusive of all taxes and line items.
+  # The total value of this invoice, inclusive of all taxes and line items in it's tendered currency.
   # @type: number
   # @format: double
   field :total_amount
 
-  # The total sales (or transactional) tax calculated for this invoice.
+  # The total sales (or transactional) tax calculated for this invoice in it's tendered currency.
   # @type: number
   # @format: double
   field :sales_tax_amount
 
-  # The total discounts given by the seller to the buyer on this invoice.
+  # The total discounts given by the seller to the buyer on this invoice in it's tendered currency.
   # @type: number
   # @format: double
   field :discount_amount
 
-  # The remaining balance value of this invoice.
+  # The remaining balance value of this invoice in it's tendered currency.
   # @type: number
   # @format: double
   field :outstanding_balance_amount
@@ -126,7 +126,7 @@ end
   # @format: date
   field :posted_date
 
-  # The date when the invoice was closed and finalized after completion of all payments and delivery of all products and
+  # The date when the invoice was closed and finalized after completion of all payments and delivery of all products and
   # services.
   # @type: string
   # @format: date
@@ -177,9 +177,9 @@ end
   # @format: uuid
   field :modified_user_id
 
-  # The AppEnrollmentId of the application that imported this record.  For accounts
-  # with more than one financial system connected, this field identifies the originating
-  # financial system that produced this record.  This value is null if this record
+  # The AppEnrollmentId of the application that imported this record.  For accounts
+  # with more than one financial system connected, this field identifies the originating
+  # financial system that produced this record.  This value is null if this record
   # was not loaded from an external ERP or financial system.
   # @type: string
   # @format: uuid
@@ -206,35 +206,35 @@ end
   # @format: double
   field :currency_rate
 
-  # The Currency Rate used to get from the account's base currency to the total amount.
+  # The total value of this invoice, inclusive of all taxes and line items in the group's base currency.
   # @type: number
   # @format: double
   field :base_currency_total_amount
 
-  # The sales tax amount in the group's base currency.
+  # The total sales (or transactional) tax calculated for this invoice in the group's base currency.
   # @type: number
   # @format: double
   field :base_currency_sales_tax_amount
 
-  # The discount amount in the group's base currency.
+  # The total discounts given by the seller to the buyer on this invoice in the group's base currency.
   # @type: number
   # @format: double
   field :base_currency_discount_amount
 
-  # The outstanding balance amount in the group's base currency.
+  # The remaining balance value of this invoice in the group's base currency.
   # @type: number
   # @format: double
   field :base_currency_outstanding_balance_amount
 
-  # The Company associated to this invoice.
+  # The Company associated to this invoice.
   # To retrieve this item, specify `Company` in the "Include" parameter for your query.
   field :company
 
-  # The Customer associated to the invoice customer
+  # The Customer associated to the invoice customer
   # To retrieve this item, specify `Customer` in the "Include" parameter for your query.
   field :customer
 
-  # The Contact associated to the invoice customer
+  # The Contact associated to the invoice customer
   # To retrieve this item, specify `Customer` in the "Include" parameter for your query.
   field :customer_primary_contact
 

data/app/platform_api/schema/invoice_line_sync.rb

@@ -5,6 +5,9 @@ def self.id_ref
   nil
 end
 
+  # Indicates what action to take when an existing object has been found during the sync process.
+  field :on_match_action
+
   # This is the primary key of the Invoice Line record. For this field, you should use whatever the contact's unique
   # identifying number is in the originating system. Search for a unique, non-changing number within the
   # originating financial system for this record.

data/app/platform_api/schema/invoice_payment_detail.rb

@@ -13,6 +13,14 @@ end
   # @format: uuid
   field :group_key
 
+  # The base currency code of the group.
+  # @type: string
+  field :base_currency_code
+
+  # The payment's currency code.
+  # @type: string
+  field :currency_code
+
   # The unique identifier of this PaymentApplied record.
   # @type: string
   # @format: uuid
@@ -38,6 +46,11 @@ end
   # @format: double
   field :payment_applied_amount
 
+  # Amount applied to Invoice in the group's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_payment_applied_amount
+
   # An additional reference code that is sometimes used to identify this Payment.
   # The meaning of this field is specific to the ERP or accounting system used by the user.
   # @type: string
@@ -58,6 +71,16 @@ end
   # @format: double
   field :unapplied_amount
 
+  # The total value of this Payment in the group's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_payment_amount
+
+  # The remaining balance value of this Payment in the group's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_unapplied_amount
+
   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"}