lockstep_rails 0.3.52 → 0.3.53

data/app/platform_api/schema/invoice_summary.rb

@@ -5,9 +5,9 @@ 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
@@ -23,7 +23,7 @@ end
   # @format: uuid
   field :invoice_id
 
-  # A reference code that is used to identify this invoice.
+  # A reference code that is 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 :invoice_number
@@ -33,7 +33,7 @@ end
   # @format: date
   field :invoice_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
@@ -52,6 +52,10 @@ end
   # @format: date
   field :payment_due_date
 
+  # The currency code for the invoice.
+  # @type: string
+  field :currency_code
+
   # The total amount of the Invoice.
   # @type: number
   # @format: double
@@ -62,6 +66,20 @@ end
   # @format: double
   field :outstanding_balance
 
+  # The group's base currency code.
+  # @type: string
+  field :base_currency_code
+
+  # The invoice amount in the group's base currency
+  # @type: number
+  # @format: double
+  field :base_currency_invoice_amount
+
+  # The outstanding balance amount in the group's base currency
+  # @type: number
+  # @format: double
+  field :base_currency_outstanding_balance
+
   # A code identifying the type of this Invoice.
   # @type: string
   field :invoice_type_code
@@ -81,7 +99,7 @@ end
   # @format: int32
   field :payment_count
 
-  # Specific invoices have support for pdf retrieval from their respective erp. When this flag is true, an additional
+  # Specific invoices have support for pdf retrieval from their respective erp. When this flag is true, an additional
   # call to Invoices/{id}/pdf can be made to retrieve a pdf directly from the erp.
   # @type: boolean
   field :supports_erp_pdf_retrieval
@@ -94,24 +112,6 @@ end
   # @type: array
   field :payment_ids
 
-  # The group's currency code.
-  # @type: string
-  field :currency_code
-
-  # The group's base currency code.
-  # @type: string
-  field :base_currency_code
-
-  # The invoice amount in the group's base currency.
-  # @type: number
-  # @format: double
-  field :base_currency_invoice_amount
-
-  # The outstanding balance amount in the group's base currency.
-  # @type: number
-  # @format: double
-  field :base_currency_outstanding_balance
-
   # The modified date of the invoice.
   # @type: string
   # @format: date-time

data/app/platform_api/schema/invoice_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 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.
@@ -89,22 +92,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 the invoice 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 the invoice 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 the invoice currency.
   # @type: number
   # @format: double
   field :discount_amount
 
-  # The remaining balance value of this invoice.
+  # The remaining balance value of this invoice in the invoice currency.
   # @type: number
   # @format: double
   field :outstanding_balance_amount
@@ -285,6 +288,26 @@ end
   # @format: double
   field :currency_rate
 
+  # The total value of this invoice, inclusive of all taxes and line items in the erp's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_total_amount
+
+  # The total sales (or transactional) tax calculated for this invoice in the erp's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_sales_tax_amount
+
+  # The total discounts given by the seller to the buyer on this invoice in the erp's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_discount_amount
+
+  # The remaining balance value of this invoice in the erp's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_outstanding_balance_amount
+
 
 
 end

data/app/platform_api/schema/magic_link.rb

@@ -5,13 +5,13 @@ def self.id_ref
   nil
 end
 
-  # The unique ID of this record, automatically assigned by Lockstep when this record is
+  # The unique ID of this record, automatically assigned by Lockstep when this record is
   # added to the Lockstep platform.
   # @type: string
   # @format: uuid
   field :magic_link_id
 
-  # The GroupKey uniquely identifies a single Lockstep Platform account.  All records for this
+  # 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.
   # @type: string
   # @format: uuid
@@ -72,18 +72,18 @@ end
   # @format: uuid
   field :accounting_profile_id
 
-  # The created magic link URL. This will only be returned upon creation of the magic link.
+  # The created magic link URL. This will only be returned upon creation of the magic link.
   # All other times, this value will be `null`.
   # @type: string
   field :magic_link_url
 
-  # The user associated with this magic link.
+  # The user associated with this magic link.
   # To retrieve this item, specify `User` in the "Include" parameter for your query.
   field :user
 
   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"}
-  belongs_to :company, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"company_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"}
 
 

data/app/platform_api/schema/magic_link_status.rb

@@ -10,6 +10,11 @@ end
   # @format: uuid
   field :magic_link_id
 
+  # The id of the application for the Magic Link
+  # @type: string
+  # @format: uuid
+  field :application_id
+
   # The id of the target company for the Magic Link
   # @type: string
   # @format: uuid
@@ -20,6 +25,11 @@ end
   # @format: uuid
   field :accounting_profile_id
 
+  # The UTC date and time when this magic link expires.
+  # @type: string
+  # @format: date-time
+  field :expires, Types::Params::DateTime
+
   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/metadata.rb

@@ -0,0 +1,14 @@
+class Schema::Metadata < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Markup for emails that will cause an Actionable Message Card to be presented in Outlook clients for this payment.
+  # @type: string
+  field :outlook
+
+
+
+end

data/app/platform_api/schema/payables_coming_due.rb

@@ -5,6 +5,12 @@ def self.id_ref
   nil
 end
 
+  # This model represents all the payables that are
+  # either already due or due within this date.
+  # @type: string
+  # @format: date-time
+  field :due_date, Types::Params::DateTime
+
   # 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.
   #             
@@ -13,19 +19,19 @@ end
   # @format: uuid
   field :group_key
 
-  # Number of bills due for this time period
-  # @type: integer
-  # @format: int32
-  field :number_of_bills_due
+  # Name for this company
+  # @type: string
+  field :vendor_name
 
   # The unique Lockstep Id for the Vendor
   # @type: string
   # @format: uuid
   field :vendor_id
 
-  # Name for this company
-  # @type: string
-  field :vendor_name
+  # Number of bills due for this time period
+  # @type: integer
+  # @format: int32
+  field :number_of_bills_due
 
   # Primary Contact for this company
   # @type: string
@@ -36,17 +42,15 @@ end
   # @format: double
   field :percentage_of_total
 
-  # Total amount due for this time period
+  # The base currency code of the group
+  # @type: string
+  field :base_currency_code
+
+  # Total amount due for this time period at the group's base currency
   # @type: number
   # @format: double
   field :total_amount_due
 
-  # This model represents all the payables that are
-  # either already due or due within this date.
-  # @type: string
-  # @format: date-time
-  field :due_date, Types::Params::DateTime
-
 
 
 end

data/app/platform_api/schema/payables_coming_due_header.rb

@@ -28,7 +28,11 @@ end
   # @format: double
   field :percentage_of_total
 
-  # Total amount due for this time period
+  # The group's base currency code.
+  # @type: string
+  field :base_currency_code
+
+  # Total amount due for this time period in the group's base currency.
   # @type: number
   # @format: double
   field :total_amount_due

data/app/platform_api/schema/payables_coming_due_widget.rb

@@ -19,7 +19,11 @@ end
   # @format: date-time
   field :date, Types::Params::DateTime
 
-  # Total amount due for this time period
+  # The group's base currency code.
+  # @type: string
+  field :base_currency_code
+
+  # Total amount due for this time period at the group's base currency.
   # @type: number
   # @format: double
   field :amount_due

data/app/platform_api/schema/payables_summary_report.rb

@@ -18,7 +18,11 @@ end
   # @format: int32
   field :timeframe
 
-  # Amount of payments made based in the timeframe
+  # The base currency code of the group.
+  # @type: string
+  field :base_currency_code
+
+  # Amount of payments made based in the timeframe in the group's base currency.
   # @type: number
   # @format: double
   field :total_payments_amount
@@ -28,7 +32,7 @@ end
   # @format: int32
   field :total_payments_count
 
-  # Amount of bills received based in the timeframe
+  # Amount of bills received based in the timeframe in the group's base currency.
   # @type: number
   # @format: double
   field :total_amount_billed

data/app/platform_api/schema/payment.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
@@ -26,36 +26,36 @@ end
   # @format: uuid
   field :company_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 type of payment, AR Payment or AP Payment.
-  #             
-  # Recognized PaymentType values are:
-  # * `AR Payment` - A payment made by a Customer to the Company
+  # The type of payment, AR Payment or AP Payment.
+  #             
+  # Recognized PaymentType values are:
+  # * `AR Payment` - A payment made by a Customer to the Company
   # * `AP Payment` - A payment made by the Company to a Vendor
   # @type: string
   field :payment_type
 
-  # Cash, check, credit card, wire transfer.
-  #             
-  # Recognized TenderType values are:
-  # * `Cash` - A cash payment or other direct transfer.
-  # * `Check` - A check payment.
-  # * `Credit Card` - A payment made via a credit card.
-  # * `Wire Transfer` - A payment made via wire transfer from another financial institution.
+  # Cash, check, credit card, wire transfer.
+  #             
+  # Recognized TenderType values are:
+  # * `Cash` - A cash payment or other direct transfer.
+  # * `Check` - A check payment.
+  # * `Credit Card` - A payment made via a credit card.
+  # * `Wire Transfer` - A payment made via wire transfer from another financial institution.
   # * `Other` - A payment made via another method not listed above.
   # @type: string
   field :tender_type
 
-  # True if this payment includes some unassigned amount that has not yet been applied to an invoice.  If this
+  # True if this payment includes some unassigned amount that has not yet been applied to an invoice.  If this
   # value is true, the field `UnappliedAmount` will be nonzero.
   # @type: boolean
   field :is_open
@@ -64,33 +64,33 @@ end
   # @type: string
   field :memo_text
 
-  # The date when this payment was received.  This typically is the date when an accounting employee recorded
-  # that they received notification that the payment had occurred, whether they were notified by email, postal
+  # The date when this payment was received.  This typically is the date when an accounting employee recorded
+  # that they received notification that the payment had occurred, whether they were notified by email, postal
   # mail, or financial transaction notification.
   # @type: string
   # @format: date
   field :payment_date
 
-  # The date when a payment was posted to a ledger.  This date is often determined by a company's accounting
-  # practices and may be different than the date when the payment was received.  This date may be affected by
+  # The date when a payment was posted to a ledger.  This date is often determined by a company's accounting
+  # practices and may be different than the date when the payment was received.  This date may be affected by
   # issues such as temporary holds on funds transferred, bank holidays, or other actions.
   # @type: string
   # @format: date
   field :post_date
 
-  # Total amount of this payment.
+  # Total amount of this payment in it's received currency.
   # @type: number
   # @format: double
   field :payment_amount
 
-  # Unapplied balance of this payment.  If this amount is nonzero, the field `IsOpen` will be true.
+  # Unapplied balance of this payment in it's received currency.  If this amount is nonzero, the field `IsOpen` will be true.
   # @type: number
   # @format: double
   field :unapplied_amount
 
-  # The ISO 4217 currency code for this payment.
-  #             
-  # For a list of ISO 4217 currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies). This will be validated by the /api/v1/definitions/currencies data set
+  # The ISO 4217 currency code for this payment.
+  #             
+  # For a list of ISO 4217 currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies).
   # @type: string
   field :currency_code
 
@@ -118,9 +118,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
@@ -144,11 +144,15 @@ end
   # @format: double
   field :base_currency_payment_amount
 
-  # Unapplied balance of this payment in the group's base currency. If this amount is nonzero, the field IsOpen will be true.
+  # Unapplied balance of this payment in the group's base currency.  If this amount is nonzero, the field `IsOpen` will be true.
   # @type: number
   # @format: double
   field :base_currency_unapplied_amount
 
+  # The status of this payment within Service Fabric.
+  # "UNAUTHORISED" "PENDING" "PAID" "PAID_OFFLINE" "FAILED" "CANCELLED" "REJECTED" "REFUNDED" "PARTIALLY" "PARTIALLY_REFUNDED"
+  # @type: string
+  field :service_fabric_status
 
   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/payment_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 Payment 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/payment_detail.rb

@@ -43,6 +43,10 @@ end
   # @type: string
   field :email
 
+  # The currency code of the payment.
+  # @type: string
+  field :currency_code
+
   # Total amount of this Payment.
   # @type: number
   # @format: double
@@ -53,6 +57,20 @@ end
   # @format: double
   field :unapplied_amount
 
+  # The base currency code of the group.
+  # @type: string
+  field :base_currency_code
+
+  # The payment amount in the group's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_payment_amount
+
+  # The payment amount in the group's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_unapplied_amount
+
   # The type of payment, AR Payment or AP Payment.
   #             
   # Recognized PaymentType values are:

data/app/platform_api/schema/payment_detail_header.rb

@@ -13,17 +13,21 @@ end
   # @format: uuid
   field :group_key
 
+  # The base currency code of the group.
+  # @type: string
+  field :base_currency_code
+
   # The total number of Customers.
   # @type: integer
   # @format: int32
   field :customer_count
 
-  # The total amount collected.
+  # The total amount collected in the group's base currency.
   # @type: number
   # @format: double
   field :amount_collected
 
-  # The total unapplied amount.
+  # The total unapplied amount in the group's base currency.
   # @type: number
   # @format: double
   field :unapplied_amount

data/app/platform_api/schema/payment_instrument.rb

@@ -0,0 +1,37 @@
+class Schema::PaymentInstrument < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The WPB unique identifier for this instrument.
+  # @type: string
+  field :instrument_id
+
+  # The servicer account that this instrument belongs to.
+  # @type: string
+  field :servicer_account_id
+
+  # Enum: "CHARGEABLE" "PENDING" "CANCELLED" "EXPIRED" "FAILED"
+  # The status of this payment instrument. This should be used in conjunction with
+  # the availableForCharges property to establish the UI state of the instrument.
+  # Some instruments (for example, GoCardless mandates) may be chargeable in a PENDING state, while others may not.
+  field :instrument_status
+
+  # Whether the payment instrument can be used for billing customers.
+  # @type: boolean
+  field :available_for_charges
+
+  # Value: "DIRECT_DEBIT_MANDATE"
+  # The type of this instrument. DIRECT_DEBIT_MANDATE is the only type currently defined.
+  field :instrument_type
+
+  # An optional set of ISO 4217 currency codes that the instrument can accept.
+  # A null or empty value means there is no restriction.
+  # @type: array
+  field :allowed_currencies
+
+
+
+end