lockstep_rails 0.3.22

data/app/platform_api/schema/credit_memo_applied.rb

@@ -0,0 +1,104 @@
+class Schema::CreditMemoApplied < 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 :credit_memo_applied_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 Lockstep ID of the Invoice to which this credit memo was applied.  This Invoice's outstanding balance
+  # was reduced by the value of the field `CreditMemoAppliedAmount` on the date `ApplyToInvoiceDate`.
+  #             
+  # Example: Company ABC received a credit memo, CM000123 for $500.  Company ABC then chooses to apply this
+  # credit memo to reduce the balance of the invoice PO1000578.  The `InvoiceErpKey` is the Lockstep Platform
+  # ID number of Invoice `PO1000578`.
+  # @type: string
+  # @format: uuid
+  field :invoice_id
+
+  # The Lockstep ID of the Invoice of type "Credit Memo" that was consumed in this payment application event.
+  #             
+  # Example: Company ABC received a credit memo, CM000123 for $500.  Company ABC then chooses to apply this
+  # credit memo to reduce the balance of the invoice PO1000578.  The `CreditMemoInvoiceId` is the Lockstep
+  # Platform ID number of Invoice `CM000123`.
+  # @type: string
+  # @format: uuid
+  field :credit_memo_invoice_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
+
+  # Reference number for the applied credit memo.
+  # @type: integer
+  # @format: int32
+  field :entry_number
+
+  # The date on which this credit memo was applied to the Invoice represented by `InvoiceId`.
+  # @type: string
+  # @format: date-time
+  field :apply_to_invoice_date, Types::Params::DateTime
+
+  # The amount of the credit memo that was applied to the Invoice represented by `InvoiceId`.
+  # @type: number
+  # @format: double
+  field :credit_memo_applied_amount
+
+  # Date credit memo applied record was created.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The id of the user who created this applied credit memo.
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # Date credit memo applied record was modified.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The id of the user who modified this applied credit memo.
+  # @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 :attachments, {:class_name=>"Schema::Attachment", :included=>true}
+  has_many :notes, {:class_name=>"Lockstep::Note", :included=>true, :foreign_key=>:object_key, :polymorphic=>{:table_key=>"CreditMemoApplied"}}
+  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/credit_memo_applied_fetch_result.rb

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

data/app/platform_api/schema/credit_memo_applied_sync.rb

@@ -0,0 +1,67 @@
+class Schema::CreditMemoAppliedSync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # 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.
+  #             
+  # Since Credit Memo 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 balanced reduced by applying a credit memo.  In this field,
+  # identify the original primary key or unique ID of the Invoice which had its balanced reduced.
+  #             
+  # Example: Company ABC received a credit memo, CM000123 for $500.  Company ABC then chooses to apply this
+  # credit memo to reduce the balance of the invoice PO1000578.  The `InvoiceErpKey` is `PO1000578`.
+  # @type: string
+  field :invoice_erp_key
+
+  # This field indicates which Invoice is the original credit memo that was used to make this payment
+  # application event.  In this field, identify the original primary key or unique ID of the Invoice which
+  # created the credit memo that was consumed in this event.
+  #             
+  # Example: Company ABC received a credit memo, CM000123 for $500.  Company ABC then chooses to apply this
+  # credit memo to reduce the balance of the invoice PO1000578.  The `CreditMemoInvoiceErpKey` is `CM000123`.
+  # @type: string
+  field :credit_memo_invoice_erp_key
+
+  # Reference number for the applied credit memo.
+  # @type: integer
+  # @format: int32
+  field :entry_number
+
+  # The date on which this credit memo was applied to the Invoice.
+  # @type: string
+  # @format: date-time
+  field :apply_to_invoice_date, Types::Params::DateTime
+
+  # The amount of this credit memo that was applied to this Invoice.
+  # @type: number
+  # @format: double
+  field :credit_memo_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/credit_memo_invoice.rb

@@ -0,0 +1,77 @@
+class Schema::CreditMemoInvoice < 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.
+  # @type: string
+  # @format: uuid
+  field :credit_memo_applied_id
+
+  # The id of the invoice
+  # @type: string
+  # @format: uuid
+  field :invoice_id
+
+  # The id of the credit memo invoice
+  # @type: string
+  # @format: uuid
+  field :credit_memo_invoice_id
+
+  # Date invoice applied to credit memo.
+  # @type: string
+  # @format: date
+  field :apply_to_invoice_date
+
+  # Amount applied to credit memo.
+  # @type: number
+  # @format: double
+  field :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
+  field :reference_code
+
+  # The ID number of the company that created this invoice.
+  # @type: string
+  # @format: uuid
+  field :company_id
+
+  # The ID number of the counterparty for the invoice, for example, a customer or vendor.
+  # @type: string
+  # @format: uuid
+  field :customer_id
+
+  # A code identifying the status of this invoice.
+  # @type: string
+  field :invoice_status_code
+
+  # The total value of this invoice, inclusive of all taxes and line items.
+  # @type: number
+  # @format: double
+  field :total_amount
+
+  # The remaining balance value of this invoice.
+  # @type: number
+  # @format: double
+  field :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"}
+  belongs_to :connection, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"}
+
+
+end

data/app/platform_api/schema/currency.rb

@@ -0,0 +1,31 @@
+class Schema::Currency < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Alphabetic code for the given currency
+  # @type: string
+  field :alpha_code
+
+  # Numeric code for the given currency
+  # @type: string
+  field :numeric_code
+
+  # Name of currency
+  # @type: string
+  field :currency_name
+
+  # Number of places after the decimal for this currency
+  # @type: integer
+  # @format: int32
+  field :minor_unit
+
+  # Symbol for the given currency
+  # @type: string
+  field :symbol
+
+
+
+end

data/app/platform_api/schema/currency_fetch_result.rb

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

data/app/platform_api/schema/currency_rate.rb

@@ -0,0 +1,28 @@
+class Schema::CurrencyRate < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The source currency
+  # @type: string
+  field :source_currency
+
+  # The destination currency
+  # @type: string
+  field :destination_currency
+
+  # The date for the currency rate
+  # @type: string
+  # @format: date
+  field :date
+
+  # The currency rate value
+  # @type: number
+  # @format: double
+  field :currency_rate
+
+
+
+end

data/app/platform_api/schema/custom_attribute_data.rb

@@ -0,0 +1,18 @@
+class Schema::CustomAttributeData < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  
+  field :attribute_type
+
+  
+  field :constructor
+
+
+  has_many :constructor_arguments, {:class_name=>"Schema::CustomAttributeTypedArgument", :included=>true}
+  has_many :named_arguments, {:class_name=>"Schema::CustomAttributeNamedArgument", :included=>true}
+
+end

data/app/platform_api/schema/custom_attribute_named_argument.rb

@@ -0,0 +1,24 @@
+class Schema::CustomAttributeNamedArgument < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  
+  field :member_info
+
+  
+  field :typed_value
+
+  
+  # @type: string
+  field :member_name
+
+  
+  # @type: boolean
+  field :is_field
+
+
+
+end

data/app/platform_api/schema/custom_attribute_typed_argument.rb

@@ -0,0 +1,16 @@
+class Schema::CustomAttributeTypedArgument < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  
+  field :argument_type
+
+  
+  field :value
+
+
+
+end

data/app/platform_api/schema/custom_field_definition.rb

@@ -0,0 +1,76 @@
+class Schema::CustomFieldDefinition < 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.
+  # @type: string
+  # @format: uuid
+  field :custom_field_definition_id
+
+  # Table to which this definition belongs
+  # @type: string
+  field :table_key
+
+  # Id of app this definition belongs to
+  # @type: string
+  # @format: uuid
+  field :app_id
+
+  # Text to display in-application for custom field
+  # @type: string
+  field :custom_field_label
+
+  # Data type of this definition
+  # @type: string
+  field :data_type
+
+  # Used for display logic when multiple custom fields exist
+  # @type: integer
+  # @format: int32
+  field :sort_order
+
+  # Date created
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # Id of user who created this definition
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # Date modified
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # Id of user who modified this definition
+  # @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"}
+
+
+end

data/app/platform_api/schema/custom_field_definition_fetch_result.rb

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

data/app/platform_api/schema/custom_field_sync.rb

@@ -0,0 +1,71 @@
+class Schema::CustomFieldSync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # 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.
+  #             
+  # Custom Fields are identified by the `EntityType` and `ErpKey` values together.
+  #             
+  # Example: You have an invoice whose ID number is 100047878, and you wish to store a custom field on that
+  # invoice named "ApprovalStatusCode".  For the `ErpKey` field, specify the value `100047878`.
+  #             
+  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+  # @type: string
+  field :erp_key
+
+  # Custom Fields are identified by the `EntityType` and `ErpKey` values together.
+  #             
+  # Example: You have an invoice whose ID number is 100047878, and you wish to store a custom field on that
+  # invoice named "ApprovalStatusCode".  For the `EntityType` field, specify the value `Invoice`.
+  #             
+  # Recognized types include:
+  # * `Company` - Link this custom field to a CompanySyncModel
+  # * `Contact` - Link this custom field to a ContactSyncModel
+  # * `Invoice` - Link this custom field to an InvoiceSyncModel
+  # * `InvoiceLine` - Link this custom field to an InvoiceLineSyncModel
+  # * `Payment` - Link this custom field to a PaymentSyncModel
+  # @type: string
+  field :entity_type
+
+  # A label that uniquely identifies this custom field within your software.
+  #             
+  # Example: You have an invoice whose ID number is 100047878, and you wish to store a custom field on that
+  # invoice named "ApprovalStatusCode".  For the `CustomFieldLabel` field, specify the value `ApprovalStatusCode`.
+  # @type: string
+  field :custom_field_label
+
+  # The value of this custom field, if it is stored in string format.
+  # @type: string
+  field :string_value
+
+  # The value of this custom field, if it is stored in numeric format.
+  # @type: number
+  # @format: double
+  field :numeric_value
+
+  # The value of this custom field.
+  # @type: string
+  field :value
+
+  # 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/custom_field_value.rb

@@ -0,0 +1,75 @@
+class Schema::CustomFieldValue < 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.
+  # @type: string
+  # @format: uuid
+  field :custom_field_definition_id
+
+  # Additional key if source table doesn't have a unique id
+  # @type: string
+  # @format: uuid
+  field :record_key
+
+  # String of data for field
+  # @type: string
+  field :string_value
+
+  # Number data for field
+  # @type: number
+  # @format: double
+  field :numeric_value
+
+  # Date created
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # Id of user who created this value
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # Date modified
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # Id of user who modified this value
+  # @type: string
+  # @format: uuid
+  field :modified_user_id
+
+  # The AppEnrollmentId of the application that imported this attachment 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 value of this custom field.
+  # @type: string
+  field :value
+
+  # Definition of the value
+  field :custom_field_definition
+
+  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