lockstep_rails 0.3.52 → 0.3.53

data/app/platform_api/schema/payment_response.rb

@@ -0,0 +1,118 @@
+class Schema::PaymentResponse < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique identifier of the payment.
+  # @type: string
+  field :payment_id
+
+  # Date the orginal request was created in ISO 8601 date format.
+  # @type: string
+  # @format: date-time
+  field :create_date_time, Types::Params::DateTime
+
+  # The payment status
+  # Values: "UNAUTHORISED" "PENDING" "PAID" "PAID_OFFLINE" "FAILED" "CANCELLED" "REJECTED" "REFUNDED" "PARTIALLY" "PARTIALLY_REFUNDED"
+  # @type: string
+  field :status
+
+  # A boolean field indicating whether the payment is in a state that can be cancelled.
+  # All PENDING payments can be cancelled, but other statuses are provider-dependent.
+  # @type: boolean
+  field :cancellable
+
+  # Date the request was last updated in ISO 8601 date format.
+  # @type: string
+  # @format: date-time
+  field :update_date_time, Types::Params::DateTime
+
+  # The date when the real-world payment request was initiated
+  # (for example, date upon which an invoice was created), ISO-8601 format.
+  # If before 1st January, 1970, initiatedDateTime will be set to null.
+  # @type: string
+  # @format: date-time
+  field :initiated_date_time, Types::Params::DateTime
+
+  # Date the payment is due in ISO 8601 date format. If before 1st January, 1970, dueDate will be set to null.
+  # @type: string
+  # @format: date-time
+  field :due_date, Types::Params::DateTime
+
+  # The method that was used to pay an invoice outside of Payments Acceptance.
+  # Values: "CASH" "CHEQUE" "DIRECT_CREDIT" "DIRECT_DEBIT" "CARD" "VOUCHER" "CREDIT_NOTE" "UNKNOWN" "OTHER"
+  # @type: string
+  field :offline_method
+
+  # A free text field for describing offline payment methods not covered by the offlineMethod property.
+  # Should only be used with the OTHER offline method.
+  # @type: string
+  field :other_offline_method
+
+  # Unique identifier assigned by the payment initiator to unambiguously identify the payment.
+  # The identifier is passed on, unchanged, throughout the entire end-to-end chain.
+  # @type: string
+  field :end_to_end_identifier
+
+  # An object that represents an amount of money in a specific currency.
+  field :instructed_amount
+
+  # The fee levied by the payment provider for the payment, in minor units of the invoice currency.
+  # This will only be available for paid or partially paid invoices.
+  # Not all providers will be able to provide fee information, so this field may be null even for paid invoices.
+  # Where provided, this field will be non-negative.
+  # @type: integer
+  # @format: int32
+  field :fee
+
+  # Net amount and fees as converted into servicer account currency.
+  field :reporting_amount
+
+  # Amount of the payment that has been paid until now.
+  # @type: integer
+  # @format: int32
+  field :paid_to_date
+
+  # Amount of the payment still outstanding (excluding fees/charges). Maximum value is instructed amount.
+  # @type: string
+  field :outstanding_amount
+
+  # Amount of the payment that has been refunded. Maximum value is instructed amount.
+  # @type: string
+  field :refunded_amount
+
+  # Array of payment methods which the debtor can choose from in order to pay.
+  # Primarily used to populate the PayNow options page (for example, card, PayPal, ACH).
+  # @type: array
+  field :debtor_payment_methods
+
+  # Details about the creditor requesting the payment.
+  field :creditor_account
+
+  # The details about the debtor receiving the payment request.
+  field :debtor_account
+
+  # Information supplied to enable the matching of an entry with the items that the transfer is intended to settle,
+  # such as a commercial invoice.
+  field :remittance_information
+
+  # Information related to the risk of the payment.
+  field :risk
+
+  # Base64 encoded strings that when decoded, can be added to html emails to provider markup in supported email clients.
+  field :metadata
+
+  # Flag of whether this is a partial payment
+  # @type: boolean
+  field :partial_payment
+
+  # The type of the payment.
+  # Values: "INVOICE" "STATEMENT" "PAY_ON_ACCOUNT"
+  # @type: string
+  field :type
+
+
+
+end

data/app/platform_api/schema/payment_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
@@ -39,6 +39,10 @@ end
   # @format: date
   field :payment_date
 
+  # The currency code of the payment.
+  # @type: string
+  field :currency_code
+
   # Total amount of this payment.
   # @type: number
   # @format: double
@@ -49,7 +53,21 @@ end
   # @format: double
   field :unapplied_amount
 
-  # True if this payment includes some unassigned amount that has not yet been applied to an invoice.  If this
+  # 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 unapplied amount in the group's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_unapplied_amount
+
+  # 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
@@ -81,7 +99,7 @@ end
   # @type: string
   field :payment_company_name
 
-  # Specific payments have support for pdf retrieval from their respective erp. When this flag is true, an additional
+  # Specific payments have support for pdf retrieval from their respective erp. When this flag is true, an additional
   # call to Payments/{id}/pdf can be made to retrieve a pdf directly from the erp.
   # @type: boolean
   field :supports_erp_pdf_retrieval
@@ -102,24 +120,6 @@ end
   # @type: array
   field :company_names
 
-  # The group's currency code.
-  # @type: string
-  field :currency_code
-
-  # 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 unapplied amount in the group's base currency.
-  # @type: number
-  # @format: double
-  field :base_currency_unapplied_amount
-
   # The modified date of the payment
   # @type: string
   # @format: date-time

data/app/platform_api/schema/payment_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 record. For this field, you should use whatever the payment's unique
   # identifying number is in the originating system. Search for a unique, non-changing number within the
   # originating financial system for this record.
@@ -64,12 +67,12 @@ end
   # @format: date-time
   field :post_date, Types::Params::DateTime
 
-  # Total amount of this payment.
+  # Total amount of this payment in the payment's 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 the payment's currency.  If this amount is nonzero, the field `IsOpen` will be true.
   # @type: number
   # @format: double
   field :unapplied_amount
@@ -113,6 +116,16 @@ end
   # @format: double
   field :currency_rate
 
+  # Total amount of this payment in the erp's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_payment_amount
+
+  # Unapplied balance of this payment in the erp's base currency.  If this amount is nonzero, the field `IsOpen` will be true.
+  # @type: number
+  # @format: double
+  field :base_currency_unapplied_amount
+
 
 
 end

data/app/platform_api/schema/remittance_information.rb

@@ -0,0 +1,18 @@
+class Schema::RemittanceInformation < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Reference, assigned by the creditor, to unambiguously refer to the payment transaction. For example, Invoice ID.
+  # @type: string
+  field :reference
+
+  # Unstructured text, describes the invoice.
+  # @type: string
+  field :description
+
+
+
+end

data/app/platform_api/schema/reporting_amount.rb

@@ -0,0 +1,30 @@
+class Schema::ReportingAmount < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Amount of the payment.
+  field :amount
+
+  # The currency ISO-4217 code.
+  # @type: string
+  field :currency
+
+  # Rate used to convert instructedAmount to reportingAmount.
+  # @type: number
+  # @format: double
+  field :conversion_rate
+
+  # Reporting Date.
+  # @type: string
+  field :date_time
+
+  # Date the funds will be made available.
+  # @type: string
+  field :funds_available_date_time
+
+
+
+end

data/app/platform_api/schema/risk_information.rb

@@ -0,0 +1,22 @@
+class Schema::RiskInformation < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Enum: "person-to-person" "e-commerce-goods" "e-commerce-services" "bill-payment" "other"
+  # Payment Context Code.
+  # @type: string
+  field :payment_context_code
+
+  # Category code confirming to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
+  # @type: string
+  field :merchant_category_code
+
+  # Address of a Company, Provider or Customer
+  field :delivery_address
+
+
+
+end

data/app/platform_api/schema/risk_rate.rb

@@ -13,6 +13,10 @@ end
   # @format: uuid
   field :group_key
 
+  # The base currency code of the group.
+  # @type: string
+  field :base_currency_code
+
   # The month the risk rate was calculated for
   # @type: string
   # @format: date-time
@@ -32,7 +36,7 @@ end
   # @format: int32
   field :total_invoice_count
 
-  # The sum of the total amount for invoices in the calculation month
+  # The sum of the total amount for invoices in the calculation month in the group's base currency.
   # @type: number
   # @format: double
   field :total_invoice_amount
@@ -42,7 +46,7 @@ end
   # @format: int32
   field :at_risk_count
 
-  # The sum of the outstanding balance of open invoices over 90 days from the calculation month
+  # The sum of the outstanding balance of open invoices over 90 days from the calculation month in the group's base currency.
   # @type: number
   # @format: double
   field :at_risk_amount

data/app/platform_api/schema/settlement_discount.rb

@@ -0,0 +1,25 @@
+class Schema::SettlementDiscount < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The absolute amount to be discounted if this discount is applied. Not required if discountPercentage is provided.
+  # @type: number
+  # @format: double
+  field :discount_amount
+
+  # The relative amount to be discounted if this discount is applied. Not required if discountAmount is provided.
+  # @type: number
+  # @format: double
+  field :discount_percentage
+
+  # The date until the discount is valid.
+  # @type: string
+  # @format: date-time
+  field :until_date_time, Types::Params::DateTime
+
+
+
+end

data/app/platform_api/schema/settlement_discounts_info.rb

@@ -0,0 +1,21 @@
+class Schema::SettlementDiscountsInfo < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Value: "beforeTax"
+  # How taxes are calculated.
+  # @type: string
+  field :discount_scheme
+
+  # Tax amount being paid in this payment.
+  # @type: number
+  # @format: double
+  field :tax_amount
+
+
+  has_many :settlement_discounts, {:class_name=>"Schema::SettlementDiscount", :included=>true}
+
+end

data/app/platform_api/schema/sf_account_response.rb

@@ -0,0 +1,66 @@
+class Schema::SfAccountResponse < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique identifier for account.
+  # @type: string
+  field :account_id
+
+  # The unique identifier for company.
+  # @type: string
+  field :company_id
+
+  # The unique identifier for servicer.
+  # @type: string
+  field :servicer_id
+
+  # Servicer name for the given connected account.
+  # @type: string
+  field :servicer_name
+
+  # User name of the account (typically an email address).
+  # @type: string
+  field :account_username
+
+  # ISO 4217 currency code.
+  # @type: string
+  field :currency
+
+  # Nickname of the account assigned by the account owner.
+  # @type: string
+  field :nickname
+
+  # Enum: "PENDING" "ACTIVE" "CANCELLED" "AUTH_REQUIRED" "AWAITING_VERIFICATION"
+  # @type: string
+  field :status
+
+  # Enum: "SYNC_IN_PROGRESS" "SYNC_COMPLETE"
+  # If the account supports synchronisation, for example, it is a GoCardless account and supports importing mandates,
+  # then this field may be set to one of the two below.
+  # @type: string
+  field :sync_status
+
+  # Whether the connected account is enabled or not.
+  # @type: boolean
+  field :is_enabled
+
+  # API key for the given connected account.
+  # @type: string
+  field :publishable_key
+
+  # Items Enum: "card" "direct-debit"
+  # An array of payment types supported by the provider in the company's country.
+  # @type: array
+  field :capabilities
+
+  # Optional information that can be used to complete account activation at the servicer.
+  field :authorisation
+
+  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/sf_company_request.rb

@@ -0,0 +1,38 @@
+class Schema::SfCompanyRequest < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Name for the company.
+  # @type: string
+  field :name
+
+  # Unique external ID of the company.
+  # @type: string
+  field :external_id
+
+  # Company tax number. The value you should use as a company tax number depends on your country.
+  # @type: string
+  field :tax_number
+
+  # Standard Industrial Classification (SIC) code for the company.
+  # @type: string
+  field :standard_industrial_code
+
+  # Contact telephone number of the company.
+  # @type: string
+  field :contact_tel_no
+
+  # Contact email of the company.
+  # @type: string
+  # @format: email
+  field :contact_email
+
+  # Postal address.
+  field :address
+
+
+
+end

data/app/platform_api/schema/sf_company_response.rb

@@ -0,0 +1,51 @@
+class Schema::SfCompanyResponse < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Unique ID of the company.
+  # @type: string
+  field :company_id
+
+  # Unique ID of the organisation to which the company belongs.
+  # @type: string
+  field :organisation_id
+
+  # Name for the company.
+  # @type: string
+  field :name
+
+  # Access URL for the company logo image, if a logo image has been uploaded.
+  # @type: string
+  field :logo_url
+
+  # Postal address.
+  field :address
+
+  # Company tax number. The value you should use as a company tax number depends on your country.
+  # @type: string
+  field :tax_number
+
+  # Standard Industrial Classification (SIC) code for the company.
+  # @type: string
+  field :standard_industrial_code
+
+  # Unique external ID of the company.
+  # @type: string
+  field :external_id
+
+  # Contact telephone number of the company.
+  # @type: string
+  field :contact_tel_no
+
+  # Contact email of the company.
+  # @type: string
+  field :contact_email
+
+  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/sf_customer_request.rb

@@ -0,0 +1,52 @@
+class Schema::SfCustomerRequest < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The external identifier of this customer.
+  # @type: string
+  field :external_id
+
+  # Country (based on 3-char ISO/DI-3166 country code)
+  # @type: string
+  field :country
+
+  # Currency of the customer account as an ISO 4217 currency code.
+  # @type: string
+  field :currency
+
+  # The first name of the customer.
+  # @type: string
+  field :first_name
+
+  # The last name of the customer.
+  # @type: string
+  field :last_name
+
+  # The name of the company if this customer is a company.
+  # @type: string
+  field :company_name
+
+  # The email address of the customer. If an empty string, this will be mapped to null.
+  # @type: string
+  # @format: email
+  field :email_address
+
+  # The telephone number of the customer.
+  # @type: string
+  field :contact_tel_no
+
+  # The tax number for the customer; this may be a VAT number for a company,
+  # or some other form of ID number for an individual.
+  # @type: string
+  field :tax_number
+
+  # Address of a Company, Provider or Customer.
+  # All fields are optional; without address line 1, city or country some operations may not be supported.
+  field :address
+
+
+
+end

data/app/platform_api/schema/sf_customer_response.rb

@@ -0,0 +1,84 @@
+class Schema::SfCustomerResponse < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique identifier of the customer.
+  # @type: string
+  field :customer_id
+
+  # The identifier of the company that this customer is a customer of.
+  # @type: string
+  field :company_id
+
+  # The external identifier of this customer.
+  # @type: string
+  field :external_id
+
+  # Enum: "ACTIVE" "DELETED" "NOT_ASSIGNED" "DELETED_MANUAL_MERGE"
+  # The status of the customer.
+  # @type: string
+  field :status
+
+  # Status if the customer is automatched with provider.
+  # @type: boolean
+  field :auto_matched
+
+  # Country (based on 3-char ISO/DI-3166 country code)
+  # @type: string
+  field :primary_country
+
+  # Currency of the customer account as an ISO 4217 currency code.
+  # @type: string
+  field :currency
+
+  # The first name of the customer.
+  # @type: string
+  field :first_name
+
+  # The last name of the customer.
+  # @type: string
+  field :last_name
+
+  # The name of the company if this customer is a company.
+  # @type: string
+  field :company_name
+
+  # The email address of the customer.
+  # @type: string
+  field :email_address
+
+  # The telephone number of the customer.
+  # @type: string
+  field :contact_tel_no
+
+  # The tax number for the customer. This may be a VAT number for a company,
+  # or some other form of ID number for an individual.
+  # @type: string
+  field :tax_number
+
+  # Date the customer record was created. ISO 8601 date format.
+  # @type: string
+  # @format: date-time
+  field :created_date_time, Types::Params::DateTime
+
+  # Date the customer was last updated. ISO 8601 date format.
+  # Customers may be updated by WPB or external servicers.
+  # @type: string
+  # @format: date-time
+  field :updated_date_time, Types::Params::DateTime
+
+  # Address of a Company, Provider or Customer. All fields are optional;
+  # without address line 1, city or country some operations may not be supported.
+  field :address
+
+  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"}
+  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"}
+
+  has_many :payment_instruments, {:class_name=>"Schema::PaymentInstrument", :included=>true}
+
+end