lockstep_rails 0.3.68 → 0.3.70

data/app/platform_api/schema/external_connector_auth_request.rb

@@ -0,0 +1,22 @@
+class Schema::ExternalConnectorAuthRequest < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # An array of scopes requested from 3rd-party provider.
+  # @type: array
+  field :scopes
+
+  # The URL the browser is redirected to after a user grants, or denies, permissions for Sage software.
+  # @type: string
+  field :redirect_url
+
+  # Opaque value that a secret will be tagged with on the service side when created
+  # @type: string
+  field :connection_context_id
+
+
+
+end

data/app/platform_api/schema/external_connector_token.rb

@@ -0,0 +1,36 @@
+class Schema::ExternalConnectorToken < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # ID of the token reference.
+  # @type: string
+  field :id
+
+  # When the user was authenticated.
+  # @type: string
+  # @format: date-time
+  field :authenticated_at, Types::Params::DateTime
+
+  # An array of scopes requested from 3rd-party external connector.
+  # @type: array
+  field :scopes
+
+  # When the token expires. This can be earlier if the token is revoked.
+  # @type: string
+  # @format: date-time
+  field :expires_at, Types::Params::DateTime
+
+  # External Connector ID
+  # @type: string
+  field :external_connector_id
+
+  # Connection context ID set by the product when starting onboarding with a external connector
+  # @type: string
+  field :connection_context_id
+
+
+
+end

data/app/platform_api/schema/invoice_fetch_result.rb

@@ -23,5 +23,7 @@ end
   #  For more information on Invoices, see [InvoiceModel](https://developer.lockstep.io/reference/get_api-v1-invoices-id).
   # @type: array
   field :records
-  
-end
+
+
+
+end

data/app/platform_api/schema/invoice_line_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 Invoice Line record. For this field, you should use whatever the contact'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 :invoice_erp_key
 
+  # The network id of the parent Invoice.
+  # @type: string
+  # @format: uuid
+  field :invoice_network_id
+
   # The line number of this line, as defined in the originating ERP or accounting system.  You can sort on this number to
   # get the original view of lines within the invoice.
   # @type: string

data/app/platform_api/schema/invoice_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 Invoice record. For this field, you should use whatever the invoice's unique
   # identifying number is in the originating system. Search for a unique, non-changing number within the
   # originating financial system for this record.
@@ -29,6 +34,11 @@ end
   # @type: string
   field :company_erp_key
 
+  # The network id of the related Company.
+  # @type: string
+  # @format: uuid
+  field :company_network_id
+
   # The original primary key or unique ID of the company to which this invoice was sent.  This value should
   # match the [Company ErpKey](https://developer.lockstep.io/docs/importing-companies#erpkey) field on the
   # [CompanySyncModel](https://developer.lockstep.io/docs/importing-companies).
@@ -39,6 +49,11 @@ end
   # @type: string
   field :customer_erp_key
 
+  # The network id of the related Customer.
+  # @type: string
+  # @format: uuid
+  field :customer_network_id
+
   # The name of the salesperson that wrote this invoice.  This is just text, it is not a reference to the
   # "Contacts" table.  You will not receive an error if this field does not match a known contact person.
   # @type: string

data/app/platform_api/schema/journal_entry.rb

@@ -0,0 +1,106 @@
+class Schema::JournalEntry < 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 :journal_entry_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 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 unique ID of this record as it was known in its originating financial system.
+  #
+  # If this journal entry 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
+
+  # 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
+
+  # The UTC date and time when this journal entry was posted.
+  # @type: string
+  # @format: date-time
+  field :posting_date, Types::Params::DateTime
+
+  # 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
+
+  # The date that the journal entry was created.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The ID of the user who created the journal entry.
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date that the journal entry was last modified.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The ID of the user who last modified the journal entry.
+  # @type: string
+  # @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"}
+
+  has_many :lines, {:class_name=>"Schema::JournalEntryLine", :included=>true}
+  has_many :attachments, {:class_name=>"Schema::Attachment", :included=>true}
+
+end

data/app/platform_api/schema/journal_entry_fetch_result.rb

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

data/app/platform_api/schema/journal_entry_line.rb

@@ -0,0 +1,129 @@
+class Schema::JournalEntryLine < 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 :journal_entry_line_id
+
+  # The Journal Entry with which this line is associated.
+  # @type: string
+  # @format: uuid
+  field :journal_entry_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 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 unique ID of this record as it was known in its originating financial system.
+  #
+  # If this journal entry 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
+
+  # The Financial Account with which this line is associated.
+  # @type: string
+  # @format: uuid
+  field :financial_account_id
+
+  # 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
+
+  # The date that the journal entry line was created.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The ID of the user who created the journal entry line.
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date that the journal entry line was last modified.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The ID of the user who last modified the journal entry line.
+  # @type: string
+  # @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"}
+
+
+end

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,92 @@
+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
+
+  # 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/magic_link.rb

@@ -81,6 +81,14 @@ end
   # To retrieve this item, specify `User` in the "Include" parameter for your query.
   field :user
 
+  # The number of visits to this Magic Link
+  # @type: integer
+  # @format: int32
+  field :visits
+
+  # Possible statuses for a Magic Link.
+  field :status
+
   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"}
   belongs_to :company, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"}

data/app/platform_api/schema/magic_link_summary.rb

@@ -0,0 +1,30 @@
+class Schema::MagicLinkSummary < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Group that the summary is for
+  # @type: string
+  # @format: uuid
+  field :group_key
+
+  # Total number of magic links sent
+  # @type: integer
+  # @format: int32
+  field :total_count
+
+  # Total number of magic links that failed to send
+  # @type: integer
+  # @format: int32
+  field :total_bounced
+
+  # Total number of visits across all magic links
+  # @type: integer
+  # @format: int32
+  field :total_visited
+
+
+
+end