lockstep_rails 0.3.47 → 0.3.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7db9d59fbe7aa12ec5ea2c3985a1e898e94327dc0645a90278b14d7612382cf1
-  data.tar.gz: 47fc4750144c70cd99dd4cc765c38801f0e420e70af61d243a8d84b9ad67a67d
+  metadata.gz: a30bd4ac0758ae652ca00b17cde853f5f2c5bb3d1f0f5693bcabac1cd92908c8
+  data.tar.gz: feeec51aa3774396fc6545ff3774ef24cb3bafa8a62820f0ade1ddd73317a012
 SHA512:
-  metadata.gz: 45db88812fd762bcc175bce07bd8bcd89637940697f83321af415167467d842610512f8d434c2aac8b75386c0e63722e99f04fa19c3b86041bb47f35aa80fc35
-  data.tar.gz: 33ae1ed95b0b7d869916b25dc2596ba889739e81a21d42113d2eb54cb184b23e6c1b6ea26e14129c796ca8ddf24a4aa693db52b7ff1ad123b9b6d7081ad4f89c
+  metadata.gz: 9cdb38e58102f651e5cf73213ec32259fff56c29ce6b6f8eb54657d0159336cf179d46858228b9c9fde0516f194e6887b6216f547bab54e4ba793b5aee2eb712
+  data.tar.gz: 9e802feeff3d3204907c1e8c9feb786e6f26ec857997b6037fb5cd5ffd9958a93678ef076c4e31faba3735066f637ebeecaf89392338d4ddf2e572bae0a5936d

data/app/platform_api/schema/invoice.rb

@@ -5,17 +5,17 @@ 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.
-  #             
+  # 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 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
@@ -31,23 +31,23 @@ end
   # @format: uuid
   field :customer_id
 
-  # The unique ID of this record as it was known in its originating financial system.
-  #             
-  # If this company 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 company 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 "Purchase Order Code" is a code that is sometimes used by companies to refer to the original PO
-  # that was sent that caused this invoice to be written.  If a customer sends a purchase order to a vendor,
+  # The "Purchase Order Code" is a code that is sometimes used by companies to refer to the original PO
+  # that was sent that caused this invoice to be written.  If a customer sends a purchase order to a vendor,
   # the vendor can then create an invoice and refer back to the originating purchase order using this field.
   # @type: string
   field :purchase_order_code
 
-  # An additional reference code that is sometimes used to identify this invoice.
+  # An additional reference code that is sometimes used to identify this invoice.
   # The meaning of this field is specific to the ERP or accounting system used by the user.
   # @type: string
   field :reference_code
@@ -60,25 +60,25 @@ end
   # @type: string
   field :salesperson_name
 
-  # A code identifying the type of this invoice.
-  #             
-  # 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
+  # A code identifying the type of this invoice.
+  #             
+  # 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
   # @type: string
   field :invoice_type_code
 
-  # A code identifying the status of this invoice.
-  #             
-  # Recognized Invoice status codes are:
-  # * `Open` - Represents an invoice that is considered open and needs more work to complete
+  # A code identifying the status of this invoice.
+  #             
+  # 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
   # @type: string
   field :invoice_status_code
 
-  # A code identifying the terms given to the purchaser.  This field is imported directly from the originating
+  # 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
   field :terms_code
@@ -126,7 +126,7 @@ end
   # @format: date
   field :posted_date
 
-  # The date when the invoice was closed and finalized after completion of all payments and delivery of all products and
+  # 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
@@ -177,9 +177,9 @@ end
   # @format: uuid
   field :modified_user_id
 
-  # 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
@@ -206,15 +206,35 @@ end
   # @format: double
   field :currency_rate
 
-  # The Company associated to this invoice.
+  # The Currency Rate used to get from the account's base currency to the total amount.
+  # @type: number
+  # @format: double
+  field :baseCurrencyTotalAmount
+
+  # The sales tax amount in the group's base currency.
+  # @type: number
+  # @format: double
+  field :baseCurrencySalesTaxAmount
+
+  # The discount amount in the group's base currency.
+  # @type: number
+  # @format: double
+  field :baseCurrencyDiscountAmount
+
+  # The outstanding balance amount in the group's base currency.
+  # @type: number
+  # @format: double
+  field :baseCurrencyOutstandingBalanceAmount
+
+  # The Company associated to this invoice.
   # To retrieve this item, specify `Company` in the "Include" parameter for your query.
   field :company
 
-  # The Customer associated to the invoice customer
+  # The Customer associated to the invoice customer
   # To retrieve this item, specify `Customer` in the "Include" parameter for your query.
   field :customer
 
-  # The Contact associated to the invoice customer
+  # The Contact associated to the invoice customer
   # To retrieve this item, specify `Customer` in the "Include" parameter for your query.
   field :customer_primary_contact
 

data/app/platform_api/schema/invoice_at_risk_summary.rb

@@ -83,6 +83,20 @@ end
   # @type: array
   field :payment_ids
 
+  # The base currency code of the group.
+  # @type: string
+  field :baseCurrencyCode
+
+  # The total amount of the Invoice in the group's currency.
+  # @type: number
+  # @format: double
+  field :baseCurrencyInvoiceAmount
+
+  # The remaining balance value of this invoice in the group's currency.
+  # @type: number
+  # @format: double
+  field :baseCurrencyOutstandingBalance
+
   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.rb

@@ -5,9 +5,9 @@ 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.
-  #             
+  # 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
@@ -23,7 +23,7 @@ end
   # @format: uuid
   field :invoice_id
 
-  # A reference code that is used to identify this invoice.
+  # A reference code that is used to identify this invoice.
   # The meaning of this field is specific to the ERP or accounting system used by the user.
   # @type: string
   field :invoice_number
@@ -33,7 +33,7 @@ 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
+  # 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
@@ -81,7 +81,7 @@ end
   # @format: int32
   field :payment_count
 
-  # Specific invoices have support for pdf retrieval from their respective erp. When this flag is true, an additional
+  # 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
@@ -94,6 +94,20 @@ end
   # @type: array
   field :payment_ids
 
+  # The group's base currency code.
+  # @type: string
+  field :baseCurrencyCode
+
+  # The invoice amount in the group's base currency.
+  # @type: number
+  # @format: double
+  field :baseCurrencyInvoiceAmount
+
+  # The outstanding balance amount in the group's base currency.
+  # @type: number
+  # @format: double
+  field :baseCurrencyOutstandingBalanceAmount
+
   # The modified date of the invoice.
   # @type: string
   # @format: date-time

data/app/platform_api/schema/payable_coming_due_summary_report.rb

@@ -45,4 +45,8 @@ end
   # @type: string
   # @format: date-time
   field :dueDate, Types::Params::DateTime
+
+  # The base currency code of the group.
+  # @type: string
+  field :baseCurrencyCode
 end

data/app/platform_api/schema/payment.rb

@@ -5,17 +5,17 @@ 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.
-  #             
+  # 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 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
@@ -26,36 +26,36 @@ end
   # @format: uuid
   field :company_id
 
-  # The unique ID of this record as it was known in its originating financial system.
-  #             
-  # If this company 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 company 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 type of payment, AR Payment or AP Payment.
-  #             
-  # Recognized PaymentType values are:
-  # * `AR Payment` - A payment made by a Customer to the Company
+  # 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.
+  # 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
 
-  # True if this payment includes some unassigned amount that has not yet been applied to an invoice.  If this
+  # 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
@@ -64,15 +64,15 @@ end
   # @type: string
   field :memo_text
 
-  # The date when this payment was received.  This typically is the date when an accounting employee recorded
-  # that they received notification that the payment had occurred, whether they were notified by email, postal
+  # The date when this payment was received.  This typically is the date when an accounting employee recorded
+  # that they received notification that the payment had occurred, whether they were notified by email, postal
   # mail, or financial transaction notification.
   # @type: string
   # @format: date
   field :payment_date
 
-  # The date when a payment was posted to a ledger.  This date is often determined by a company's accounting
-  # practices and may be different than the date when the payment was received.  This date may be affected by
+  # The date when a payment was posted to a ledger.  This date is often determined by a company's accounting
+  # practices and may be different than the date when the payment was received.  This date may be affected by
   # issues such as temporary holds on funds transferred, bank holidays, or other actions.
   # @type: string
   # @format: date
@@ -88,8 +88,8 @@ end
   # @format: double
   field :unapplied_amount
 
-  # The ISO 4217 currency code for this payment.
-  #             
+  # 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/definitions/currencies data set
   # @type: string
   field :currency_code
@@ -118,9 +118,9 @@ end
   # @format: uuid
   field :modified_user_id
 
-  # 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
@@ -139,6 +139,17 @@ end
   # @format: double
   field :currency_rate
 
+  # Total amount of this payment in the group's base currency.
+  # @type: number
+  # @format: double
+  field :baseCurrencyPaymentAmount
+
+  # Unapplied balance of this payment in the group's base currency. If this amount is nonzero, the field IsOpen will be true.
+  # @type: number
+  # @format: double
+  field :baseCurrencyUnappliedAmount
+
+
   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 :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}

data/app/platform_api/schema/payment_summary.rb

@@ -5,9 +5,9 @@ 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.
-  #             
+  # 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
@@ -49,7 +49,7 @@ 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
+  # 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
@@ -81,7 +81,7 @@ end
   # @type: string
   field :payment_company_name
 
-  # Specific payments have support for pdf retrieval from their respective erp. When this flag is true, an additional
+  # Specific payments have support for pdf retrieval from their respective erp. When this flag is true, an additional
   # call to Payments/{id}/pdf can be made to retrieve a pdf directly from the erp.
   # @type: boolean
   field :supports_erp_pdf_retrieval
@@ -102,6 +102,20 @@ end
   # @type: array
   field :company_names
 
+  # The base currency code of the group.
+  # @type: string
+  field :baseCurrencyCode
+
+  # The payment amount in the group's base currency.
+  # @type: number
+  # @format: double
+  field :baseCurrencyPaymentAmount
+
+  # The unapplied amount in the group's base currency.
+  # @type: number
+  # @format: double
+  field :baseCurrencyUnappliedAmount
+
   # The modified date of the payment
   # @type: string
   # @format: date-time

data/lib/lockstep_rails/version.rb

@@ -1,3 +1,3 @@
 module LockstepRails
-  VERSION = '0.3.47'
+  VERSION = '0.3.48'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockstep_rails
 version: !ruby/object:Gem::Version
-  version: 0.3.47
+  version: 0.3.48
 platform: ruby
 authors:
 - Vivek AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-27 00:00:00.000000000 Z
+date: 2023-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails