lockstep_rails 0.3.69 → 0.3.71

data/app/platform_api/schema/invoice_workflow_status_history.rb

@@ -0,0 +1,49 @@
+class Schema::InvoiceWorkflowStatusHistory < 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 Accounting Data Services platform.
+  # @type: string
+  # @format: uuid
+  field :invoice_workflow_status_history_id
+
+  # The invoice ID associated with the invoice workflow status history.
+  # @type: string
+  # @format: uuid
+  field :invoice_id
+
+  # The workflow status ID associated with the invoice workflow status history.
+  # @type: string
+  # @format: uuid
+  field :workflow_status_id
+
+  # The GroupKey uniquely identifies a single Accounting Data Services 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 notes for the invoice workflow status history.
+  # @type: string
+  field :workflow_status_notes
+
+  # The date that the invoice workflow status history was created.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The ID of the user who created the invoice workflow status history.
+  # @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/journal_entry.rb

@@ -92,6 +92,11 @@ end
   # @format: uuid
   field :modified_user_id
 
+  # The date on which this record was last modified in source ERP.
+  # @type: string
+  # @format: date-time
+  field :source_modified_date, Types::Params::DateTime
+
   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/journal_entry_line.rb

@@ -69,7 +69,7 @@ end
 
   # The transaction currency in which the entry is recorded, especially useful for multi-currency environments.
   # @type: string
-  field :currency
+  field :currency_code
 
   # The base currency debit amount for the account.
   # @type: number
@@ -83,7 +83,7 @@ end
 
   # The base currency in which the entry is recorded, especially useful for multi-currency environments.
   # @type: string
-  field :base_currency
+  field :base_currency_code
 
   # The ERP’s identifier for the user who recorded the journal entry line.
   # @type: string
@@ -93,6 +93,10 @@ end
   # @type: string
   field :memo
 
+  # Dimensions for this journal entry line.
+  # @type: object
+  field :dimensions
+
   # The date that the journal entry line was created.
   # @type: string
   # @format: date-time
@@ -113,6 +117,15 @@ end
   # @format: uuid
   field :modified_user_id
 
+  # The date on which this record was last modified in source ERP.
+  # @type: string
+  # @format: date-time
+  field :source_modified_date, Types::Params::DateTime
+
+  # The journal entry for this journal entry line.
+  # To retrieve this item, specify `JournalEntry` in the "Include" parameter for your query.
+  field :journal_entry
+
   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/journal_entry_line_fetch_result.rb

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

data/app/platform_api/schema/journal_entry_line_sync.rb

@@ -0,0 +1,96 @@
+class Schema::JournalEntryLineSync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Indicates what action to take when an existing object has been found during the sync process.
+  field :on_match_action
+
+  # This is the primary key of the Journal Entry Line record. For this field, you should use whatever the Journal Entry Line'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 Journal Entry Line records in a database, whatever the primary key for the Journal Entry Line table is
+  # in the database should be the "ErpKey".
+  #             
+  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+  # @type: string
+  field :erp_key
+
+  # The original primary key or unique ID of the journal entry to which this line belongs.  This value should
+  # match the Journal Entry ErpKey field on the JournalEntrySyncModel.
+  # @type: string
+  field :journal_entry_erp_key
+
+  # An optional Financial Account with which this line is associated. This value should
+  # match the Financial Account ErpKey field on the FinancialAccountSyncModel.
+  # @type: string
+  field :financial_account_erp_key
+
+  # The unique code/identifier assigned to each account in the chart of accounts.
+  # @type: string
+  field :account_number
+
+  # The name of the account.
+  # @type: string
+  field :account_name
+
+  # Debit to account.
+  # @type: number
+  # @format: double
+  field :debit
+
+  # Credit to account.
+  # @type: number
+  # @format: double
+  field :credit
+
+  # The transaction currency in which the entry is recorded, especially useful for multi-currency environments.
+  # @type: string
+  field :currency_code
+
+  # The base currency debit amount for the account.
+  # @type: number
+  # @format: double
+  field :base_debit
+
+  # The base currency credit amount for the account.
+  # @type: number
+  # @format: double
+  field :base_credit
+
+  # The base currency in which the entry is recorded, especially useful for multi-currency environments.
+  # @type: string
+  field :base_currency_code
+
+  # The ERP’s identifier for the user who recorded the journal entry line.
+  # @type: string
+  field :source_created_user
+
+  # A memo related to this line.
+  # @type: string
+  field :memo
+
+  # A JSON string representing the dimensions for this journal entry line.
+  # @type: object
+  field :dimensions
+
+  # 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/journal_entry_sync.rb

@@ -0,0 +1,66 @@
+class Schema::JournalEntrySync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Indicates what action to take when an existing object has been found during the sync process.
+  field :on_match_action
+
+  # This is the primary key of the Journal Entry record. For this field, you should use whatever the Journal Entry'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 Journal Entry records in a database, whatever the primary key for the Journal Entry table is
+  # in the database should be the "ErpKey".
+  #             
+  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+  # @type: string
+  field :erp_key
+
+  # The ERP’s identifier for this journal entry, usually has meaning to the user.
+  # May be the same value of the ERP Key.
+  # @type: string
+  field :journal_id
+
+  # Possible sources for a Journal Entry.
+  field :source
+
+  # Possible statuses for a Journal Entry.
+  field :status
+
+  # A brief description explaining the purpose of the journal entry.
+  # @type: string
+  field :description
+
+  # An additional comment related to the entry.
+  # @type: string
+  field :comment
+
+  # Any reference number or identifier associated with the entry, such as an invoice number or purchase order.
+  # @type: string
+  field :reference_number
+
+  # The raw posting date from the source.
+  # @type: string
+  # @format: date-time
+  field :source_posting_date, Types::Params::DateTime
+
+  # 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/payment.rb

@@ -36,12 +36,11 @@ end
   # @type: string
   field :erp_key
 
-  # Possible statuses for a record that supports ERP write.
-  field :erp_write_status
+  # Possible statuses for a record that supports ERP Update.
+  field :erp_update_status
 
-  # The name of the ErpWriteStatus for this Payment
-  # @type: string
-  field :erp_write_status_name
+  # Possible actions for a record that supports ERP Update.
+  field :erp_update_action
 
   # The type of payment, AR Payment or AP Payment.
   #             

data/app/platform_api/schema/payment_applied.rb

@@ -41,12 +41,11 @@ end
   # @type: string
   field :erp_key
 
-  # Possible statuses for a record that supports ERP write.
-  field :erp_write_status
+  # Possible statuses for a record that supports ERP Update.
+  field :erp_update_status
 
-  # The name of the ErpWriteStatus for this payment application
-  # @type: string
-  field :erp_write_status_name
+  # Possible actions for a record that supports ERP Update.
+  field :erp_update_action
 
   # The entry number of this payment application.  This is often a journal entry number, confirmation code,
   # or other identifying field for this payment application.

data/app/platform_api/schema/payment_applied_sync.rb

@@ -8,6 +8,11 @@ end
   # Indicates what action to take when an existing object has been found during the sync process.
   field :on_match_action
 
+  # The unique identifier of this object in the Sage Network platform.
+  # @type: string
+  # @format: uuid
+  field :network_id
+
   # This is the primary key of the Payment 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.
@@ -30,6 +35,11 @@ end
   # @type: string
   field :invoice_erp_key
 
+  # The network id of the related Invoice.
+  # @type: string
+  # @format: uuid
+  field :invoice_network_id
+
   # This field indicates which Payment was used to provide the funds for this payment application. In this
   # field, identify the original primary key or unique ID of the Payment that was used for this payment
   # application.
@@ -42,6 +52,11 @@ end
   # @type: string
   field :payment_erp_key
 
+  # The network id of the related Payment.
+  # @type: string
+  # @format: uuid
+  field :payment_network_id
+
   # The entry number of this payment application.  This is often a journal entry number, confirmation code,
   # or other identifying field for this payment application.
   # @type: integer

data/app/platform_api/schema/payment_sync.rb

@@ -8,6 +8,11 @@ end
   # Indicates what action to take when an existing object has been found during the sync process.
   field :on_match_action
 
+  # The unique identifier of this object in the Sage Network platform.
+  # @type: string
+  # @format: uuid
+  field :network_id
+
   # This is the primary key of the Payment record. For this field, you should use whatever the payment's unique
   # identifying number is in the originating system. Search for a unique, non-changing number within the
   # originating financial system for this record.
@@ -25,6 +30,11 @@ end
   # @type: string
   field :company_erp_key
 
+  # The network id of the related Company.
+  # @type: string
+  # @format: uuid
+  field :company_network_id
+
   # The type of payment, AR Payment or AP Payment.
   #             
   # Recognized PaymentType values are:

data/app/platform_api/schema/sync_request.rb

@@ -20,11 +20,13 @@ end
   field :group_key
 
   # The status of processing for this SyncRequest.  When a SyncRequest is created, it is flagged as `Ready`.
+  # While it is in queue waiting to be picked up, its status moves to `Connector`.
   # When it is picked up for execution, its status moves to `In Progress`.  When it is complete, its status
   # will move to `Success` or `Failed`.  If another API call cancels the SyncRequest, its status will move
   # to `Cancelled`.
   #             
   # * Ready
+  # * Connector
   # * In Progress
   # * Cancelled
   # * Failed

data/app/platform_api/schema/workflow_status.rb

@@ -0,0 +1,68 @@
+class Schema::WorkflowStatus < 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 Accounting Data Services platform.
+  # @type: string
+  # @format: uuid
+  field :id
+
+  # The name of the workflow status.
+  # @type: string
+  field :name
+
+  # The description explaining the use of the workflow status.
+  # @type: string
+  field :description
+
+  # The prior workflow status ID.
+  # @type: string
+  # @format: uuid
+  field :parent_workflow_status_id
+
+  # The category of the workflow status.
+  # @type: string
+  field :category
+
+  # The code of the workflow status.
+  # @type: string
+  field :code
+
+  # Indicates whether notes are required or not.
+  # @type: boolean
+  field :is_notes_required
+
+  # Indicates whether the status change should be reported to the ERP or not.
+  # @type: boolean
+  field :promote_to_erp
+
+  # The date that the workflow status was created.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The ID of the user who created the workflow status.
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date that the workflow status was last modified.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The ID of the user who last modified the workflow status.
+  # @type: string
+  # @format: uuid
+  field :modified_user_id
+
+  belongs_to :parent_workflow_status, {:class_name=>"Lockstep::WorkflowStatus", :primary_key=>:id, :foreign_key=>"parent_workflow_status_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/workflow_status_fetch_result.rb

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