lockstep_rails 0.3.22

data/app/platform_api/schema/invoice_line.rb

@@ -0,0 +1,142 @@
+class Schema::InvoiceLine < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # 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
+  field :invoice_line_id
+
+  # 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 ID number of the invoice this line belongs to.
+  # @type: string
+  # @format: uuid
+  field :invoice_id
+
+  # The unique ID of this record as it was known in its originating financial system, if it was
+  # different from the original `LineNumber`.
+  #             
+  # 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 line number of this line, as defined in the originating ERP or accounting system.  You can sort on this number to
+  # get the original view of lines within the invoice.
+  # @type: string
+  field :line_number
+
+  # A code number identifying the product or service that is specified on this line.
+  # @type: string
+  field :product_code
+
+  # Description of this invoice line.
+  # @type: string
+  field :description
+
+  # 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
+  field :unit_measure_code
+
+  # The price of a single unit for this line.
+  # @type: number
+  # @format: double
+  field :unit_price
+
+  # The quantity of items for ths line.
+  # @type: number
+  # @format: double
+  field :quantity
+
+  # The number of items that have been shipped.
+  # @type: number
+  # @format: double
+  field :quantity_shipped
+
+  # The number of items that has been received.
+  # @type: number
+  # @format: double
+  field :quantity_received
+
+  # The total amount for this line.
+  # @type: number
+  # @format: double
+  field :total_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
+  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
+  field :created, Types::Params::DateTime
+
+  # The ID number of the user who created this line.
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date on which this line was last modified.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The ID number of the user who most recently modified this line.
+  # @type: string
+  # @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
+  # was not loaded from an external ERP or financial system.
+  # @type: string
+  # @format: uuid
+  field :app_enrollment_id
+
+  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 :notes, {:class_name=>"Lockstep::Note", :included=>true, :foreign_key=>:object_key, :polymorphic=>{:table_key=>"InvoiceLine"}}
+  has_many :attachments, {:class_name=>"Schema::Attachment", :included=>true}
+
+end

data/app/platform_api/schema/invoice_line_sync.rb

@@ -0,0 +1,208 @@
+class Schema::InvoiceLineSync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # 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.
+  #             
+  # Example: If you store your invoice line records in a database, whatever the primary key for the invoice
+  # line 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 :erp_key
+
+  # The original primary key or unique ID of the invoice to which this line belongs.  This value should
+  # match the [Invoice ErpKey](https://developer.lockstep.io/docs/importing-invoices#erpkey) field on the
+  # [InvoiceSyncModel](https://developer.lockstep.io/docs/importing-invoices).
+  # @type: string
+  field :invoice_erp_key
+
+  # The line number of this line, as defined in the originating ERP or accounting system.  You can sort on this number to
+  # get the original view of lines within the invoice.
+  # @type: string
+  field :line_number
+
+  # A code number identifying the product or service that is specified on this line.
+  # @type: string
+  field :product_code
+
+  # Description of this invoice line.
+  # @type: string
+  field :description
+
+  # 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
+  field :unit_measure_code
+
+  # The price of a single unit for this line.
+  # @type: number
+  # @format: double
+  field :unit_price
+
+  # The quantity of items for ths line.
+  # @type: number
+  # @format: double
+  field :quantity
+
+  # The number of items that have been shipped.
+  # @type: number
+  # @format: double
+  field :quantity_shipped
+
+  # The number of items that has been received.
+  # @type: number
+  # @format: double
+  field :quantity_received
+
+  # The total amount for this line.
+  # @type: number
+  # @format: double
+  field :total_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 This will be validated by the /api/v1/countries data set
+  # @type: string
+  field :origin_address_country
+
+  # Origination address for this invoice line, if this line item was originated from a different address
+  # @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 This will be validated by the /api/v1/countries data set
+  # @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
+
+  # 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_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
+
+  # Shipping address for this invoice line, if this line item is to be shipped to a different address
+  # @type: string
+  field :ship_to_address_region
+
+  # Shipping address for this invoice line, if this line item is to be shipped to a different address
+  # @type: string
+  field :ship_to_address_postal_code
+
+  # Shipping address for this invoice line, if this line item is to be shipped to a different address This will be validated by the /api/v1/countries data set
+  # @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
+
+  # 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
+  # created-date, leave this field null.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # If known, the date when this record was most recently modified according to the originating
+  # financial system in which this record is maintained.  If the originating financial system does
+  # not maintain a most-recently-modified-date, leave this field null.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+
+
+end

data/app/platform_api/schema/invoice_payment_detail.rb

@@ -0,0 +1,65 @@
+class Schema::InvoicePaymentDetail < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+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.
+  # 
+  # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
+  # @type: string
+  # @format: uuid
+  field :group_key
+
+  # The unique identifier of this PaymentApplied record.
+  # @type: string
+  # @format: uuid
+  field :payment_applied_id
+
+  # The database id of the invoice
+  # @type: string
+  # @format: uuid
+  field :invoice_id
+
+  # The database id of the Payment.
+  # @type: string
+  # @format: uuid
+  field :payment_id
+
+  # Date Payment applied to Invoice.
+  # @type: string
+  # @format: date
+  field :apply_to_invoice_date
+
+  # Amount applied to Invoice.
+  # @type: number
+  # @format: double
+  field :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
+  field :reference_code
+
+  # The ID number of the Company (CompanyType = "Customer") that created this Payment.
+  # @type: string
+  # @format: uuid
+  field :company_id
+
+  # The total value of this Payment.
+  # @type: number
+  # @format: double
+  field :payment_amount
+
+  # The remaining balance value of this Payment.
+  # @type: number
+  # @format: double
+  field :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"}
+
+
+end

data/app/platform_api/schema/invoice_summary.rb

@@ -0,0 +1,85 @@
+class Schema::InvoiceSummary < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+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.
+  # 
+  # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
+  # @type: string
+  # @format: uuid
+  field :group_key
+
+  # The ID number of the counterparty for the invoice, for example, a customer or vendor.
+  # @type: string
+  # @format: uuid
+  field :customer_id
+
+  # The unique ID number of this invoice.
+  # @type: string
+  # @format: uuid
+  field :invoice_id
+
+  # 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
+
+  # The reporting date for this invoice.
+  # @type: string
+  # @format: date
+  field :invoice_date
+
+  # The name of the counterparty for the invoice, for example, a customer or vendor.
+  # @type: string
+  field :customer_name
+
+  # The status of the invoice.
+  # @type: string
+  field :status
+
+  # The due date of the invoice.
+  # @type: string
+  # @format: date
+  field :payment_due_date
+
+  # The total amount of the Invoice.
+  # @type: number
+  # @format: double
+  field :invoice_amount
+
+  # The remaining balance value of this invoice.
+  # @type: number
+  # @format: double
+  field :outstanding_balance
+
+  # A code identifying the type of this Invoice.
+  # @type: string
+  field :invoice_type_code
+
+  # The date stamp for the newest Activity on this Invoice.
+  # @type: string
+  # @format: date
+  field :newest_activity
+
+  # The number of days this Invoice is past due.
+  # @type: integer
+  # @format: int32
+  field :days_past_due
+
+  # The memo text of the payments associated to this invoice.
+  # @type: array
+  field :payment_numbers
+
+  # The ids of the payments associated to this invoice.
+  # @type: array
+  field :payment_ids
+
+  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/invoice_summary_fetch_result.rb

@@ -0,0 +1,26 @@
+class Schema::InvoiceSummaryFetchResult < 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::InvoiceSummary", :included=>true}
+
+end