lockstep_rails 0.3.36 → 0.3.38

data/app/platform_api/schema/company_details_payment.rb

@@ -0,0 +1,60 @@
+class Schema::CompanyDetailsPayment < 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
+
+  # Unique identifier for payment
+  # @type: string
+  # @format: uuid
+  field :payment_id
+
+  # Unique identifier for payment applied
+  # @type: string
+  # @format: uuid
+  field :payment_applied_id
+
+  # Payment type
+  # @type: string
+  field :payment_type
+
+  # Unique identifier for invoice payment is associated with
+  # @type: string
+  # @format: uuid
+  field :invoice_id
+
+  # Invoice type payment is associated with
+  # @type: string
+  field :invoice_type_code
+
+  # Invoice reference code payment is associated with
+  # @type: string
+  field :invoice_reference_code
+
+  # Invoice total amount payment is associated with
+  # @type: number
+  # @format: double
+  field :invoice_total_amount
+
+  # Date payment placed
+  # @type: string
+  # @format: date-time
+  field :payment_date, Types::Params::DateTime
+
+  # Amount payment was made for
+  # @type: number
+  # @format: double
+  field :payment_amount
+
+
+
+end

data/app/platform_api/schema/company_sync.rb

@@ -5,6 +5,9 @@ def self.id_ref
   nil
 end
 
+  # Indicates what action to take when a sync model has been found during the sync process.
+  field :on_match_action
+
   # This is the primary key of the Company record. For this field, you should use whatever the company's unique
   # identifying number is in the originating system. Search for a unique, non-changing number within the
   # originating financial system for this record.
@@ -56,7 +59,7 @@ end
   field :is_active
 
   # The default currency code for transactions related to this company.  For a list of 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
+  # [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies).
   # @type: string
   field :default_currency_code
 
@@ -93,7 +96,7 @@ end
   # @type: string
   field :postal_code
 
-  # The company's primary mailing address information This will be validated by the /api/v1/countries data set
+  # The company's primary mailing address information
   # @type: string
   field :country
 
@@ -137,6 +140,18 @@ end
   # @type: string
   field :ar_email_address
 
+  # Indicates the preferred invoice delivery method. Examples include Print, Email, Fax
+  # @type: string
+  field :preferred_delivery_method
+
+  # The company email address.
+  # @type: string
+  field :email_address
+
+  # An external reference that identifies the Company from the originating ERP system, separate from the ErpKey.
+  # @type: string
+  field :external_reference
+
 
 
 end

data/app/platform_api/schema/connector_info.rb

@@ -10,10 +10,22 @@ end
   # @type: string
   field :auth_code
 
+  # The access token id for the connector enrollment.
+  # @type: string
+  field :token_id
+
+  # The access token secret for the connector enrollment.
+  # @type: string
+  field :token_secret
+
   # The realm id of the account being granted permissions to access
   # @type: string
   field :realm_id
 
+  # The subsidiary id that corresponds to a legal entity.
+  # @type: string
+  field :subsidiary_id
+
   # The redirect uri used for step one of the OAuth2.0 flow.
   # @type: string
   field :redirect_uri
@@ -22,6 +34,23 @@ end
   # @type: string
   field :email
 
+  # The username of the web services account with access permissions.
+  # @type: string
+  field :username
+
+  # The password for the web services account with access permissions.
+  # @type: string
+  field :password
+
+  # The server name a connection is being created for.
+  # @type: string
+  field :server_name
+
+  # The port number of the server a connection is being created for.
+  # @type: integer
+  # @format: int32
+  field :server_port
+
 
 
 end

data/app/platform_api/schema/contact.rb

@@ -89,7 +89,7 @@ end
   # @type: string
   field :postal_code
 
-  # The two character country code of the address. This will be validated by the /api/v1/countries data set
+  # The two character country code of the address. This will be validated by the /api/v1/definitions/countries data set
   # @type: string
   field :country_code
 

data/app/platform_api/schema/contact_sync.rb

@@ -12,6 +12,12 @@ end
   # Example: If you store your contact records in a database, whatever the primary key for the contact table is
   # in the database should be the "ErpKey".
   #             
+  # As some ERP systems don't maintain a unique key for Contacts, we also support syncing Contacts with ERP keys
+  # of the form {prefix}|{index}, for example ContactPrefix|1, ContactPrefix|2 and so on.
+  #             
+  # For this reason, please ensure that your Contact ERP keys don't otherwise contain the '|' symbol or that it
+  # is replaced by an alternate symbol if they do.
+  #             
   # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
   # @type: string
   field :erp_key
@@ -74,7 +80,7 @@ end
   # @type: string
   field :postal_code
 
-  # The mailing address information for this contact. This will be validated by the /api/v1/countries data set
+  # The mailing address information for this contact.
   # @type: string
   field :country_code
 

data/app/platform_api/schema/credit_memo_applied.rb

@@ -93,6 +93,12 @@ end
   # @format: uuid
   field :app_enrollment_id
 
+  # The credit memo invoice associated with this applied credit memo
+  field :credit_memo_invoice
+
+  # The invoice associated with this applied credit memo
+  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"}
 

data/app/platform_api/schema/credit_memo_invoice.rb

@@ -7,7 +7,7 @@ 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

data/app/platform_api/schema/custom_field_sync.rb

@@ -9,7 +9,7 @@ end
   # 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.
+  # Custom Fields are identified by the `TableKey` 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`.
@@ -18,10 +18,10 @@ end
   # @type: string
   field :erp_key
 
-  # Custom Fields are identified by the `EntityType` and `ErpKey` values together.
+  # Custom Fields are identified by the `TableKey` 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`.
+  # invoice named "ApprovalStatusCode".  For the `TableKey` field, specify the value `Invoice`.
   #             
   # Recognized types include:
   # * `Company` - Link this custom field to a CompanySyncModel
@@ -30,7 +30,7 @@ end
   # * `InvoiceLine` - Link this custom field to an InvoiceLineSyncModel
   # * `Payment` - Link this custom field to a PaymentSyncModel
   # @type: string
-  field :entity_type
+  field :table_key
 
   # A label that uniquely identifies this custom field within your software.
   #             

data/app/platform_api/schema/custom_field_value.rb

@@ -24,6 +24,18 @@ end
   # @format: uuid
   field :record_key
 
+  # Table to which this definition belongs
+  # @type: string
+  field :table_key
+
+  # Text to display in-application for custom field
+  # @type: string
+  field :custom_field_label
+
+  # Data type of this definition
+  # @type: string
+  field :data_type
+
   # String of data for field
   # @type: string
   field :string_value

data/app/platform_api/schema/customer_summary.rb

@@ -7,7 +7,7 @@ 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
@@ -26,6 +26,11 @@ end
   # @type: string
   field :primary_contact
 
+  # The app enrollment ID this Customer is associated with
+  # @type: string
+  # @format: uuid
+  field :app_enrollment_id
+
   # The number of outstanding invoices for this customer.
   # @type: integer
   # @format: int32
@@ -46,16 +51,41 @@ end
   # @format: int32
   field :closed_invoices
 
+  # The number of closed invoices for this customer in the past thirty days.
+  # @type: integer
+  # @format: int32
+  field :closed_invoices_past_thirty_days
+
   # The total from collected payments.
   # @type: number
   # @format: double
   field :amount_collected
 
+  # The total from collected payments in the past thirty days.
+  # @type: number
+  # @format: double
+  field :amount_collected_past_thirty_days
+
   # The total balance of outstanding invoices.
   # @type: number
   # @format: double
   field :outstanding_amount
 
+  # The total amount invoiced in the past thirty days.
+  # @type: number
+  # @format: double
+  field :invoiced_amount_past_thirty_days
+
+  # The total amount outstanding from the invoices invoiced in the past thirty days.
+  # @type: number
+  # @format: double
+  field :outstanding_amount_past_thirty_days
+
+  # The number of invoices invoiced in the past thirty days.
+  # @type: integer
+  # @format: int32
+  field :invoices_past_thirty_days
+
   # The total amount past due for this customer.
   # @type: number
   # @format: double
@@ -66,6 +96,11 @@ end
   # @format: double
   field :unapplied_payments
 
+  # The total value of unapplied Payments for this Customer in the past thirty days.
+  # @type: number
+  # @format: double
+  field :unapplied_amount_past_thirty_days
+
   # Portion of Total AR for this Customer that is Past due. (TotalPastDue / Total AR).
   # @type: number
   # @format: double

data/app/platform_api/schema/daily_payable_outstanding_report.rb

@@ -5,12 +5,12 @@ def self.id_ref
   nil
 end
 
-  # Timeframe (month) the daily sales outstanding values are associated with
+  # Timeframe (quarter) the daily payable outstanding values are associated with
   # @type: string
   # @format: date-time
   field :timeframe, Types::Params::DateTime
 
-  # Number of invoices the average daily sales outstanding is calculated on
+  # Number of invoices the average daily payable outstanding is calculated on
   # @type: integer
   # @format: int32
   field :invoice_count
@@ -18,5 +18,8 @@ end
   # Time (in days) between an invoice was completed paid off and when the invoice was issued
   # @type: number
   # @format: double
-  field :daily_payable_sales_outstanding
-end
+  field :daily_payable_outstanding
+
+
+
+end

data/app/platform_api/schema/daily_sales_outstanding_report.rb

@@ -10,11 +10,6 @@ end
   # @format: date-time
   field :timeframe, Types::Params::DateTime
 
-  # Number of invoices the average daily sales outstanding is calculated on
-  # @type: integer
-  # @format: int32
-  field :invoice_count
-
   # Time (in days) between an invoice was completed paid off and when the invoice was issued
   # @type: number
   # @format: double

data/app/platform_api/schema/developer_account_submit.rb

@@ -9,6 +9,14 @@ end
   # @type: string
   field :name
 
+  # The first name of the person requesting the developer account.
+  # @type: string
+  field :first_name
+
+  # The last name of the person requesting the developer account.
+  # @type: string
+  field :last_name
+
   # The email address of the developer.
   # @type: string
   # @format: email

data/app/platform_api/schema/dpo_summary.rb

@@ -0,0 +1,46 @@
+class Schema::DpoSummary < 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 the vendor.
+  # @type: string
+  # @format: uuid
+  field :vendor_id
+
+  # The name of the vendor.
+  # @type: string
+  field :vendor_name
+
+  # The name of the primary contact.
+  # @type: string
+  field :primary_contact
+
+  # The total number of outstanding bills.
+  # @type: integer
+  # @format: int32
+  field :bills
+
+  # The total amount outstanding.
+  # @type: number
+  # @format: double
+  field :amount_outstanding
+
+  # The days payable outstanding value.
+  # @type: number
+  # @format: double
+  field :dpo
+
+
+
+end

data/app/platform_api/schema/dpo_summary_group_total.rb

@@ -0,0 +1,38 @@
+class Schema::DpoSummaryGroupTotal < 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 vendors with outstanding bills
+  # @type: integer
+  # @format: int32
+  field :vendors
+
+  # The total number of bills outstanding
+  # @type: integer
+  # @format: int32
+  field :bills
+
+  # The total amount outstanding
+  # @type: number
+  # @format: double
+  field :amount_outstanding
+
+  # The total dpo for the group key
+  # @type: number
+  # @format: double
+  field :dpo
+
+
+
+end

data/app/platform_api/schema/feature_flags_request.rb

@@ -0,0 +1,14 @@
+class Schema::FeatureFlagsRequest < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The names of Feature Flags
+  # @type: array
+  field :names
+
+
+
+end

data/app/platform_api/schema/feature_flags_response.rb

@@ -0,0 +1,14 @@
+class Schema::FeatureFlagsResponse < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # State of the requested Feature Flags
+  # @type: object
+  field :values
+
+
+
+end

data/app/platform_api/schema/financial_account.rb

@@ -51,7 +51,7 @@ end
   field :description
 
   # The classification for the Financial Account. Possible values are Asset, Equity,
-  # Expense, Liability or Revenue.
+  # Expense, Liability or Income.
   # @type: string
   field :classification
 

data/app/platform_api/schema/financial_account_balance_history_sync.rb

@@ -0,0 +1,56 @@
+class Schema::FinancialAccountBalanceHistorySync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The code for the Financial Account. Can either be a general ledger or
+  # an account code.
+  # @type: string
+  field :financial_account_code
+
+  # This is the primary key of the FinancialAccount record. For this field, you should use whatever the company'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 company records in a database, whatever the primary key for the company table is
+  # in the database should be the ErpKey.
+  # Example: If you use a financial system such as Quickbooks or Xero, look for the primary ID number of the
+  # company record within that financial system.
+  # @type: string
+  field :financial_account_erp_key
+
+  # The financial year that this period falls under
+  # @type: integer
+  # @format: int32
+  field :financial_year
+
+  # The period number (1-12 or 1-13) that this balance history is for
+  # @type: integer
+  # @format: int32
+  field :period_number
+
+  # The start date of this period.
+  # @type: string
+  # @format: date-time
+  field :period_start_date, Types::Params::DateTime
+
+  # The end date of this period.
+  # @type: string
+  # @format: date-time
+  field :period_end_date, Types::Params::DateTime
+
+  # The status of this period. The status should be Closed if the books for this period have been closed,
+  # if not the status should be Open. The status can also be Deleted if there was a recalculation that needed
+  # to occur, for example due to a change in financial year settings.
+  # @type: string
+  field :status
+
+  # The current or end balance of this period.
+  # @type: number
+  # @format: double
+  field :balance
+
+
+
+end

data/app/platform_api/schema/financial_account_sync.rb

@@ -0,0 +1,50 @@
+class Schema::FinancialAccountSync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The code for the Financial Account. Can either be a general ledger or
+  # an account code.
+  # @type: string
+  field :code
+
+  # The External Id for the Financial Account.
+  # @type: string
+  field :erp_key
+
+  # The name of the Financial Account.
+  # @type: string
+  field :name
+
+  # The status of the Financial Account. Possible values are active,
+  # inactive, deleted or archived.
+  # @type: string
+  field :status
+
+  # The cashflow type for the Financial Account. Examples include cash, financing, investment
+  # or operation.
+  # @type: string
+  field :cashflow_type
+
+  # The description for the Financial Account.
+  # @type: string
+  field :description
+
+  # The classification for the Financial Account. Possible values are Asset, Equity,
+  # Expense, Liability or Income.
+  # @type: string
+  field :classification
+
+  # The category for the Financial Account. Examples include Current Asset, Current Liability, Common Stock
+  # @type: string
+  field :category
+
+  # The subcategory for the Financial Account. Examples include Cash, Property, Bank Loan, etc.
+  # @type: string
+  field :subcategory
+
+
+
+end

data/app/platform_api/schema/financial_report.rb

@@ -0,0 +1,38 @@
+class Schema::FinancialReport < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The name of the report ("*Report Type* for *Company*")
+  # @type: string
+  field :report_name
+
+  # 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 start date of the financial report
+  # @type: string
+  # @format: date-time
+  field :report_start_date, Types::Params::DateTime
+
+  # The end date of the financial report
+  # @type: string
+  # @format: date-time
+  field :report_end_date, Types::Params::DateTime
+
+  # The created date of the financial report
+  # @type: string
+  # @format: date-time
+  field :report_created_date, Types::Params::DateTime
+
+
+  has_many :rows, {:class_name=>"Schema::FinancialReportRow", :included=>true}
+
+end

data/app/platform_api/schema/financial_report_cell.rb

@@ -0,0 +1,14 @@
+class Schema::FinancialReportCell < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The value of the financial report cell
+  # @type: string
+  field :value
+
+
+
+end