lockstep_rails 0.3.37 → 0.3.38

data/app/platform_api/schema/payables_summary_report.rb

@@ -0,0 +1,43 @@
+class Schema::PayablesSummaryReport < 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
+
+  # Timeframe in days the payables summary report is generated on
+  # @type: integer
+  # @format: int32
+  field :timeframe
+
+  # Amount of payments made based in the timeframe
+  # @type: number
+  # @format: double
+  field :total_payments_amount
+
+  # Number of payments made based in the timeframe
+  # @type: integer
+  # @format: int32
+  field :total_payments_count
+
+  # Amount of bills received based in the timeframe
+  # @type: number
+  # @format: double
+  field :total_amount_billed
+
+  # Number of bills received in the timeframe
+  # @type: integer
+  # @format: int32
+  field :total_bills_count
+
+
+
+end

data/app/platform_api/schema/payment.rb

@@ -36,11 +36,11 @@ end
   # @type: string
   field :erp_key
 
-  # The type of payment, cash or check.
+  # The type of payment, AR Payment or AP Payment.
   #             
   # Recognized PaymentType values are:
-  # * `Cash` - A cash payment or other direct transfer.
-  # * `Check` - A check payment.
+  # * `AR Payment` - A payment made by a Customer to the Company
+  # * `AP Payment` - A payment made by the Company to a Vendor
   # @type: string
   field :payment_type
 
@@ -50,7 +50,8 @@ end
   # * `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.
+  # * `Wire Transfer` - A payment made via wire transfer from another financial institution.
+  # * `Other` - A payment made via another method not listed above.
   # @type: string
   field :tender_type
 
@@ -89,7 +90,7 @@ end
 
   # 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
+  # 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/definitions/currencies data set
   # @type: string
   field :currency_code
 

data/app/platform_api/schema/payment_applied.rb

@@ -85,6 +85,9 @@ end
   # @format: uuid
   field :app_enrollment_id
 
+  # The payment associated with this applied payment
+  field :payment
+
   # The invoice associated with this applied payment.
   field :invoice
 

data/app/platform_api/schema/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
@@ -53,10 +53,25 @@ end
   # @format: double
   field :unapplied_amount
 
-  # The type of payment, Payment or AP Payment.
+  # The type of payment, AR Payment or AP Payment.
+  #             
+  # Recognized PaymentType values are:
+  # * `AR Payment` - A payment made by a Customer to the Company
+  # * `AP Payment` - A payment made by the Company to a Vendor
   # @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.
+  # * `Other` - A payment made via another method not listed above.
+  # @type: string
+  field :tender_type
+
   # The date of this Payment.
   # @type: string
   # @format: date

data/app/platform_api/schema/payment_detail_header.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/payment_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,7 +26,11 @@ end
   # @type: string
   field :reference_code
 
-  # The type of payment, Payment or AP Payment.
+  # The tender type of payment (Cash, Check, etc.)
+  # @type: string
+  field :tender_type
+
+  # The type of payment, AR Payment or AP Payment.
   # @type: string
   field :payment_type
 
@@ -45,6 +49,11 @@ end
   # @format: double
   field :unapplied_amount
 
+  # 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
+
   # The number of invoices associated to this payment.
   # @type: integer
   # @format: int32
@@ -63,17 +72,31 @@ end
   # @type: array
   field :invoice_id_list
 
-  # The name of the customer for this payment.
+  # The id of the company for this payment.
   # @type: string
-  field :customer_name
+  # @format: uuid
+  field :payment_company_id
 
-  # The id of the customer for this payment.
+  # The name of the company for this payment.
   # @type: string
-  # @format: uuid
-  field :customer_id
+  field :payment_company_name
+
+  # The ids of the customer for the associated invoices.
+  # @type: array
+  field :customer_ids
+
+  # The names of the customer for the associated invoices.
+  # @type: array
+  field :customer_names
+
+  # The ids of the company for the associated invoices.
+  # @type: array
+  field :company_ids
+
+  # The names of the company for the associated invoices.
+  # @type: array
+  field :company_names
 
-  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_summary_payment_summary_totals_summary_fetch_result.rb

@@ -0,0 +1,30 @@
+class Schema::PaymentSummaryPaymentSummaryTotalsSummaryFetchResult < 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 a Payment Summary
+  field :summary
+
+
+  has_many :records, {:class_name=>"Schema::PaymentSummary", :included=>true}
+  has_many :aging_summary, {:class_name=>"Schema::SummaryAgingTotals", :included=>true}
+
+end

data/app/platform_api/schema/payment_summary_totals.rb

@@ -0,0 +1,20 @@
+class Schema::PaymentSummaryTotals < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The total amount paid.
+  # @type: number
+  # @format: double
+  field :total_paid_amount
+
+  # The total amount unapplied.
+  # @type: number
+  # @format: double
+  field :total_unapplied_balance
+
+
+
+end

data/app/platform_api/schema/payment_sync.rb

@@ -22,11 +22,11 @@ end
   # @type: string
   field :company_erp_key
 
-  # The type of payment, cash or check.
+  # The type of payment, AR Payment or AP Payment.
   #             
   # Recognized PaymentType values are:
-  # * `Cash` - A cash payment or other direct transfer.
-  # * `Check` - A check payment.
+  # * `AR Payment` - A payment made by a Customer to the Company
+  # * `AP Payment` - A payment made by the Company to a Vendor
   # @type: string
   field :payment_type
 
@@ -36,7 +36,8 @@ end
   # * `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.
+  # * `Wire Transfer` - A payment made via wire transfer from another financial institution.
+  # * `Other` - A payment made via another method not listed above.
   # @type: string
   field :tender_type
 
@@ -75,7 +76,7 @@ end
 
   # 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
+  # For a list of ISO 4217 currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies).
   # @type: string
   field :currency_code
 

data/app/platform_api/schema/public_company_profile.rb

@@ -0,0 +1,37 @@
+class Schema::PublicCompanyProfile < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique ID of the company associated with this profile.
+  # @type: string
+  # @format: uuid
+  field :company_id
+
+  # The short name of the company associated with this profile.
+  # @type: string
+  field :company_name
+
+  # The URL of this company's logo, if known.
+  # @type: string
+  field :company_logo_url
+
+  # Website URL for the company associated with this profile.
+  # @type: string
+  field :website
+
+  # Description of the company associated with this profile.
+  # @type: string
+  field :description
+
+  # The public url slug for this Public Company Profile.
+  # @type: string
+  field :public_url_slug
+
+  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/public_company_profile_fetch_result.rb

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

data/app/platform_api/schema/risk_rate.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
@@ -18,6 +18,11 @@ end
   # @format: date-time
   field :report_period, Types::Params::DateTime
 
+  # The month the risk rate was calculated for
+  # @type: string
+  # @format: date-time
+  field :report_date, Types::Params::DateTime
+
   # The string name of the month the risk rate was calculated for
   # @type: string
   field :invoice_month_name

data/app/platform_api/schema/status.rb

@@ -62,11 +62,21 @@ end
   # @type: string
   field :version
 
+  # If authentication is successful, contains the onboarding session status of the logged-in user's group account.
+  # @type: boolean
+  field :onboarding_scheduled
+
+  # The id of the Magic link used to authenticate.
+  # @type: string
+  # @format: uuid
+  field :magic_link_id
+
   # Statuses for the dependencies of this api.
   # OK if the dependency is working.
   # @type: object
   field :dependencies
 
 
+  has_many :user_groups, {:class_name=>"Schema::UserGroup", :included=>true}
 
 end

data/app/platform_api/schema/summary_aging_totals.rb

@@ -0,0 +1,19 @@
+class Schema::SummaryAgingTotals < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Aging bucket outstanding balance is associated to.
+  # @type: string
+  field :bucket
+
+  # Aging outstanding balance value.
+  # @type: number
+  # @format: double
+  field :outstanding_balance
+
+
+
+end

data/app/platform_api/schema/sync_entity_result.rb

@@ -15,6 +15,11 @@ end
   # @format: int32
   field :update_count
 
+  # The number of entities deleted
+  # @type: integer
+  # @format: int32
+  field :delete_count
+
   # The number of entities skipped
   # @type: integer
   # @format: int32

data/app/platform_api/schema/sync_request.rb

@@ -36,6 +36,11 @@ end
   # @type: string
   field :process_result_message
 
+  # A boolean indicating whether a sync from an ERP system should process all the data from the ERP
+  # as opposed to just the delta of changes since the previous sync run
+  # @type: string
+  field :run_full_sync
+
   # The AppEnrollmentId of the AppEnrollment object that executed this sync request
   # @type: string
   # @format: uuid

data/app/platform_api/schema/sync_submit.rb

@@ -10,6 +10,12 @@ end
   # @format: uuid
   field :app_enrollment_id
 
+  # A boolean indicating whether a sync from an ERP system should process all the data from the ERP
+  # as opposed to just the delta of changes since the previous sync run. For the Demo Data Connector, setting this
+  # to True refreshes the data with new dates as opposed to leaving it unchanged.
+  # @type: boolean
+  field :run_full_sync
+
 
 
 end

data/app/platform_api/schema/transaction.rb

@@ -0,0 +1,94 @@
+class Schema::Transaction < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Group account transaction is associated with.
+  # @type: string
+  # @format: uuid
+  field :group_key
+
+  # An additional reference number that is sometimes used to identify a transaction.
+  # The meaning of this field is specific to the ERP or accounting system used by the user.
+  # @type: string
+  field :reference_number
+
+  # The unique ID of the transaction record.
+  # @type: string
+  # @format: uuid
+  field :transaction_id
+
+  # The status of the transaction record.
+  #             
+  # Recognized Invoice status codes are:
+  # * `Open` - Represents an invoice that is considered open and needs more work to complete
+  # * `Closed` - Represents an invoice that is considered closed and resolved
+  #             
+  # Recognized Payment status codes are:
+  # * `Open` - Represents an payment that includes some unassigned amount that has not yet been applied to an invoice
+  # * `Closed` - Represents an payment where `UnappliedAmount` will be zero
+  # @type: string
+  field :transaction_status
+
+  # The type of the transaction record.
+  #             
+  # Recognized Invoice types are:
+  # * `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
+  #             
+  # Recognized PaymentType values are:
+  # * `AR Payment` - A payment made by a Customer to the Company
+  # * `AP Payment` - A payment made by the Company to a Vendor
+  # @type: string
+  field :transaction_type
+
+  # Additional type categorization of the transaction.
+  # @type: string
+  field :transaction_sub_type
+
+  # The date when a transaction record was reported.
+  # @type: string
+  # @format: date-time
+  field :transaction_date, Types::Params::DateTime
+
+  # The date when a transaction record is due for payment or completion.
+  # @type: string
+  # @format: date-time
+  field :due_date, Types::Params::DateTime
+
+  # The amount of days past the due date the transaction is left un-closed.
+  # @type: integer
+  # @format: int32
+  field :days_past_due
+
+  # The total value of this transaction, inclusive or all taxes and line items.
+  # @type: number
+  # @format: double
+  field :transaction_amount
+
+  # The remaining balance of this transaction.
+  # @type: number
+  # @format: double
+  field :outstanding_amount
+
+  # The count of items associated to the transaction.
+  #             
+  # Examples:
+  # * Number of payments for an invoice.
+  # * Number of invoices a payment or credit memo is applied to.
+  # @type: integer
+  # @format: int32
+  field :transaction_detail_count
+
+  # Specific transactions have support for pdf retrieval from their respective erp. When this flag is true, an additional
+  # call to Invoices/{id}/pdf or Payments/{id}/pdf can be made to retrieve a pdf directly from the erp.
+  # @type: boolean
+  field :supports_erp_pdf_retrieval
+
+
+
+end

data/app/platform_api/schema/transaction_detail.rb

@@ -0,0 +1,73 @@
+class Schema::TransactionDetail < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Group account transaction detail is associated with.
+  # @type: string
+  # @format: uuid
+  field :group_key
+
+  # An additional reference number that is sometimes used to identify a transaction detail.
+  # The meaning of this field is specific to the ERP or accounting system used by the user.
+  # @type: string
+  field :reference_number
+
+  # The unique ID of the transaction detail record.
+  # @type: string
+  # @format: uuid
+  field :transaction_detail_id
+
+  # The unique ID of the entity applying the transaction to the transaction detail record.
+  # @type: string
+  # @format: uuid
+  field :transaction_detail_applied_id
+
+  # The unique ID of the transaction record.
+  # @type: string
+  # @format: uuid
+  field :transaction_id
+
+  # The type of the transaction detail record.
+  #             
+  # Recognized Invoice types are:
+  # * `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
+  #             
+  # Recognized PaymentType values are:
+  # * `AR Payment` - A payment made by a Customer to the Company
+  # * `AP Payment` - A payment made by the Company to a Vendor
+  # @type: string
+  field :transaction_type
+
+  # Additional type categorization of the transaction.
+  # @type: string
+  field :transaction_sub_type
+
+  # The date when a transaction detail record was reported.
+  # @type: string
+  # @format: date-time
+  field :transaction_date, Types::Params::DateTime
+
+  # The total value of this transaction detail, inclusive or all taxes and line items.
+  # @type: number
+  # @format: double
+  field :transaction_amount
+
+  # The remaining balance of this transaction detail.
+  # @type: number
+  # @format: double
+  field :outstanding_amount
+
+  # Specific transactions have support for pdf retrieval from their respective erp. When this flag is true, an additional
+  # call to Invoices/{id}/pdf or Payments/{id}/pdf can be made to retrieve a pdf directly from the erp.
+  # @type: boolean
+  field :supports_erp_pdf_retrieval
+
+
+
+end

data/app/platform_api/schema/transaction_summary_total.rb

@@ -0,0 +1,35 @@
+class Schema::TransactionSummaryTotal < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Total count of all transactions from the query request.
+  # @type: integer
+  # @format: int32
+  field :total_count
+
+  # Total value of all transactions from the query request.
+  # @type: number
+  # @format: double
+  field :total_amount
+
+  # Total outstanding amount value of all transactions from the query request.
+  # @type: number
+  # @format: double
+  field :outstanding_amount
+
+  # Total open invoice count from the query request.
+  # @type: integer
+  # @format: int32
+  field :invoice_open_count
+
+  # Total past due invoice count from the query request.
+  # @type: integer
+  # @format: int32
+  field :invoice_past_due_count
+
+
+
+end