lockstep_rails 0.3.22

data/app/platform_api/schema/at_risk_invoice_summary.rb

@@ -0,0 +1,90 @@
+class Schema::AtRiskInvoiceSummary < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The date of the report
+  # @type: string
+  # @format: date
+  field :report_date
+
+  # 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/at_risk_invoice_summary_fetch_result.rb

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

data/app/platform_api/schema/attachment.rb

@@ -0,0 +1,92 @@
+class Schema::Attachment < 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 :attachment_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 attachment is associated with
+  # @type: string
+  field :table_key
+
+  # The ID of the object the attachment is associated with
+  # @type: string
+  # @format: uuid
+  field :object_key
+
+  # Name of the file
+  # @type: string
+  field :file_name
+
+  # Extension type of the file
+  # @type: string
+  field :file_ext
+
+  # Corresponding AttachmentType object to describe this attachment
+  # @type: string
+  # @format: uuid
+  field :attachment_type_id
+
+  # Flag indicating the attachment was archived
+  # @type: boolean
+  field :is_archived
+
+  # Tracks the original record for this attachment, not currently used.
+  # @type: string
+  # @format: uuid
+  field :origin_attachment_id
+
+  # Flag for if LS clients can see this file
+  # @type: boolean
+  field :view_internal
+
+  # Flag for if Vendors and customers can see this file
+  # @type: boolean
+  field :view_external
+
+  # 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 from a financial system, this value will be `null`.
+  #             
+  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+  # @type: string
+  field :erp_key
+
+  # 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 date the attachment was created
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # Id of the user who made the file
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
+
+
+end

data/app/platform_api/schema/attachment_fetch_result.rb

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

data/app/platform_api/schema/attachment_header_info.rb

@@ -0,0 +1,41 @@
+class Schema::AttachmentHeaderInfo < 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 CompanyId associated with the attachment status report. Providing a null value will
+  # return an attachment summary for all attachments associated to the provided GroupKey
+  # @type: string
+  # @format: uuid
+  field :company_id
+
+  # The total number of attachments associated with the provided GroupKey and CompanyId.
+  # @type: integer
+  # @format: int32
+  field :total_attachments
+
+  # The total number of archived attachments associated with the provided GroupKey and CompanyId.
+  # @type: integer
+  # @format: int32
+  field :total_archived
+
+  # The total number of active attachments associated with the provided GroupKey and CompanyId.
+  # @type: integer
+  # @format: int32
+  field :total_active
+
+  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/batch_sync.rb

@@ -0,0 +1,18 @@
+class Schema::BatchSync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+
+  has_many :companies, {:class_name=>"Schema::CompanySync", :included=>true}
+  has_many :contacts, {:class_name=>"Schema::ContactSync", :included=>true}
+  has_many :credit_memo_applications, {:class_name=>"Schema::CreditMemoAppliedSync", :included=>true}
+  has_many :invoices, {:class_name=>"Schema::InvoiceSync", :included=>true}
+  has_many :invoice_lines, {:class_name=>"Schema::InvoiceLineSync", :included=>true}
+  has_many :custom_fields, {:class_name=>"Schema::CustomFieldSync", :included=>true}
+  has_many :payments, {:class_name=>"Schema::PaymentSync", :included=>true}
+  has_many :payment_applications, {:class_name=>"Schema::PaymentAppliedSync", :included=>true}
+
+end

data/app/platform_api/schema/bulk_currency_conversion.rb

@@ -0,0 +1,19 @@
+class Schema::BulkCurrencyConversion < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The date for the currency rate
+  # @type: string
+  # @format: date
+  field :date
+
+  # The currency code This will be validated by the /api/v1/currencies data set
+  # @type: string
+  field :source_currency
+
+
+
+end

data/app/platform_api/schema/cashflow_report.rb

@@ -0,0 +1,35 @@
+class Schema::CashflowReport < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Timeframe in days the cashflow report is generated on
+  # @type: integer
+  # @format: int32
+  field :timeframe
+
+  # Amount of payments collected based in the timeframe
+  # @type: number
+  # @format: double
+  field :payments_collected
+
+  # Number of payments collected based in the timeframe
+  # @type: integer
+  # @format: int32
+  field :payments_collected_count
+
+  # Amount of invoices billed based in the timeframe
+  # @type: number
+  # @format: double
+  field :invoices_billed
+
+  # Number of invoices billed in the timeframe
+  # @type: integer
+  # @format: int32
+  field :invoices_billed_count
+
+
+
+end

data/app/platform_api/schema/code_definition.rb

@@ -0,0 +1,58 @@
+class Schema::CodeDefinition < 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 :code_definition_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 type of the Code Definition
+  # @type: string
+  field :code_type
+
+  # The Code to be defined.
+  # @type: string
+  field :code
+
+  # The definition of the Code
+  # @type: string
+  field :code_description
+
+  # The date that the Code Definition was created
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The ID of the user who created the Code Definition
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date the Code Definition was last modified
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The ID of the user who last modified the Code Definition
+  # @type: string
+  # @format: uuid
+  field :modified_user_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/code_definition_fetch_result.rb

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

data/app/platform_api/schema/company.rb

@@ -0,0 +1,243 @@
+class Schema::Company < 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 :company_id
+
+  # The short name of the company.
+  # @type: string
+  field :company_name
+
+  # 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
+
+  # This field indicates the type of company.  It can be one of a limited number of values:
+  # Company, Customer, Group, Vendor, or Third Party.  A company that represents both a customer and a vendor
+  # is identified as a CustomerVendor.
+  #             
+  # * `Company` - This record represents a company that is part of the organization of the account holder.
+  # * `Customer` - This record represents a business entity that purchases things from the account holder.
+  # * `Group` - Only one record of type `GROUP` exists in each account.  Contains your account profile.
+  # * `Vendor` - This record represents a business entity that sells things to the account holder.
+  # * `Third Party` - This record represents a business entity that is neither a customer nor vendor.
+  # * `CustomerVendor` - Both a customer and a vendor.
+  # @type: string
+  field :company_type
+
+  # The status of the company.  Companies can be either `Active` or `Inactive`.  When matched to a
+  # Lockstep corporate profile, this value will change to reflect that this record will be kept
+  # in sync with that company's identity.
+  # @type: string
+  field :company_status
+
+  # If this business entity is part of an organization, this value is non-null and it is set
+  # to the `CompanyId` value of the parent company of this business entity.
+  #             
+  # If this value is null, this business entity is a standalone.
+  # @type: string
+  # @format: uuid
+  field :parent_company_id
+
+  # For convenience, this field indicates the top-level parent company.  This can be used
+  # to jump directly to the top parent in complex organizational hierarchies.
+  # @type: string
+  # @format: uuid
+  field :enterprise_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
+
+  # This flag indicates whether the company is currently active.  An inactive company
+  # should be hidden from the user interface but will still be available for querying.
+  # @type: boolean
+  field :is_active
+
+  # The default currency code used by this business entity.  This value can be overridden
+  # for invoices in a different currency code.
+  #             
+  # For a list of defined currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies)
+  # @type: string
+  field :default_currency_code
+
+  # The URL of this company's logo, if known.
+  # @type: string
+  field :company_logo_url
+
+  # The Lockstep `ContactId` of the primary contact for this company.
+  # @type: string
+  # @format: uuid
+  field :primary_contact_id
+
+  # Address info
+  # @type: string
+  field :address1
+
+  # Address info
+  # @type: string
+  field :address2
+
+  # Address info
+  # @type: string
+  field :address3
+
+  # Corporate Address info
+  # @type: string
+  field :corp_city
+
+  # Corporate Address info
+  # @type: string
+  field :corp_state
+
+  # Corporate Address info
+  # @type: string
+  field :corp_postal_code
+
+  # Corporate Address info
+  # @type: string
+  field :corp_country
+
+  # Corporate phone number
+  # @type: string
+  field :corp_phone
+
+  # Corporate fax number
+  # @type: string
+  field :corp_fax
+
+  # Address info
+  # @type: string
+  field :city
+
+  # Address info
+  # @type: string
+  field :state_region
+
+  # Address info
+  # @type: string
+  field :postal_code
+
+  # Address info
+  # @type: string
+  field :country
+
+  # Phone number
+  # @type: string
+  field :phone_number
+
+  # Fax number
+  # @type: string
+  field :fax_number
+
+  # The date this company was created
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The ID of the user who created this company
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date this company was last modified
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The ID of the user who last modified this company
+  # @type: string
+  # @format: uuid
+  field :modified_user_id
+
+  # The name of the user who last modified this company
+  # @type: string
+  field :modified_user_name
+
+  # Federal Tax ID
+  # @type: string
+  field :tax_id
+
+  # Dun & Bradstreet Number
+  # @type: string
+  field :duns_number
+
+  # AP (Accounts Payable) Email Address
+  # @type: string
+  # @format: email
+  field :ap_email_address
+
+  # AR (Accounts Receivable) Email Address
+  # @type: string
+  # @format: email
+  field :ar_email_address
+
+  # For companies that use a custom domain name for their email system, this is
+  # the domain name used by this company.  If this value is known, new emails that
+  # come in from this domain will be connected to this company.
+  # @type: string
+  field :domain_name
+
+  # Identifier for classification of this company.
+  # @type: string
+  # @format: uuid
+  field :company_classification_code_def_id
+
+  # Description of the company.
+  # @type: string
+  field :description
+
+  # Website URL for this company.
+  # @type: string
+  field :website
+
+  # 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
+
+  # All invoices attached to this company.
+  #             
+  # To retrieve this collection, specify `Invoices` in the "Include" parameter for your query. For more information on Invoices, see [InvoiceModel](https://developer.lockstep.io/reference/get_api-v1-invoices-id).
+  # @type: array
+  field :invoices
+
+  # Classification code definition for this company.
+  #             
+  # To retrieve this collection, specify `Classification` in the "Include" parameter for your query.
+  field :company_classification_code_definition
+
+  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 :notes, {:class_name=>"Lockstep::Note", :included=>true, :foreign_key=>:object_key, :polymorphic=>{:table_key=>"Company"}}
+  has_many :attachments, {:class_name=>"Schema::Attachment", :included=>true}
+  has_many :contacts, {:class_name=>"Schema::Contact", :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