lockstep_rails 0.3.22

data/app/platform_api/schema/note.rb

@@ -0,0 +1,72 @@
+class Schema::Note < 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.
+  # @type: string
+  # @format: uuid
+  field :note_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 name of the table the note is associated with
+  # @type: string
+  field :table_key
+
+  # The ID of the object the note is associated with
+  # @type: string
+  # @format: uuid
+  field :object_key
+
+  # The text of the note
+  # @type: string
+  field :note_text
+
+  # The type of the note
+  # @type: string
+  field :note_type
+
+  # Flag indicating if the note has been archived
+  # @type: boolean
+  field :is_archived
+
+  # The date the note was created
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The ID of the user who created the note
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The name of the user who created the note
+  # @type: string
+  field :created_user_name
+
+  # 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
+
+  # The person to whom this note is intended for.
+  # @type: string
+  field :recipient_name
+
+  belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
+
+
+end

data/app/platform_api/schema/note_fetch_result.rb

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

data/app/platform_api/schema/parameter_info.rb

@@ -0,0 +1,64 @@
+class Schema::ParameterInfo < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  
+  field :attributes
+
+  
+  field :member
+
+  
+  # @type: string
+  field :name
+
+  
+  field :parameter_type
+
+  
+  # @type: integer
+  # @format: int32
+  field :position
+
+  
+  # @type: boolean
+  field :is_in
+
+  
+  # @type: boolean
+  field :is_lcid
+
+  
+  # @type: boolean
+  field :is_optional
+
+  
+  # @type: boolean
+  field :is_out
+
+  
+  # @type: boolean
+  field :is_retval
+
+  
+  field :default_value
+
+  
+  field :raw_default_value
+
+  
+  # @type: boolean
+  field :has_default_value
+
+  
+  # @type: integer
+  # @format: int32
+  field :metadata_token
+
+
+  has_many :custom_attributes, {:class_name=>"Schema::CustomAttributeData", :included=>true}
+
+end

data/app/platform_api/schema/payment.rb

@@ -0,0 +1,147 @@
+class Schema::Payment < 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 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 :payment_id
+
+  # The ID of the company to which this payment belongs.
+  # @type: string
+  # @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`.
+  #             
+  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+  # @type: string
+  field :erp_key
+
+  # The type of payment, cash or check.
+  #             
+  # Recognized PaymentType values are:
+  # * `Cash` - A cash payment or other direct transfer.
+  # * `Check` - A check payment.
+  # @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.
+  # @type: string
+  field :tender_type
+
+  # 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
+
+  # Memo or reference text (ex. memo field on a check).
+  # @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
+  # 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
+  # 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.
+  # @type: number
+  # @format: double
+  field :payment_amount
+
+  # Unapplied balance of this payment.  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/currencies data set
+  # @type: string
+  field :currency_code
+
+  # Reference code for the payment for the given Erp system.
+  # @type: string
+  field :reference_code
+
+  # The date on which this record was created.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The ID of the user who created this payment.
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date on which this record was last modified.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The ID of the user who last modified this payment.
+  # @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
+
+  # Is the payment voided?
+  # @type: boolean
+  field :is_voided
+
+  # Is the payment in dispute?
+  # @type: boolean
+  field :in_dispute
+
+  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 :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 :applications, {:class_name=>"Schema::PaymentApplied", :included=>true}
+  has_many :notes, {:class_name=>"Lockstep::Note", :included=>true, :foreign_key=>:object_key, :polymorphic=>{:table_key=>"Payment"}}
+  has_many :attachments, {:class_name=>"Schema::Attachment", :included=>true}
+  has_many :custom_field_definitions, {:class_name=>"Schema::CustomFieldDefinition", :included=>true}
+  has_many :custom_field_values, {:class_name=>"Schema::CustomFieldValue", :included=>true}
+
+end

data/app/platform_api/schema/payment_applied.rb

@@ -0,0 +1,95 @@
+class Schema::PaymentApplied < 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 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 :payment_applied_id
+
+  # The Invoice this payment is applied to.
+  # @type: string
+  # @format: uuid
+  field :invoice_id
+
+  # The Payment applied to the invoice.
+  # @type: string
+  # @format: uuid
+  field :payment_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`.
+  #             
+  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+  # @type: string
+  field :erp_key
+
+  # The entry number of this payment application.  This is often a journal entry number, confirmation code,
+  # or other identifying field for this payment application.
+  # @type: integer
+  # @format: int32
+  field :entry_number
+
+  # The date this payment was applied to this invoice.
+  # @type: string
+  # @format: date-time
+  field :apply_to_invoice_date, Types::Params::DateTime
+
+  # The total amount that was applied to this Invoice from the Payment.
+  # @type: number
+  # @format: double
+  field :payment_applied_amount
+
+  # Date payment applied record was created.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The id of the user who created this applied payment.
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # Date payment applied record was modified.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The id of the user who modified this applied payment.
+  # @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
+
+  # The invoice associated with this applied payment.
+  field :invoice
+
+  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"}
+
+
+end

data/app/platform_api/schema/payment_applied_fetch_result.rb

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

data/app/platform_api/schema/payment_applied_sync.rb

@@ -0,0 +1,74 @@
+class Schema::PaymentAppliedSync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # 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.
+  #             
+  # Since Payment Applications are often considered transactions, a typical value to look for will be
+  # the transaction ID number, the payment confirmation number, or some other record of this payment.
+  #             
+  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+  # @type: string
+  field :erp_key
+
+  # This field indicates which Invoice had its balance reduced by applying this payment.  In this field,
+  # identify the original primary key or unique ID of the Invoice which had its balance reduced.
+  #             
+  # This information lets you track how an invoice was paid. You can identify what proportion of an invoice's
+  # balance was paid by which methods by joining this field to Invoices.
+  #             
+  # 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
+
+  # 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 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.
+  #             
+  # 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 :payment_erp_key
+
+  # The entry number of this payment application.  This is often a journal entry number, confirmation code,
+  # or other identifying field for this payment application.
+  # @type: integer
+  # @format: int32
+  field :entry_number
+
+  # The date this payment was applied to this invoice.
+  # @type: string
+  # @format: date-time
+  field :apply_to_invoice_date, Types::Params::DateTime
+
+  # The total amount that was applied to this Invoice from the Payment.
+  # @type: number
+  # @format: double
+  field :payment_applied_amount
+
+  # 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/payment_detail.rb

@@ -0,0 +1,110 @@
+class Schema::PaymentDetail < 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 ID of this Payment.
+  # @type: string
+  # @format: uuid
+  field :payment_id
+
+  # The ID of the customer to which this Payment belongs.
+  # @type: string
+  # @format: uuid
+  field :customer_id
+
+  # The name of the customer to which this Payment belongs.
+  # @type: string
+  field :customer_name
+
+  # Memo or reference text (ex. memo field on a check).
+  # @type: string
+  field :memo_text
+
+  # Reference code for the payment for the given Erp system.
+  # @type: string
+  field :reference_code
+
+  # The name of the Primary Contact for the Customer.
+  # @type: string
+  field :primary_contact
+
+  # The Email address of the Customer.
+  # @type: string
+  field :email
+
+  # Total amount of this Payment.
+  # @type: number
+  # @format: double
+  field :payment_amount
+
+  # Unapplied balance of this Payment.
+  # @type: number
+  # @format: double
+  field :unapplied_amount
+
+  # The type of payment, Payment or AP Payment.
+  # @type: string
+  field :payment_type
+
+  # The date of this Payment.
+  # @type: string
+  # @format: date
+  field :payment_date
+
+  # Payment post date.
+  # @type: string
+  # @format: date
+  field :post_date
+
+  # The phone number of the Customer's Primary Contact.
+  # @type: string
+  field :phone
+
+  # The fax number of the Customer's Primary Contact.
+  # @type: string
+  field :fax
+
+  # The first line of the address for the Customer's Primary Contact.
+  # @type: string
+  field :address1
+
+  # The second line of the address for the Customer's Primary Contact.
+  # @type: string
+  field :address2
+
+  # The third line of the address for the Customer's Primary Contact.
+  # @type: string
+  field :address3
+
+  # The city of the address for the Customer's Primary Contact.
+  # @type: string
+  field :city
+
+  # The state/region of the address for the Customer's Primary Contact.
+  # @type: string
+  field :state_region
+
+  # The postal/zip code of the address for the Customer's Primary Contact.
+  # @type: string
+  field :postal_code
+
+  # The 2 character country code of the address for the Customer's Primary Contact.
+  # @type: string
+  field :country_code
+
+  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/payment_detail_fetch_result.rb

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

data/app/platform_api/schema/payment_detail_header.rb

@@ -0,0 +1,43 @@
+class Schema::PaymentDetailHeader < 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 total number of Customers.
+  # @type: integer
+  # @format: int32
+  field :customer_count
+
+  # The total amount collected.
+  # @type: number
+  # @format: double
+  field :amount_collected
+
+  # The total unapplied amount.
+  # @type: number
+  # @format: double
+  field :unapplied_amount
+
+  # The number of paid invoices.
+  # @type: integer
+  # @format: int32
+  field :paid_invoice_count
+
+  # The number of open invoices.
+  # @type: integer
+  # @format: int32
+  field :open_invoice_count
+
+
+
+end