lockstep_sdk 2022.4.32.0

data/lib/lockstep_sdk/models/invoice_line_model.rb

@@ -0,0 +1,194 @@
+#
+# Lockstep Software Development Kit for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents a line in an invoice
+    class InvoiceLineModel
+
+        ##
+        # Initialize the InvoiceLineModel using the provided prototype
+        def initialize(params = {})
+            @invoice_line_id = params.dig(:invoice_line_id)
+            @group_key = params.dig(:group_key)
+            @invoice_id = params.dig(:invoice_id)
+            @erp_key = params.dig(:erp_key)
+            @line_number = params.dig(:line_number)
+            @product_code = params.dig(:product_code)
+            @description = params.dig(:description)
+            @unit_measure_code = params.dig(:unit_measure_code)
+            @unit_price = params.dig(:unit_price)
+            @quantity = params.dig(:quantity)
+            @quantity_shipped = params.dig(:quantity_shipped)
+            @quantity_received = params.dig(:quantity_received)
+            @total_amount = params.dig(:total_amount)
+            @exemption_code = params.dig(:exemption_code)
+            @reporting_date = params.dig(:reporting_date)
+            @override_origin_address_id = params.dig(:override_origin_address_id)
+            @override_bill_to_address_id = params.dig(:override_bill_to_address_id)
+            @override_ship_to_address_id = params.dig(:override_ship_to_address_id)
+            @created = params.dig(:created)
+            @created_user_id = params.dig(:created_user_id)
+            @modified = params.dig(:modified)
+            @modified_user_id = params.dig(:modified_user_id)
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @notes = params.dig(:notes)
+            @attachments = params.dig(:attachments)
+        end
+
+        ##
+        # @return [Uuid] 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`.
+        attr_accessor :invoice_line_id
+
+        ##
+        # @return [Uuid] 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).
+        attr_accessor :group_key
+
+        ##
+        # @return [Uuid] The ID number of the invoice this line belongs to.
+        attr_accessor :invoice_id
+
+        ##
+        # @return [String] The unique ID of this record as it was known in its originating financial system, if it was different from the original `LineNumber`. 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).
+        attr_accessor :erp_key
+
+        ##
+        # @return [String] 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.
+        attr_accessor :line_number
+
+        ##
+        # @return [String] A code number identifying the product or service that is specified on this line.
+        attr_accessor :product_code
+
+        ##
+        # @return [String] Description of this invoice line.
+        attr_accessor :description
+
+        ##
+        # @return [String] 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.
+        attr_accessor :unit_measure_code
+
+        ##
+        # @return [Double] The price of a single unit for this line.
+        attr_accessor :unit_price
+
+        ##
+        # @return [Double] The quantity of items for ths line.
+        attr_accessor :quantity
+
+        ##
+        # @return [Double] The number of items that have been shipped.
+        attr_accessor :quantity_shipped
+
+        ##
+        # @return [Double] The number of items that has been received.
+        attr_accessor :quantity_received
+
+        ##
+        # @return [Double] The total amount for this line.
+        attr_accessor :total_amount
+
+        ##
+        # @return [String] If this line is tax exempt, this code indicates the reason for the exemption.
+        attr_accessor :exemption_code
+
+        ##
+        # @return [Date] If null, the products specified on this line were delivered on the same date as all other lines. If not null, this line was delivered or finalized on a different date than the overall invoice.
+        attr_accessor :reporting_date
+
+        ##
+        # @return [Uuid] An optional ID number for the line's origin address.
+        attr_accessor :override_origin_address_id
+
+        ##
+        # @return [Uuid] An optional ID number for the line's bill to address.
+        attr_accessor :override_bill_to_address_id
+
+        ##
+        # @return [Uuid] An optional ID number for the line's ship to address.
+        attr_accessor :override_ship_to_address_id
+
+        ##
+        # @return [Date-time] The date on which this line was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The ID number of the user who created this line.
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date on which this line was last modified.
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The ID number of the user who most recently modified this line.
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [NoteModel] All notes attached to this company. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        attr_accessor :notes
+
+        ##
+        # @return [AttachmentModel] All attachments attached to this company. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        attr_accessor :attachments
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'invoiceLineId' => @invoice_line_id,
+                'groupKey' => @group_key,
+                'invoiceId' => @invoice_id,
+                'erpKey' => @erp_key,
+                'lineNumber' => @line_number,
+                'productCode' => @product_code,
+                'description' => @description,
+                'unitMeasureCode' => @unit_measure_code,
+                'unitPrice' => @unit_price,
+                'quantity' => @quantity,
+                'quantityShipped' => @quantity_shipped,
+                'quantityReceived' => @quantity_received,
+                'totalAmount' => @total_amount,
+                'exemptionCode' => @exemption_code,
+                'reportingDate' => @reporting_date,
+                'overrideOriginAddressId' => @override_origin_address_id,
+                'overrideBillToAddressId' => @override_bill_to_address_id,
+                'overrideShipToAddressId' => @override_ship_to_address_id,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_user_id,
+                'appEnrollmentId' => @app_enrollment_id,
+                'notes' => @notes,
+                'attachments' => @attachments,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/invoice_model.rb

@@ -0,0 +1,325 @@
+#
+# Lockstep Software Development Kit for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # An Invoice represents a bill sent from one company to another.  The creator of the invoice is identified
+    # by the `CompanyId` field, and the recipient of the invoice is identified by the `CustomerId` field.  Most
+    # invoices are uniquely identified both by a Lockstep Platform ID number and a customer ERP "key" that was
+    # generated by the system that originated the invoice.  Invoices have a total amount and a due date, and when
+    # some payments have been made on the Invoice the `TotalAmount` and the `OutstandingBalanceAmount` may be
+    # different.
+    class InvoiceModel
+
+        ##
+        # Initialize the InvoiceModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @invoice_id = params.dig(:invoice_id)
+            @company_id = params.dig(:company_id)
+            @customer_id = params.dig(:customer_id)
+            @erp_key = params.dig(:erp_key)
+            @purchase_order_code = params.dig(:purchase_order_code)
+            @reference_code = params.dig(:reference_code)
+            @salesperson_code = params.dig(:salesperson_code)
+            @salesperson_name = params.dig(:salesperson_name)
+            @invoice_type_code = params.dig(:invoice_type_code)
+            @invoice_status_code = params.dig(:invoice_status_code)
+            @terms_code = params.dig(:terms_code)
+            @special_terms = params.dig(:special_terms)
+            @currency_code = params.dig(:currency_code)
+            @total_amount = params.dig(:total_amount)
+            @sales_tax_amount = params.dig(:sales_tax_amount)
+            @discount_amount = params.dig(:discount_amount)
+            @outstanding_balance_amount = params.dig(:outstanding_balance_amount)
+            @invoice_date = params.dig(:invoice_date)
+            @discount_date = params.dig(:discount_date)
+            @posted_date = params.dig(:posted_date)
+            @invoice_closed_date = params.dig(:invoice_closed_date)
+            @payment_due_date = params.dig(:payment_due_date)
+            @imported_date = params.dig(:imported_date)
+            @primary_origin_address_id = params.dig(:primary_origin_address_id)
+            @primary_bill_to_address_id = params.dig(:primary_bill_to_address_id)
+            @primary_ship_to_address_id = params.dig(:primary_ship_to_address_id)
+            @created = params.dig(:created)
+            @created_user_id = params.dig(:created_user_id)
+            @modified = params.dig(:modified)
+            @modified_user_id = params.dig(:modified_user_id)
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @is_voided = params.dig(:is_voided)
+            @in_dispute = params.dig(:in_dispute)
+            @exclude_from_aging = params.dig(:exclude_from_aging)
+            @addresses = params.dig(:addresses)
+            @lines = params.dig(:lines)
+            @payments = params.dig(:payments)
+            @notes = params.dig(:notes)
+            @attachments = params.dig(:attachments)
+            @company = params.dig(:company)
+            @customer = params.dig(:customer)
+            @customer_primary_contact = params.dig(:customer_primary_contact)
+            @credit_memos = params.dig(:credit_memos)
+            @custom_field_values = params.dig(:custom_field_values)
+            @custom_field_definitions = params.dig(:custom_field_definitions)
+        end
+
+        ##
+        # @return [Uuid] 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).
+        attr_accessor :group_key
+
+        ##
+        # @return [Uuid] 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`.
+        attr_accessor :invoice_id
+
+        ##
+        # @return [Uuid] The ID number of the company that created this invoice.
+        attr_accessor :company_id
+
+        ##
+        # @return [Uuid] The ID number of the counterparty for the invoice, for example, a customer or vendor.
+        attr_accessor :customer_id
+
+        ##
+        # @return [String] 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).
+        attr_accessor :erp_key
+
+        ##
+        # @return [String] The purchase order code as it exists in the user's ERP or accounting system.
+        attr_accessor :purchase_order_code
+
+        ##
+        # @return [String] 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.
+        attr_accessor :reference_code
+
+        ##
+        # @return [String] A code identifying the salesperson responsible for writing this quote, invoice, or order.
+        attr_accessor :salesperson_code
+
+        ##
+        # @return [String] A string identifying the salesperson responsible for writing this quote, invoice, or order.
+        attr_accessor :salesperson_name
+
+        ##
+        # @return [String] A code identifying the type of this invoice.
+        attr_accessor :invoice_type_code
+
+        ##
+        # @return [String] A code identifying the status of this invoice.
+        attr_accessor :invoice_status_code
+
+        ##
+        # @return [String] A code identifying the terms given to the purchaser.
+        attr_accessor :terms_code
+
+        ##
+        # @return [String] If the customer negotiated any special terms different from the standard terms above, describe them here.
+        attr_accessor :special_terms
+
+        ##
+        # @return [String] The three-character ISO 4217 currency code used for this invoice.
+        attr_accessor :currency_code
+
+        ##
+        # @return [Double] The total value of this invoice, inclusive of all taxes and line items.
+        attr_accessor :total_amount
+
+        ##
+        # @return [Double] The total sales (or transactional) tax calculated for this invoice.
+        attr_accessor :sales_tax_amount
+
+        ##
+        # @return [Double] The total discounts given by the seller to the buyer on this invoice.
+        attr_accessor :discount_amount
+
+        ##
+        # @return [Double] The remaining balance value of this invoice.
+        attr_accessor :outstanding_balance_amount
+
+        ##
+        # @return [Date] The reporting date for this invoice.
+        attr_accessor :invoice_date
+
+        ##
+        # @return [Date] The date when discounts were adjusted for this invoice.
+        attr_accessor :discount_date
+
+        ##
+        # @return [Date] The date when this invoice posted to the company's general ledger.
+        attr_accessor :posted_date
+
+        ##
+        # @return [Date] The date when the invoice was closed and finalized after completion of all payments and delivery of all products and services.
+        attr_accessor :invoice_closed_date
+
+        ##
+        # @return [Date] The date when the remaining outstanding balance is due.
+        attr_accessor :payment_due_date
+
+        ##
+        # @return [Date-time] The date and time when this record was imported from the user's ERP or accounting system.
+        attr_accessor :imported_date
+
+        ##
+        # @return [Uuid] The ID number of the invoice's origination address
+        attr_accessor :primary_origin_address_id
+
+        ##
+        # @return [Uuid] The ID number of the invoice's bill-to address
+        attr_accessor :primary_bill_to_address_id
+
+        ##
+        # @return [Uuid] The ID number of the invoice's ship-to address
+        attr_accessor :primary_ship_to_address_id
+
+        ##
+        # @return [Date-time] The date on which this address record was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The ID number of the user who created this address.
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date on which this address record was last modified.
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The ID number of the user who most recently modified this address.
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [Boolean] Is the invoice voided?
+        attr_accessor :is_voided
+
+        ##
+        # @return [Boolean] Is the invoice in dispute?
+        attr_accessor :in_dispute
+
+        ##
+        # @return [Boolean] Should the invoice be excluded from aging calculations?
+        attr_accessor :exclude_from_aging
+
+        ##
+        # @return [InvoiceAddressModel] All addresses connected to this invoice. To retrieve this collection, specify `Addresses` in the "Include" parameter for your query.
+        attr_accessor :addresses
+
+        ##
+        # @return [InvoiceLineModel] All lines attached to this invoice. To retrieve this collection, specify `Lines` in the "Include" parameter for your query.
+        attr_accessor :lines
+
+        ##
+        # @return [InvoicePaymentDetailModel] All payments attached to this invoice, the amount of the payment applied to this Invoice, and the date the Payment was applied. To retrieve this collection, specify `Payments` in the "Include" parameter for your query.
+        attr_accessor :payments
+
+        ##
+        # @return [NoteModel] All notes attached to this invoice. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        attr_accessor :notes
+
+        ##
+        # @return [AttachmentModel] All attachments attached to this invoice. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        attr_accessor :attachments
+
+        ##
+        # @return [CompanyModel] The Company associated to this invoice. To retrieve this item, specify `Company` in the "Include" parameter for your query.
+        attr_accessor :company
+
+        ##
+        # @return [CompanyModel] The Customer associated to the invoice customer To retrieve this item, specify `Customer` in the "Include" parameter for your query.
+        attr_accessor :customer
+
+        ##
+        # @return [ContactModel] The Contact associated to the invoice customer To retrieve this item, specify `Customer` in the "Include" parameter for your query.
+        attr_accessor :customer_primary_contact
+
+        ##
+        # @return [CreditMemoInvoiceModel] The credit memos associated to this invoice. To retrieve this item, specify `CreditMemos` in the "Include" parameter for your query.
+        attr_accessor :credit_memos
+
+        ##
+        # @return [CustomFieldValueModel] All custom field values associated with this invoice To retrieve this item, specify `CustomFieldValues` in the "Include" parameter for your query.
+        attr_accessor :custom_field_values
+
+        ##
+        # @return [CustomFieldDefinitionModel] All custom field definitions
+        attr_accessor :custom_field_definitions
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'invoiceId' => @invoice_id,
+                'companyId' => @company_id,
+                'customerId' => @customer_id,
+                'erpKey' => @erp_key,
+                'purchaseOrderCode' => @purchase_order_code,
+                'referenceCode' => @reference_code,
+                'salespersonCode' => @salesperson_code,
+                'salespersonName' => @salesperson_name,
+                'invoiceTypeCode' => @invoice_type_code,
+                'invoiceStatusCode' => @invoice_status_code,
+                'termsCode' => @terms_code,
+                'specialTerms' => @special_terms,
+                'currencyCode' => @currency_code,
+                'totalAmount' => @total_amount,
+                'salesTaxAmount' => @sales_tax_amount,
+                'discountAmount' => @discount_amount,
+                'outstandingBalanceAmount' => @outstanding_balance_amount,
+                'invoiceDate' => @invoice_date,
+                'discountDate' => @discount_date,
+                'postedDate' => @posted_date,
+                'invoiceClosedDate' => @invoice_closed_date,
+                'paymentDueDate' => @payment_due_date,
+                'importedDate' => @imported_date,
+                'primaryOriginAddressId' => @primary_origin_address_id,
+                'primaryBillToAddressId' => @primary_bill_to_address_id,
+                'primaryShipToAddressId' => @primary_ship_to_address_id,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_user_id,
+                'appEnrollmentId' => @app_enrollment_id,
+                'isVoided' => @is_voided,
+                'inDispute' => @in_dispute,
+                'excludeFromAging' => @exclude_from_aging,
+                'addresses' => @addresses,
+                'lines' => @lines,
+                'payments' => @payments,
+                'notes' => @notes,
+                'attachments' => @attachments,
+                'company' => @company,
+                'customer' => @customer,
+                'customerPrimaryContact' => @customer_primary_contact,
+                'creditMemos' => @credit_memos,
+                'customFieldValues' => @custom_field_values,
+                'customFieldDefinitions' => @custom_field_definitions,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/invoice_payment_detail_model.rb

@@ -0,0 +1,104 @@
+#
+# Lockstep Software Development Kit for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # View to return Payment Detail information for a given Invoice record.
+    class InvoicePaymentDetailModel
+
+        ##
+        # Initialize the InvoicePaymentDetailModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @payment_applied_id = params.dig(:payment_applied_id)
+            @invoice_id = params.dig(:invoice_id)
+            @payment_id = params.dig(:payment_id)
+            @apply_to_invoice_date = params.dig(:apply_to_invoice_date)
+            @payment_applied_amount = params.dig(:payment_applied_amount)
+            @reference_code = params.dig(:reference_code)
+            @company_id = params.dig(:company_id)
+            @payment_amount = params.dig(:payment_amount)
+            @unapplied_amount = params.dig(:unapplied_amount)
+        end
+
+        ##
+        # @return [Uuid] 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).
+        attr_accessor :group_key
+
+        ##
+        # @return [Uuid] The unique identifier of this PaymentApplied record.
+        attr_accessor :payment_applied_id
+
+        ##
+        # @return [Uuid] The database id of the invoice
+        attr_accessor :invoice_id
+
+        ##
+        # @return [Uuid] The database id of the Payment.
+        attr_accessor :payment_id
+
+        ##
+        # @return [Date] Date Payment applied to Invoice.
+        attr_accessor :apply_to_invoice_date
+
+        ##
+        # @return [Double] Amount applied to Invoice.
+        attr_accessor :payment_applied_amount
+
+        ##
+        # @return [String] An additional reference code that is sometimes used to identify this Payment. The meaning of this field is specific to the ERP or accounting system used by the user.
+        attr_accessor :reference_code
+
+        ##
+        # @return [Uuid] The ID number of the Company (CompanyType = "Customer") that created this Payment.
+        attr_accessor :company_id
+
+        ##
+        # @return [Double] The total value of this Payment.
+        attr_accessor :payment_amount
+
+        ##
+        # @return [Double] The remaining balance value of this Payment.
+        attr_accessor :unapplied_amount
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'paymentAppliedId' => @payment_applied_id,
+                'invoiceId' => @invoice_id,
+                'paymentId' => @payment_id,
+                'applyToInvoiceDate' => @apply_to_invoice_date,
+                'paymentAppliedAmount' => @payment_applied_amount,
+                'referenceCode' => @reference_code,
+                'companyId' => @company_id,
+                'paymentAmount' => @payment_amount,
+                'unappliedAmount' => @unapplied_amount,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end