lockstep_rails 0.3.70 → 0.3.72

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24dea20381afb07c0769964a66d6654ac72b20912a5cfcb3f31b308495024752
-  data.tar.gz: e884043d30e05e7382f9d50016b0cfb37363c4a9192b2494cb99fb491f4a0b56
+  metadata.gz: d917ee0f2d4b07dd2d13151701c17c42bc77a61f95363e18fb62480c5b51c59e
+  data.tar.gz: bce93413a0d1b60decdb69dc137c323555dd0a272992ecc43260ee84831bc2d7
 SHA512:
-  metadata.gz: 9a7898f08919efef7f7b7f9047865d9cf306aac6b36b9aeedc050c05f6df70b6bd96f3996d2081fb78013c35ffbe27c2db434337737d14ba962ee398bfd42fb5
-  data.tar.gz: 782a7e8e7bd14969ce43aea26cf7576cd8d3a61366ae4b1f879ba5d5902c94fceee006ab83fe1224e21b95381baf27feb80313bd6475320e48e75abbb4e8e091
+  metadata.gz: 47831ddf735b0510a5e63b31aeb2f4a249155463f738d68084239d63e9e83318666394210f3bb5aa2765bd3d520197b508ee1818fe54fd7a1e72169e9d0bc986
+  data.tar.gz: 8b6a4ca48837595396e0d5e9cedf6a530b5b3143f6f89547804ce0130676b525f78ee3b7409971274f04dbc9d55a980ba5c23bf523eb0593d660f97f47974b29

data/app/concepts/lockstep/client.rb

@@ -175,4 +175,4 @@ module Lockstep
       block.call
     end
   end
-end
+end

data/app/models/lockstep/invoice.rb

@@ -7,6 +7,7 @@ class Lockstep::Invoice < Lockstep::ApiRecord
 
   belongs_to :connection, class_name: 'Lockstep::Connection', foreign_key: :customer_id
 
-  scope :einvoices, -> { include_object(:customer, :lines) }
-  scope :received_einvoices, -> { einvoices.where(invoice_type_code: 'AP E-Invoice') }
+  scope :einvoices, -> { where(is_e_invoice: true).include_object(:customer, :lines) }
+  scope :received_einvoices, -> { einvoices.where(invoice_type_code: 'AP Invoice') }
+  scope :sent_einvoices, -> { einvoices.where(invoice_type_code: 'AR Invoice') }
 end

data/app/platform_api/schema/company_magic_link_summary.rb

@@ -14,23 +14,23 @@ end
   # @type: string
   field :company_name
 
-  # This field indicates the type of company.  It can be one of a limited number of values:
-  # Company, Customer, Group, Vendor, or Third Party.  A company that represents both a customer and a vendor
-  # is identified as a CustomerVendor.
-  #
-  # * `Company` - This record represents a company that is part of the organization of the account holder.
-  # * `Customer` - This record represents a business entity that purchases things from the account holder.
-  # * `Group` - Only one record of type `GROUP` exists in each account.  Contains your account profile.
-  # * `Vendor` - This record represents a business entity that sells things to the account holder.
-  # * `Third Party` - This record represents a business entity that is neither a customer nor vendor.
-  # * `CustomerVendor` - Both a customer and a vendor.
+  # This field indicates the type of company.  It can be one of a limited number of values:
+  # Company, Customer, Group, Vendor, or Third Party.  A company that represents both a customer and a vendor
+  # is identified as a CustomerVendor.
+  #             
+  # * `Company` - This record represents a company that is part of the organization of the account holder.
+  # * `Customer` - This record represents a business entity that purchases things from the account holder.
+  # * `Group` - Only one record of type `GROUP` exists in each account.  Contains your account profile.
+  # * `Vendor` - This record represents a business entity that sells things to the account holder.
+  # * `Third Party` - This record represents a business entity that is neither a customer nor vendor.
+  # * `CustomerVendor` - Both a customer and a vendor.
   # * `CompanyProfile` - Profile for a Company, each Company should have at most 1 profile, used only for Profile Management.
   # @type: string
   field :company_type
 
-  # 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.
-  #
+  # 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
@@ -83,11 +83,11 @@ end
   # @format: uuid
   field :latest_magic_link_id
 
-  # Possible statuses for a Magic Link.
+  # Status of the most recent magic link made for this company
   field :latest_magic_link_status
 
   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
+end

data/app/platform_api/schema/credit_memo_applied.rb

@@ -50,12 +50,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 credit memo application
-  # @type: string
-  field :erp_write_status_name
+  # Possible actions for a record that supports ERP Update.
+  field :erp_update_action
 
   # Reference number for the applied credit memo.
   # @type: integer

data/app/platform_api/schema/financial_account.rb

@@ -36,8 +36,8 @@ end
   # @type: string
   field :name
 
-  # The status of the Financial Account. Possible values are active,
-  # inactive, deleted or archived.
+  # The status of the Financial Account. Possible values are Active,
+  # Inactive, Deleted or Archived.
   # @type: string
   field :status
 

data/app/platform_api/schema/invoice.rb

@@ -78,6 +78,15 @@ end
   # @type: string
   field :invoice_status_code
 
+  # The id of the work flow status associated with this invoice.
+  # @type: string
+  # @format: uuid
+  field :workflow_status_id
+
+  # A description of the current workflow status of this invoice.
+  # @type: string
+  field :workflow_status_notes
+
   # A code identifying the terms given to the purchaser.  This field is imported directly from the originating
   # financial system and does not follow a specified format.
   # @type: string
@@ -226,12 +235,11 @@ end
   # @format: double
   field :base_currency_outstanding_balance_amount
 
-  # 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 Invoice
-  # @type: string
-  field :erp_write_status_name
+  # Possible actions for a record that supports ERP Update.
+  field :erp_update_action
 
   # The date on which this record was last modified in source ERP.
   # @type: string
@@ -250,6 +258,10 @@ end
   # To retrieve this item, specify `Customer` in the "Include" parameter for your query.
   field :customer_primary_contact
 
+  # Indicates if the invoice an E-Invoice or not
+  # @type: boolean
+  field :is_e_invoice
+
   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"}
   belongs_to :customer, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"}
@@ -257,6 +269,7 @@ end
   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 :workflow_statuses, {:class_name=>"Schema::InvoiceWorkflowStatusHistory", :included=>true}
   has_many :addresses, {:class_name=>"Schema::InvoiceAddress", :included=>true}
   has_many :lines, {:class_name=>"Schema::InvoiceLine", :included=>true}
   has_many :payments, {:class_name=>"Schema::InvoicePaymentDetail", :included=>true}

data/app/platform_api/schema/invoice_line.rb

@@ -133,12 +133,11 @@ end
   # @format: uuid
   field :app_enrollment_id
 
-  # 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 Invoice
-  # @type: string
-  field :erp_write_status_name
+  # Possible actions for a record that supports ERP Update.
+  field :erp_update_action
 
   # The date on which this record was last modified in source ERP.
   # @type: string

data/app/platform_api/schema/invoice_sync.rb

@@ -323,6 +323,14 @@ end
   # @format: double
   field :base_currency_outstanding_balance_amount
 
+  # True if the invoice is an E-Invoice
+  # @type: boolean
+  field :is_e_invoice
+
+  # True if the E-Invoice should be sent to gov/other recipients immediately
+  # @type: boolean
+  field :send_immediately
+
 
 
 end

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

@@ -5,41 +5,41 @@ 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.
-  #
+  # 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.
-  #
+  # 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
+  # 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`.
-  #
+  # 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.
+  # 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
@@ -103,4 +103,4 @@ end
   has_many :lines, {:class_name=>"Schema::JournalEntryLine", :included=>true}
   has_many :attachments, {:class_name=>"Schema::Attachment", :included=>true}
 
-end
+end

data/app/platform_api/schema/journal_entry_line.rb

@@ -5,9 +5,9 @@ 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.
-  #
+  # 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
@@ -18,28 +18,28 @@ end
   # @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.
-  #
+  # 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
+  # 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`.
-  #
+  # 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
@@ -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
@@ -118,7 +122,7 @@ end
   # @format: date-time
   field :source_modified_date, Types::Params::DateTime
 
-  # The journal entry for this journal entry line.
+  # The journal entry for this journal entry line.
   # To retrieve this item, specify `JournalEntry` in the "Include" parameter for your query.
   field :journal_entry
 
@@ -126,4 +130,4 @@ end
   belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
 
 
-end
+end

data/app/platform_api/schema/journal_entry_line_sync.rb

@@ -73,6 +73,10 @@ end
   # @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.

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/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

@@ -1,10 +1,11 @@
 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
+# 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
@@ -59,7 +60,9 @@ class Schema::WorkflowStatus < Lockstep::ApiRecord
   # @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
+  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