lockstep_rails 0.3.73 → 0.3.74

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fcb46b4df1534d7fa736686ffbedf749a1a578aec9f7c187abf6217193ce772
-  data.tar.gz: ba6d8d38b3ae0de5f5df13dcded545da3d97106aa8c8b8f6b86f21260ebf78cc
+  metadata.gz: 911c3903517344a7853c2bfb5c23857f4be16f6d8a6a96064ec6d5567cb5dfa3
+  data.tar.gz: 32831226db82f62df9f1943436e22204e793d221fd622f7df7d5d3bb4c72f8aa
 SHA512:
-  metadata.gz: 7dfe1a0ff3b7404ab7b32434045ab8a0560aef807f31b2650054a6aa2d38d237983b153e9f12dc496efcf3769ec14772a07d755153c002d501b6ec600611f0ff
-  data.tar.gz: 10712af1f384b8705373f2995f7faf31289f3914c488e0cf12eb71e46f31134dfa33a9389da2592b3e33aa468af1404fb5ecf454bd24674513025d269cedb440
+  metadata.gz: 8e13d83274513f7b1939243c66062f305fae374a2c6c1ab9bd6b113fabdaca6de71e1cd8fb7c82040e63b818c23c2aa0444210b79848d4b02f7086d8a270a2c7
+  data.tar.gz: 26cc1f14b52406d0a3630702539b6c8a9e4eb1ecdf8b0e957996fe83c755fe92a281c22a81ed81bc7b1e48eea34e2f0cce611aa89a382d3562c4380f1fab3d90

data/app/models/lockstep/invoice.rb

@@ -7,7 +7,7 @@ class Lockstep::Invoice < Lockstep::ApiRecord
 
   belongs_to :connection, class_name: 'Lockstep::Connection', foreign_key: :customer_id
 
-  scope :einvoices, -> { where(is_e_invoice: true).include_object(:customer, :lines) }
+  scope :einvoices, -> { where(is_e_invoice: true).include_object(:customer, :lines, :attachments) }
   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

@@ -49,8 +49,8 @@ end
   field :point_of_contact
 
   # The total outstanding amount for this company
-  # @type: integer
-  # @format: int32
+  # @type: number
+  # @format: double
   field :outstanding_amount
 
   # The total number of open invoices for this company

data/app/platform_api/schema/credit_memo_applied.rb

@@ -104,6 +104,10 @@ end
   # @format: date-time
   field :source_modified_date, Types::Params::DateTime
 
+  # Additional attributes that may be required by the source system.
+  # @type: object
+  field :erp_system_attributes
+
   # The credit memo invoice associated with this applied credit memo
   field :credit_memo_invoice
 

data/app/platform_api/schema/credit_memo_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 Credit Memo 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.
@@ -27,6 +32,11 @@ end
   # @type: string
   field :invoice_erp_key
 
+  # The network id of the parent Invoice.
+  # @type: string
+  # @format: uuid
+  field :invoice_network_id
+
   # This field indicates which Invoice is the original credit memo that was used to make this payment
   # application event.  In this field, identify the original primary key or unique ID of the Invoice which
   # created the credit memo that was consumed in this event.

data/app/platform_api/schema/e_invoice_attachment.rb

@@ -0,0 +1,26 @@
+class Schema::EInvoiceAttachment < 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 platform.
+  # @type: string
+  field :attachment_id
+
+  # An Attachment represents a file that was uploaded to the Platform.This field contains the original name of the file on disk, without its extension.
+  # @type: string
+  field :file_name
+
+  # An Attachment represents a file that was uploaded to the Platform.  This field contains the original extension name of the file on disk.
+  # @type: string
+  field :file_ext
+
+  # A text string describing the type of this Attachment.
+  # @type: string
+  field :attachment_type
+
+
+
+end

data/app/platform_api/schema/error.rb

@@ -0,0 +1,33 @@
+class Schema::Error < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Status of  error
+  # @type: integer
+  # @format: int32
+  field :status
+
+  # Source of Error
+  field :source
+
+  # Error Detail
+  # @type: string
+  field :detail
+
+  # Errors Title
+  # @type: string
+  field :title
+
+  # Errors code
+  # @type: string
+  field :code
+
+  # Contains meta about entity
+  field :entity_meta
+
+
+
+end

data/app/platform_api/schema/financial_account.rb

@@ -63,6 +63,10 @@ end
   # @type: string
   field :subcategory
 
+  # The system account type of the Financial Account.
+  # @type: string
+  field :system_account_type
+
   # The date the FinancialAccount was created.
   # @type: string
   # @format: date-time

data/app/platform_api/schema/financial_account_sync.rb

@@ -48,6 +48,10 @@ end
   # @type: string
   field :subcategory
 
+  # The system account type of the Financial Account.
+  # @type: string
+  field :system_account_type
+
 
 
 end

data/app/platform_api/schema/inbound_company_sync.rb

@@ -0,0 +1,151 @@
+class Schema::InboundCompanySync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique identifier of this object in the Sage Network platform.
+  # @type: string
+  # @format: uuid
+  field :network_id
+
+  # Read or write operation for sync
+  # @type: string
+  field :operation_type
+
+  # The short name of the company.
+  # @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.
+  #             
+  # The following are the company types currently supported for Erp Writes
+  #             
+  # * `Customer` - This record represents a business entity that purchases things from the account holder.
+  # * `Vendor` - This record represents a business entity that sells things to the account holder.
+  # * `CustomerVendor` - Both a customer and a vendor.
+  # @type: string
+  field :company_type
+
+  # If this business entity is part of an organization, this value is non-null and it is set
+  # to the `CompanyId` value of the parent company of this business entity.
+  #             
+  # If this value is null, this business entity is a standalone.
+  # @type: string
+  # @format: uuid
+  field :parent_company_network_id
+
+  # The unique ID of the parent company as it was known in its originating financial system.
+  # @type: string
+  field :parent_company_erp_key
+
+  # The default currency code used by this business entity.  This value can be overridden
+  # for invoices in a different currency code.
+  #             
+  # For a list of defined currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies)
+  # @type: string
+  field :default_currency_code
+
+  # The external reference of the company.
+  #             
+  # For Sage Intacct enrollments this field is required and must be a unique value to be used as the Vendor Id
+  # @type: string
+  field :external_reference
+
+  # Federal Tax ID
+  # @type: string
+  field :tax_id
+
+  # For convenience, this field indicates the top-level parent company.  This can be used
+  # to jump directly to the top parent in complex organizational hierarchies.
+  # @type: string
+  # @format: uuid
+  field :enterprise_id
+
+  # The unique ID of the enterprise as it was known in its originating financial system.
+  # @type: string
+  field :enterprise_erp_key
+
+  # The first line of the address.
+  # @type: string
+  field :address1
+
+  # The second line of the address.
+  # @type: string
+  field :address2
+
+  # The third line of the address.
+  # @type: string
+  field :address3
+
+  # The city of the address.
+  # @type: string
+  field :city
+
+  # The state/region of the address.
+  # @type: string
+  field :state_region
+
+  # The postal/zip code of the address.
+  # @type: string
+  field :postal_code
+
+  # The two character country code of the address.
+  # @type: string
+  field :country
+
+  # Time zone
+  # @type: string
+  field :time_zone
+
+  # Phone number
+  # @type: string
+  field :phone_number
+
+  # Fax number
+  # @type: string
+  field :fax_number
+
+  # Company Email Address
+  # @type: string
+  field :email_address
+
+  # Dun & Bradstreet Number
+  # @type: string
+  field :duns_number
+
+  # Federal Tax ID
+  # @type: string
+  field :state_tax_id
+
+  # The state where the company was registered.
+  # @type: string
+  field :state_of_incorporation
+
+  # The primary contact for the company.
+  field :primary_contact
+
+  # Sync time
+  # @type: string
+  # @format: date-time
+  field :timestamp, Types::Params::DateTime
+
+  # Last Sync time
+  # @type: string
+  # @format: date-time
+  field :last_attempted, Types::Params::DateTime
+
+  # Erp write status
+  # @type: string
+  field :status
+
+  # Erp write status message
+  # @type: string
+  field :message
+
+
+
+end

data/app/platform_api/schema/inbound_invoice_sync.rb

@@ -0,0 +1,147 @@
+class Schema::InboundInvoiceSync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # Sync operation type whether it is read or write
+  # @type: string
+  field :operation_type
+
+  # Required when submitting updates for an existing record.
+  # @type: string
+  # @format: uuid
+  field :network_id
+
+  # The id for this invoice supplied by the originating party.
+  # @type: string
+  field :invoice_reference_code
+
+  # 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
+
+  # This flag Indicates if this invoice is E-invoice.
+  # When True, all fields other than erpKey, companyERPKey, and customerERPKey become optional.
+  # Model most also contain at least one e-invoice file type.
+  # @type: boolean
+  field :is_e_invoice
+
+  # File Data model is child model for Invoice and InvoiceInboundSync model represents file name and file path.
+  # This model is use for EInvoice request.
+  # For more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data).
+  field :attachments
+
+  # The network id of the related Company.
+  # @type: string
+  # @format: uuid
+  field :customer_network_id
+
+  # The total value of this invoice, inclusive of all taxes and line items.
+  # @type: number
+  # @format: double
+  field :total_amount
+
+  # The three-character ISO 4217 currency code used for this invoice.
+  # @type: string
+  field :currency_code
+
+  # The reporting date for this invoice in "YYYY-MM-DD" format.
+  # @type: string
+  # @format: date-time
+  field :invoice_date, Types::Params::DateTime
+
+  # The date on which this invoice record was created.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # Flags if this invoice request isto be posted as a draft
+  # @type: boolean
+  field :is_draft
+
+  # The department this line item belongs to.
+  # @type: string
+  field :department_erp_key
+
+  # Description of this invoice line.
+  # @type: string
+  field :description
+
+  # The total discounts given by the seller to the buyer on this invoice.
+  # @type: number
+  # @format: double
+  field :discount_amount
+
+  # The remaining balance value of this invoice.
+  # @type: number
+  # @format: double
+  field :outstanding_balance_amount
+
+  # The date when the remaining outstanding balance is due in "YYYY-MM-DD" format.
+  # @type: string
+  # @format: date-time
+  field :payment_due_date, Types::Params::DateTime
+
+  # The payment priority level for this invoice.
+  # @type: string
+  field :payment_priority
+
+  # 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.
+  # The meaning of this field is specific to the ERP or accounting system used by the user.
+  # @type: string
+  field :reference_code
+
+  # A code identifying the salesperson responsible for writing this invoice.
+  # @type: string
+  field :sales_person_code
+
+  # The total sales (or transactional) tax calculated for this invoice.
+  # @type: number
+  # @format: double
+  field :sales_tax_amount
+
+  # The name of the billing terms for this invoice.
+  # @type: string
+  field :term_name
+
+  # Sync time
+  # @type: string
+  # @format: date-time
+  field :timestamp, Types::Params::DateTime
+
+  # Last Sync time
+  # @type: string
+  # @format: date-time
+  field :last_attempted, Types::Params::DateTime
+
+  # Erp write status
+  # @type: string
+  field :status
+
+  # Erp write status message
+  # @type: string
+  field :message
+
+  # When true, indicates that invoice should be immediately sent to customer via designated channel.
+  # Intended for use by e-Invoices.
+  # @type: boolean
+  field :send_immediately
+
+
+  has_many :lines, {:class_name=>"Schema::InboundSyncInvoiceLines", :included=>true}
+
+end

data/app/platform_api/schema/inbound_payment_application.rb

@@ -0,0 +1,50 @@
+class Schema::InboundPaymentApplication < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique identifier of this object in the Sage Network platform.
+  # @type: string
+  # @format: uuid
+  field :network_id
+
+  # The network id of the related Payment.
+  # @type: string
+  # @format: uuid
+  field :payment_network_id
+
+  # This field indicates which Invoice had its balance reduced by applying this payment.  In this field,
+  # identify the original primary key or unique ID of the Invoice which had its balance reduced.
+  #             
+  # This information lets you track how an invoice was paid. You can identify what proportion of an invoice's
+  # balance was paid by which methods by joining this field to Invoices.
+  #             
+  # This value should match the [Invoice ErpKey](https://developer.lockstep.io/docs/importing-invoices#erpkey)
+  # field on the [InvoiceSyncModel](https://developer.lockstep.io/docs/importing-invoices).
+  # @type: string
+  field :invoice_erp_key
+
+  # 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.
+  #             
+  # Since Payment Applications are often considered transactions, a typical value to look for will be
+  # the transaction ID number, the payment confirmation number, or some other record of this payment.
+  #             
+  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+  # @type: string
+  field :erp_key
+
+  # Nested invoice object
+  field :invoice
+
+  # The total amount that was applied to this Invoice from the Payment.
+  # @type: number
+  # @format: double
+  field :payment_applied_amount
+
+
+
+end

data/app/platform_api/schema/inbound_payment_sync.rb

@@ -0,0 +1,109 @@
+class Schema::InboundPaymentSync < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # CUD operation type
+  # @type: string
+  field :operation_type
+
+  # Contains details to create an payment in the ERP
+  # @type: string
+  # @format: uuid
+  field :network_id
+
+  # The CompanyId of the connected Payment
+  # @type: string
+  # @format: uuid
+  field :company_network_id
+
+  # The CompanyErpKey of the connected Payment
+  # @type: string
+  field :company_erp_key
+
+  # The PaymentType of the connected Payment
+  # @type: string
+  field :payment_type
+
+  # Payment amount of the connected Payment
+  # @type: number
+  # @format: double
+  field :payment_amount
+
+  # The CurrencyCode of the connected Payment
+  # @type: string
+  field :currency_code
+
+  # The CurrencyRate of the connected Payment
+  # @type: number
+  # @format: double
+  field :currency_rate
+
+  # The BankAccountId of the connected Payment
+  # @type: string
+  field :bank_account_id
+
+  # The PostDate of the connected Payment
+  # @type: string
+  # @format: date-time
+  field :payment_date, Types::Params::DateTime
+
+  # The PostDate of the connected Payment
+  # @type: string
+  # @format: date-time
+  field :post_date, Types::Params::DateTime
+
+  # The ErpKey of the connected Payment
+  # @type: string
+  field :erp_key
+
+  # The TenderType of the connected Payment
+  # @type: string
+  field :tender_type
+
+  # The MemoText of the connected Payment
+  # @type: string
+  field :memo_text
+
+  # The UnappliedAmount of the connected Payment
+  # @type: number
+  # @format: double
+  field :unapplied_amount
+
+  # The BaseCurrencyPaymentAmount of the connected Payment
+  # @type: number
+  # @format: double
+  field :base_currency_payment_amount
+
+  # The BaseCurrencyUnappliedAmount of the connected Payment
+  # @type: number
+  # @format: double
+  field :base_currency_unapplied_amount
+
+  # Nested object of company object
+  field :company
+
+  # Sync time
+  # @type: string
+  # @format: date-time
+  field :timestamp, Types::Params::DateTime
+
+  # Last sync time
+  # @type: string
+  # @format: date-time
+  field :last_attempted, Types::Params::DateTime
+
+  # Sync status
+  # @type: string
+  field :status
+
+  # Sync status message
+  # @type: string
+  field :message
+
+
+  has_many :applications, {:class_name=>"Schema::InboundPaymentApplication", :included=>true}
+
+end

data/app/platform_api/schema/inbound_sync_invoice_lines.rb

@@ -0,0 +1,67 @@
+class Schema::InboundSyncInvoiceLines < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique identifier of this object in the Sage Network platform.
+  # @type: string
+  # @format: uuid
+  field :network_id
+
+  # The GL account no to associate this line item with
+  # @type: string
+  field :account_no
+
+  # The account label to associate this line item with
+  # @type: string
+  field :account_label
+
+  # The department this line item belongs to.
+  # @type: string
+  field :department_erp_key
+
+  # Description of this invoice line.
+  # @type: string
+  field :description
+
+  # The line number of this line.
+  # @type: string
+  field :line_number
+
+  # The location this line item belongs to.
+  # @type: string
+  field :location_erp_key
+
+  # Offset account for this line item.
+  # @type: string
+  field :offset_gl_account_no
+
+  # A code number identifying the product or service that is specified on this line.
+  # @type: string
+  field :product_code
+
+  # The quantity of items for ths line.
+  # @type: number
+  # @format: double
+  field :quantity
+
+  # For lines measured in a unit other than "quantity", this code indicates the measurement system for the quantity field.
+  # If the line is measured in quantity, this field is null.
+  # @type: string
+  field :unit_measure_code
+
+  # The price of a single unit for this line.
+  # @type: number
+  # @format: double
+  field :unit_price
+
+  # The total amount for this line.
+  # @type: number
+  # @format: double
+  field :total_amount
+
+
+
+end