lockstep_sdk 2022.4.32.0

data/lib/lockstep_sdk/models/ar_header_info_model.rb

@@ -0,0 +1,170 @@
+#
+# 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
+
+    ##
+    # Aggregated Accounts Receivable information.
+    class ArHeaderInfoModel
+
+        ##
+        # Initialize the ArHeaderInfoModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @report_period = params.dig(:report_period)
+            @total_customers = params.dig(:total_customers)
+            @total_invoices = params.dig(:total_invoices)
+            @total_invoiced_amount = params.dig(:total_invoiced_amount)
+            @total_unapplied_payments = params.dig(:total_unapplied_payments)
+            @total_collected = params.dig(:total_collected)
+            @total_ar_amount = params.dig(:total_ar_amount)
+            @total_invoices_paid = params.dig(:total_invoices_paid)
+            @total_invoices_past_due = params.dig(:total_invoices_past_due)
+            @total_invoices90_days_past_due = params.dig(:total_invoices90_days_past_due)
+            @total_past_due_amount = params.dig(:total_past_due_amount)
+            @total_past_due_amount90_days = params.dig(:total_past_due_amount90_days)
+            @percentage_of_total_ar = params.dig(:percentage_of_total_ar)
+            @dso = params.dig(:dso)
+            @total_invoice_amount_current_year = params.dig(:total_invoice_amount_current_year)
+            @total_invoice_amount_previous_year = params.dig(:total_invoice_amount_previous_year)
+            @total_payment_amount_current_year = params.dig(:total_payment_amount_current_year)
+            @total_collected_past_thirty_days = params.dig(:total_collected_past_thirty_days)
+            @total_invoices_paid_past_thirty_days = params.dig(:total_invoices_paid_past_thirty_days)
+            @percentage_of_total_ar90_days_past_due = params.dig(:percentage_of_total_ar90_days_past_due)
+        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 [Date] The date of the report
+        attr_accessor :report_period
+
+        ##
+        # @return [Int32] The total number of customers.
+        attr_accessor :total_customers
+
+        ##
+        # @return [Int32] The total number of invoices.
+        attr_accessor :total_invoices
+
+        ##
+        # @return [Double] The total amount invoiced.
+        attr_accessor :total_invoiced_amount
+
+        ##
+        # @return [Double] The total number of unapplied payments.
+        attr_accessor :total_unapplied_payments
+
+        ##
+        # @return [Double] The total amount of collected payments.
+        attr_accessor :total_collected
+
+        ##
+        # @return [Double] The total accounts receivable amount.
+        attr_accessor :total_ar_amount
+
+        ##
+        # @return [Int32] The number of paid invoices.
+        attr_accessor :total_invoices_paid
+
+        ##
+        # @return [Int32] The number of past due invoices.
+        attr_accessor :total_invoices_past_due
+
+        ##
+        # @return [Int32] The number of past due invoices for the last 90 days.
+        attr_accessor :total_invoices90_days_past_due
+
+        ##
+        # @return [Double] The total amount past due.
+        attr_accessor :total_past_due_amount
+
+        ##
+        # @return [Double] The total past due for the past 90 days.
+        attr_accessor :total_past_due_amount90_days
+
+        ##
+        # @return [Double] Portion of Total AR that is Past due.
+        attr_accessor :percentage_of_total_ar
+
+        ##
+        # @return [Double] Daily sales outstanding.
+        attr_accessor :dso
+
+        ##
+        # @return [Double] The total amount invoiced, due this year.
+        attr_accessor :total_invoice_amount_current_year
+
+        ##
+        # @return [Double] The total amount invoiced, due last year.
+        attr_accessor :total_invoice_amount_previous_year
+
+        ##
+        # @return [Double] The total of all payments received this year.
+        attr_accessor :total_payment_amount_current_year
+
+        ##
+        # @return [Int32] The total amount of payments received in the last 30 days
+        attr_accessor :total_collected_past_thirty_days
+
+        ##
+        # @return [Int32] The total amount of Invoices paid in the last 30 days
+        attr_accessor :total_invoices_paid_past_thirty_days
+
+        ##
+        # @return [Double] Portion of Total AR that is 90+ days Past due.
+        attr_accessor :percentage_of_total_ar90_days_past_due
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'reportPeriod' => @report_period,
+                'totalCustomers' => @total_customers,
+                'totalInvoices' => @total_invoices,
+                'totalInvoicedAmount' => @total_invoiced_amount,
+                'totalUnappliedPayments' => @total_unapplied_payments,
+                'totalCollected' => @total_collected,
+                'totalArAmount' => @total_ar_amount,
+                'totalInvoicesPaid' => @total_invoices_paid,
+                'totalInvoicesPastDue' => @total_invoices_past_due,
+                'totalInvoices90DaysPastDue' => @total_invoices90_days_past_due,
+                'totalPastDueAmount' => @total_past_due_amount,
+                'totalPastDueAmount90Days' => @total_past_due_amount90_days,
+                'percentageOfTotalAr' => @percentage_of_total_ar,
+                'dso' => @dso,
+                'totalInvoiceAmountCurrentYear' => @total_invoice_amount_current_year,
+                'totalInvoiceAmountPreviousYear' => @total_invoice_amount_previous_year,
+                'totalPaymentAmountCurrentYear' => @total_payment_amount_current_year,
+                'totalCollectedPastThirtyDays' => @total_collected_past_thirty_days,
+                'totalInvoicesPaidPastThirtyDays' => @total_invoices_paid_past_thirty_days,
+                'percentageOfTotalAr90DaysPastDue' => @percentage_of_total_ar90_days_past_due,
+            }
+        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/at_risk_invoice_summary_model.rb

@@ -0,0 +1,140 @@
+#
+# 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
+
+    ##
+    # Contains summarized data for an invoice
+    class AtRiskInvoiceSummaryModel
+
+        ##
+        # Initialize the AtRiskInvoiceSummaryModel using the provided prototype
+        def initialize(params = {})
+            @report_date = params.dig(:report_date)
+            @group_key = params.dig(:group_key)
+            @customer_id = params.dig(:customer_id)
+            @invoice_id = params.dig(:invoice_id)
+            @invoice_number = params.dig(:invoice_number)
+            @invoice_date = params.dig(:invoice_date)
+            @customer_name = params.dig(:customer_name)
+            @status = params.dig(:status)
+            @payment_due_date = params.dig(:payment_due_date)
+            @invoice_amount = params.dig(:invoice_amount)
+            @outstanding_balance = params.dig(:outstanding_balance)
+            @invoice_type_code = params.dig(:invoice_type_code)
+            @newest_activity = params.dig(:newest_activity)
+            @days_past_due = params.dig(:days_past_due)
+            @payment_numbers = params.dig(:payment_numbers)
+            @payment_ids = params.dig(:payment_ids)
+        end
+
+        ##
+        # @return [Date] The date of the report
+        attr_accessor :report_date
+
+        ##
+        # @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 counterparty for the invoice, for example, a customer or vendor.
+        attr_accessor :customer_id
+
+        ##
+        # @return [Uuid] The unique ID number of this invoice.
+        attr_accessor :invoice_id
+
+        ##
+        # @return [String] 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.
+        attr_accessor :invoice_number
+
+        ##
+        # @return [Date] The reporting date for this invoice.
+        attr_accessor :invoice_date
+
+        ##
+        # @return [String] The name of the counterparty for the invoice, for example, a customer or vendor.
+        attr_accessor :customer_name
+
+        ##
+        # @return [String] The status of the invoice.
+        attr_accessor :status
+
+        ##
+        # @return [Date] The due date of the invoice.
+        attr_accessor :payment_due_date
+
+        ##
+        # @return [Double] The total amount of the Invoice.
+        attr_accessor :invoice_amount
+
+        ##
+        # @return [Double] The remaining balance value of this invoice.
+        attr_accessor :outstanding_balance
+
+        ##
+        # @return [String] A code identifying the type of this Invoice.
+        attr_accessor :invoice_type_code
+
+        ##
+        # @return [Date] The date stamp for the newest Activity on this Invoice.
+        attr_accessor :newest_activity
+
+        ##
+        # @return [Int32] The number of days this Invoice is past due.
+        attr_accessor :days_past_due
+
+        ##
+        # @return [String] The memo text of the payments associated to this invoice.
+        attr_accessor :payment_numbers
+
+        ##
+        # @return [Uuid] The ids of the payments associated to this invoice.
+        attr_accessor :payment_ids
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'reportDate' => @report_date,
+                'groupKey' => @group_key,
+                'customerId' => @customer_id,
+                'invoiceId' => @invoice_id,
+                'invoiceNumber' => @invoice_number,
+                'invoiceDate' => @invoice_date,
+                'customerName' => @customer_name,
+                'status' => @status,
+                'paymentDueDate' => @payment_due_date,
+                'invoiceAmount' => @invoice_amount,
+                'outstandingBalance' => @outstanding_balance,
+                'invoiceTypeCode' => @invoice_type_code,
+                'newestActivity' => @newest_activity,
+                'daysPastDue' => @days_past_due,
+                'paymentNumbers' => @payment_numbers,
+                'paymentIds' => @payment_ids,
+            }
+        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/attachment_header_info_model.rb

@@ -0,0 +1,74 @@
+#
+# 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
+
+    ##
+    # Aggregated Attachment status information.
+    class AttachmentHeaderInfoModel
+
+        ##
+        # Initialize the AttachmentHeaderInfoModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @company_id = params.dig(:company_id)
+            @total_attachments = params.dig(:total_attachments)
+            @total_archived = params.dig(:total_archived)
+            @total_active = params.dig(:total_active)
+        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 CompanyId associated with the attachment status report. Providing a null value will return an attachment summary for all attachments associated to the provided GroupKey
+        attr_accessor :company_id
+
+        ##
+        # @return [Int32] The total number of attachments associated with the provided GroupKey and CompanyId.
+        attr_accessor :total_attachments
+
+        ##
+        # @return [Int32] The total number of archived attachments associated with the provided GroupKey and CompanyId.
+        attr_accessor :total_archived
+
+        ##
+        # @return [Int32] The total number of active attachments associated with the provided GroupKey and CompanyId.
+        attr_accessor :total_active
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'companyId' => @company_id,
+                'totalAttachments' => @total_attachments,
+                'totalArchived' => @total_archived,
+                'totalActive' => @total_active,
+            }
+        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/attachment_model.rb

@@ -0,0 +1,122 @@
+#
+# 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 user uploaded attachment
+    class AttachmentModel
+
+        ##
+        # Initialize the AttachmentModel using the provided prototype
+        def initialize(params = {})
+            @attachment_id = params.dig(:attachment_id)
+            @group_key = params.dig(:group_key)
+            @table_key = params.dig(:table_key)
+            @object_key = params.dig(:object_key)
+            @file_name = params.dig(:file_name)
+            @file_ext = params.dig(:file_ext)
+            @attachment_type_id = params.dig(:attachment_type_id)
+            @is_archived = params.dig(:is_archived)
+            @origin_attachment_id = params.dig(:origin_attachment_id)
+            @view_internal = params.dig(:view_internal)
+            @view_external = params.dig(:view_external)
+            @created = params.dig(:created)
+            @created_user_id = params.dig(:created_user_id)
+        end
+
+        ##
+        # @return [Uuid] The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
+        attr_accessor :attachment_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 [String] The name of the table the attachment is associated with
+        attr_accessor :table_key
+
+        ##
+        # @return [Uuid] The ID of the object the attachment is associated with
+        attr_accessor :object_key
+
+        ##
+        # @return [String] Name of the file
+        attr_accessor :file_name
+
+        ##
+        # @return [String] Extension type of the file
+        attr_accessor :file_ext
+
+        ##
+        # @return [Uuid] Corresponding AttachmentType object to describe this attachment
+        attr_accessor :attachment_type_id
+
+        ##
+        # @return [Boolean] Flag indicating the attachment was archived
+        attr_accessor :is_archived
+
+        ##
+        # @return [Uuid] 
+        attr_accessor :origin_attachment_id
+
+        ##
+        # @return [Boolean] Flag for if LS clients can see this file
+        attr_accessor :view_internal
+
+        ##
+        # @return [Boolean] Flag for if Vendors and customers can see this file
+        attr_accessor :view_external
+
+        ##
+        # @return [Date-time] The date the attachment was created
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] Id of the user who made the file
+        attr_accessor :created_user_id
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'attachmentId' => @attachment_id,
+                'groupKey' => @group_key,
+                'tableKey' => @table_key,
+                'objectKey' => @object_key,
+                'fileName' => @file_name,
+                'fileExt' => @file_ext,
+                'attachmentTypeId' => @attachment_type_id,
+                'isArchived' => @is_archived,
+                'originAttachmentId' => @origin_attachment_id,
+                'viewInternal' => @view_internal,
+                'viewExternal' => @view_external,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+            }
+        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/bulk_currency_conversion_model.rb

@@ -0,0 +1,56 @@
+#
+# 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
+
+    ##
+    # Input format used for bulk conversion route
+    class BulkCurrencyConversionModel
+
+        ##
+        # Initialize the BulkCurrencyConversionModel using the provided prototype
+        def initialize(params = {})
+            @date = params.dig(:date)
+            @source_currency = params.dig(:source_currency)
+        end
+
+        ##
+        # @return [Date] The date for the currency rate
+        attr_accessor :date
+
+        ##
+        # @return [String] The currency code This will be validated by the /api/v1/currencies data set
+        attr_accessor :source_currency
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'date' => @date,
+                'sourceCurrency' => @source_currency,
+            }
+        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/cashflow_report_model.rb

@@ -0,0 +1,74 @@
+#
+# 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 the cashflow report based on a timeframe
+    class CashflowReportModel
+
+        ##
+        # Initialize the CashflowReportModel using the provided prototype
+        def initialize(params = {})
+            @timeframe = params.dig(:timeframe)
+            @payments_collected = params.dig(:payments_collected)
+            @payments_collected_count = params.dig(:payments_collected_count)
+            @invoices_billed = params.dig(:invoices_billed)
+            @invoices_billed_count = params.dig(:invoices_billed_count)
+        end
+
+        ##
+        # @return [Int32] Timeframe in days the cashflow report is generated on
+        attr_accessor :timeframe
+
+        ##
+        # @return [Double] Amount of payments collected based in the timeframe
+        attr_accessor :payments_collected
+
+        ##
+        # @return [Int32] Number of payments collected based in the timeframe
+        attr_accessor :payments_collected_count
+
+        ##
+        # @return [Double] Amount of invoices billed based in the timeframe
+        attr_accessor :invoices_billed
+
+        ##
+        # @return [Int32] Number of invoices billed in the timeframe
+        attr_accessor :invoices_billed_count
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'timeframe' => @timeframe,
+                'paymentsCollected' => @payments_collected,
+                'paymentsCollectedCount' => @payments_collected_count,
+                'invoicesBilled' => @invoices_billed,
+                'invoicesBilledCount' => @invoices_billed_count,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end