lockstep_rails 0.3.37 → 0.3.39

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

data/app/platform_api/schema/financial_report_row.rb

@@ -0,0 +1,20 @@
+class Schema::FinancialReportRow < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Describes what type of row this row is (Header, Summary, Classification, Category, Subcategory, Data)
+  # @type: string
+  field :row_type
+
+  # The label for the row if it is a Classification, Category, or Subcategory.
+  # @type: string
+  field :label
+
+
+  has_many :rows, {:class_name=>"Schema::FinancialReportRow", :included=>true}
+  has_many :cells, {:class_name=>"Schema::FinancialReportCell", :included=>true}
+
+end

data/app/platform_api/schema/financial_year_setting_sync.rb

@@ -0,0 +1,28 @@
+class Schema::FinancialYearSettingSync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The type of financial year, either Calendar or Fiscal.
+  # @type: string
+  field :year_type
+
+  # Total number of periods in the year. For Calendar year types this should always be 12. For Fiscal year types
+  # this can either be 12 or 13 for a 4 week 13 period year.
+  # @type: integer
+  # @format: int32
+  field :total_periods
+
+  # The start date of the financial year. Should be entered in MM-DD format.
+  # @type: string
+  field :start_date
+
+  # The end date of the financial year. Should be entered in MM-DD format.
+  # @type: string
+  field :end_date
+
+
+
+end

data/app/platform_api/schema/group_account.rb

@@ -0,0 +1,62 @@
+class Schema::GroupAccount < 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 name of the group
+  # @type: string
+  field :group_name
+
+  # The primary user for the group
+  # @type: string
+  # @format: uuid
+  field :primary_user_id
+
+  # The CompanyId of the Company the group is associated with
+  # @type: string
+  # @format: uuid
+  field :group_company_id
+
+  # The active status of the group
+  # @type: boolean
+  field :is_active
+
+  # The onboarding session status of the group
+  # @type: boolean
+  field :onboarding_scheduled
+
+  # The date this group account was created
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The ID of the user who created this group account
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date this group account was last modified
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The ID of the user who last modified this group account
+  # @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/invoice.rb

@@ -63,9 +63,10 @@ end
   # A code identifying the type of this invoice.
   #             
   # Recognized Invoice types are:
-  # * `Invoice` - Represents an invoice sent by Company to the Customer
-  # * `AP Invoice` - Represents an invoice sent by Customer to the Company
-  # * `Credit Memo` - Represents a credit memo generated by Customer given to Company
+  # * `AR Invoice` - Represents an invoice sent by Company to the Customer
+  # * `AP Invoice` - Represents an invoice sent by Vendor to the Company
+  # * `AR Credit Memo` - Represents a credit memo generated by Company given to Customer
+  # * `AP Credit Memo` - Represents a credit memo generated by Vendor given to Company
   # @type: string
   field :invoice_type_code
 
@@ -196,6 +197,10 @@ end
   # @type: boolean
   field :exclude_from_aging
 
+  # Indicates the preferred delivery method for this invoice. Examples include Print, Email, Fax
+  # @type: string
+  field :preferred_delivery_method
+
   # The Company associated to this invoice.
   # To retrieve this item, specify `Company` in the "Include" parameter for your query.
   field :company

data/app/platform_api/schema/invoice_address_fetch_result.rb

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

data/app/platform_api/schema/invoice_fetch_result.rb

@@ -5,6 +5,10 @@ def self.id_ref
   nil
 end
 
+  #  For more information on Invoices, see [InvoiceModel](https://developer.lockstep.io/reference/get_api-v1-invoices-id).
+  # @type: array
+  field :records
+
   
   # @type: integer
   # @format: int32
@@ -20,10 +24,6 @@ end
   # @format: int32
   field :page_number
 
-  #  For more information on Invoices, see [InvoiceModel](https://developer.lockstep.io/reference/get_api-v1-invoices-id).
-  # @type: array
-  field :records
-
 
 
 end

data/app/platform_api/schema/invoice_history.rb

@@ -79,7 +79,7 @@ end
   # @type: string
   field :special_terms
 
-  # The three-character ISO 4217 currency code used for this invoice. This will be validated by the /api/v1/currencies data set
+  # The three-character ISO 4217 currency code used for this invoice. This will be validated by the /api/v1/definitions/currencies data set
   # @type: string
   field :currency_code
 

data/app/platform_api/schema/invoice_line_fetch_result.rb

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

data/app/platform_api/schema/invoice_line_sync.rb

@@ -99,7 +99,7 @@ end
   # @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
+  # Origination address for this invoice line, if this line item was originated from a different address
   # @type: string
   field :origin_address_country
 
@@ -137,7 +137,7 @@ end
   # @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
+  # Billing address for this invoice line, if this line item is to be billed to a different address
   # @type: string
   field :bill_to_address_country
 
@@ -175,7 +175,7 @@ end
   # @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
+  # Shipping address for this invoice line, if this line item is to be shipped to a different address
   # @type: string
   field :ship_to_address_country
 

data/app/platform_api/schema/invoice_payment_detail.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/invoice_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
@@ -33,6 +33,12 @@ end
   # @format: date
   field :invoice_date
 
+  # The date when the invoice was closed and finalized after completion of all payments and delivery of all products and
+  # services.
+  # @type: string
+  # @format: date
+  field :invoice_closed_date
+
   # The name of the counterparty for the invoice, for example, a customer or vendor.
   # @type: string
   field :customer_name
@@ -70,6 +76,16 @@ end
   # @format: int32
   field :days_past_due
 
+  # The number of payments associated to this invoice.
+  # @type: integer
+  # @format: int32
+  field :payment_count
+
+  # Specific invoices have support for pdf retrieval from their respective erp. When this flag is true, an additional
+  # call to Invoices/{id}/pdf can be made to retrieve a pdf directly from the erp.
+  # @type: boolean
+  field :supports_erp_pdf_retrieval
+
   # The memo text of the payments associated to this invoice.
   # @type: array
   field :payment_numbers
@@ -78,6 +94,11 @@ end
   # @type: array
   field :payment_ids
 
+  # The modified date of the invoice.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
   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"}
 

data/app/platform_api/schema/invoice_summary_invoice_summary_totals_summary_fetch_result.rb

@@ -0,0 +1,30 @@
+class Schema::InvoiceSummaryInvoiceSummaryTotalsSummaryFetchResult < 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
+
+  # The totals for an Invoice Summary
+  field :summary
+
+
+  has_many :records, {:class_name=>"Schema::InvoiceSummary", :included=>true}
+  has_many :aging_summary, {:class_name=>"Schema::SummaryAgingTotals", :included=>true}
+
+end

data/app/platform_api/schema/invoice_summary_totals.rb

@@ -0,0 +1,20 @@
+class Schema::InvoiceSummaryTotals < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The total amount invoiced.
+  # @type: number
+  # @format: double
+  field :total_invoice_amount
+
+  # The total outstanding balance
+  # @type: number
+  # @format: double
+  field :total_invoice_balance
+
+
+
+end

data/app/platform_api/schema/invoice_sync.rb

@@ -61,9 +61,10 @@ end
   # A code identifying the type of this invoice.
   #             
   # Recognized Invoice types are:
-  # * `Invoice` - Represents an invoice sent by Company to the Customer
-  # * `AP Invoice` - Represents an invoice sent by Customer to the Company
-  # * `Credit Memo` - Represents a credit memo generated by Customer given to Company
+  # * `AR Invoice` - Represents an invoice sent by Company to the Customer
+  # * `AP Invoice` - Represents an invoice sent by Vendor to the Company
+  # * `AR Credit Memo` - Represents a credit memo generated by Company given to Customer
+  # * `AP Credit Memo` - Represents a credit memo generated by Vendor given to Company
   # @type: string
   field :invoice_type_code
 
@@ -84,7 +85,7 @@ end
   # @type: string
   field :special_terms
 
-  # The three-character ISO 4217 currency code used for this invoice. This will be validated by the /api/v1/currencies data set
+  # The three-character ISO 4217 currency code used for this invoice.
   # @type: string
   field :currency_code
 
@@ -163,7 +164,7 @@ end
   # @type: string
   field :origin_address_postal_code
 
-  # The origination address for this invoice This will be validated by the /api/v1/countries data set
+  # The origination address for this invoice
   # @type: string
   field :origin_address_country
 
@@ -201,7 +202,7 @@ end
   # @type: string
   field :bill_to_address_postal_code
 
-  # The billing address for this invoice This will be validated by the /api/v1/countries data set
+  # The billing address for this invoice
   # @type: string
   field :bill_to_address_country
 
@@ -239,7 +240,7 @@ end
   # @type: string
   field :ship_to_address_postal_code
 
-  # The shipping address for this invoice This will be validated by the /api/v1/countries data set
+  # The shipping address for this invoice
   # @type: string
   field :ship_to_address_country
 
@@ -275,6 +276,10 @@ end
   # @type: boolean
   field :in_dispute
 
+  # Indicates the preferred delivery method for this invoice. Examples include Print, Email, Fax
+  # @type: string
+  field :preferred_delivery_method
+
 
 
 end

data/app/platform_api/schema/lead.rb

@@ -21,6 +21,7 @@ end
 
   # Email of lead
   # @type: string
+  # @format: email
   field :email
 
   # Requested ERP of lead

data/app/platform_api/schema/magic_link.rb

@@ -0,0 +1,78 @@
+class Schema::MagicLink < 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 :magic_link_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.
+  # @type: string
+  # @format: uuid
+  field :group_key
+
+  # The unique ID of the user that this magic link is associated with.
+  # @type: string
+  # @format: uuid
+  field :user_id
+
+  # The ID of the user role for the magic link.
+  # @type: string
+  # @format: uuid
+  field :user_role
+
+  # The ID of the application for this magic link.
+  # @type: string
+  # @format: uuid
+  field :application_id
+
+  # The UTC date and time when this magic link expires.
+  # @type: string
+  # @format: date-time
+  field :expires, Types::Params::DateTime
+
+  # The UTC date and time when this magic link was revoked.
+  # @type: string
+  # @format: date-time
+  field :revoked, Types::Params::DateTime
+
+  # The date that the magic link was created
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The ID of the user who created the magic link
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date that the magic link was last modified
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The ID of the user who last modified the magic link
+  # @type: string
+  # @format: uuid
+  field :modified_user_id
+
+  # The created magic link URL. This will only be returned upon creation of the magic link.
+  # All other times, this value will be `null`.
+  # @type: string
+  field :magic_link_url
+
+  # The user associated with this magic link.
+  # To retrieve this item, specify `User` in the "Include" parameter for your query.
+  field :user
+
+  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/magic_link_fetch_result.rb

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

data/app/platform_api/schema/note.rb

@@ -19,16 +19,30 @@ end
   # @format: uuid
   field :group_key
 
-  # The name of the table the note is associated with
+  # A Note is connected to an existing item within the Lockstep Platform by the fields `TableKey` and
+  # `ObjectKey`.  For example, a Note connected to Invoice 12345 would have a `TableKey` value of
+  # `Invoice` and an `ObjectKey` value of `12345`.
+  #             
+  # The `TableKey` value contains the name of the table within the Lockstep Platform to which this metadata
+  # is connected.
+  #             
+  # For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
   # @type: string
   field :table_key
 
-  # The ID of the object the note is associated with
+  # A Note is connected to an existing item within the Lockstep Platform by the fields `TableKey` and
+  # `ObjectKey`.  For example, a Note connected to Invoice 12345 would have a `TableKey` value of
+  # `Invoice` and an `ObjectKey` value of `12345`.
+  #             
+  # The `ObjectKey` value contains the primary key of the record within the Lockstep Platform to which this
+  # metadata is connected.
+  #             
+  # For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
   # @type: string
   # @format: uuid
   field :object_key
 
-  # The text of the note
+  # The full text of the note
   # @type: string
   field :note_text
 
@@ -36,7 +50,11 @@ end
   # @type: string
   field :note_type
 
-  # Flag indicating if the note has been archived
+  # A flag indicating whether this Note is archived (also known as hidden or deleted).  When you call
+  # [ArchiveNote](https://developer.lockstep.io/reference/delete_api-v1-notes-id) this field will
+  # be set to true.
+  #             
+  # You should avoid displaying Notes with the IsArchived field set to true in your user interface.
   # @type: boolean
   field :is_archived
 
@@ -45,7 +63,8 @@ end
   # @format: date-time
   field :created, Types::Params::DateTime
 
-  # The ID of the user who created the note
+  # The unique ID of the [UserAccount](https://developer.lockstep.io/docs/useraccountmodel) of the user
+  # who created this Note.
   # @type: string
   # @format: uuid
   field :created_user_id