lockstep_rails 0.3.34 → 0.3.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11d7e20990a95502b074c561bf66b38b4d9578956ae8a8b30009156dcddc9128
-  data.tar.gz: cf88371e3c097ca5133a9e739f15538d7dd0eaf88e6afc43528161f64cba1498
+  metadata.gz: 05bd7ba3de1568889d934bc0160f923ecf173f1fe5f357856a9fc221d07fe039
+  data.tar.gz: 4a1458573f08c1b33aa11da01487df04ca403e9bff7f9e8039f723284e47f62b
 SHA512:
-  metadata.gz: fdfa5f9757e3fefcb91f285d20ebc7cb13a53df53988f80b417b4030beb58a34c33ca5e1b031bbfc2b86edf59dfb4738d070dac68639a14d38625534820c5f4a
-  data.tar.gz: 8cb82a10a58c4b8d477b5c49ef2c25a56a88a3e2699991388e95be8333c8ca2b86c9568cf3e5806394628b322c6a5bd1620b920077a99e0c7e9a1550c7320d46
+  metadata.gz: 887d60f6868d2d525de634193da364ff24a86447d3b1e5616421d7c4ccefcb3c5b55d55c64ff3be0c7ec6f9ad94e794e3951ada7e0e9ffb3eef3834c4da6824f
+  data.tar.gz: 7adadb32cc6a971a5c9e4c816cd2e12f15aa85c845a73dab446f645cb1061d9f0f38d82da34b9d30cc3c0c84c161de4170d0cb5336b7e34c1309e981a37205da

data/README.md

@@ -60,6 +60,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 * Lockstep::ReportPayableSummary
 * Lockstep::ReportPayablesComingDueSummary
 * Lockstep::ApiKey
+* Lockstep::InvoiceAtRiskSummary
 
 ## ActiveModel Interfaces
 

data/app/models/lockstep/ap_header.rb

@@ -0,0 +1,32 @@
+class Lockstep::ApHeader < Lockstep::ApiRecord
+  self.model_name_uri = "v1/Reports/ap-header"
+  self.id_ref = "group_key"
+  self.query_path= ""
+  load_schema(Schema::ApHeaderInfo)
+
+end
+
+class Lockstep::Query
+  # Overriding the build_params method to just add attributes in params without filter option
+  def build_params
+    params = {}
+    criteria[:conditions].first.each do |key|
+      params.merge!({ :"#{key[0].to_s.camelize(:lower)}" => key[1] })
+    end
+    return params
+  end
+
+  # Overrinding the get_results method to parse the single object coming from v1.
+  def get_results(params = {})
+  resp = @klass.resource.get(@klass.query_path, :params => params)
+
+  return [] if %w(404).include?(resp.code.to_s)
+  # TODO handle non 200 response code. Throwing an exception for now
+  raise StandardError.new("#{resp.code} error while fetching: #{resp.body}") unless %w(201 200).include?(resp.code.to_s)
+
+  parsed_response = JSON.parse(resp.body)
+
+  r = parsed_response.transform_keys { |key| key.underscore }
+  @klass.model_name.to_s.constantize.new(r, false)
+  end
+end

data/app/models/lockstep/ar_header.rb

@@ -0,0 +1,32 @@
+class Lockstep::ArHeader < Lockstep::ApiRecord
+  self.model_name_uri = "v1/Reports/ar-header"
+  self.id_ref = "group_key"
+  self.query_path= ""
+  load_schema(Schema::ArHeaderInfo)
+
+end
+
+class Lockstep::Query
+  # Overriding the build_params method to just add attributes in params without filter option
+  def build_params
+    params = {}
+    criteria[:conditions].first.each do |key|
+      params.merge!({ :"#{key[0].to_s.camelize(:lower)}" => key[1] })
+    end
+    return params
+  end
+
+  # Overrinding the get_results method to parse the single object coming from v1.
+  def get_results(params = {})
+  resp = @klass.resource.get(@klass.query_path, :params => params)
+
+  return [] if %w(404).include?(resp.code.to_s)
+  # TODO handle non 200 response code. Throwing an exception for now
+  raise StandardError.new("#{resp.code} error while fetching: #{resp.body}") unless %w(201 200).include?(resp.code.to_s)
+
+  parsed_response = JSON.parse(resp.body)
+
+  r = parsed_response.transform_keys { |key| key.underscore }
+  @klass.model_name.to_s.constantize.new(r, false)
+  end
+end

data/app/models/lockstep/invoice_at_risk_summary.rb

@@ -0,0 +1,6 @@
+class Lockstep::InvoiceAtRiskSummary < Lockstep::ApiRecord
+  self.model_name_uri = "v1/Invoices/views/at-risk-summary"
+  self.id_ref = "invoice_id"
+  self.query_path = ""
+  load_schema(Schema::InvoiceAtRiskSummary)
+end

data/app/platform_api/schema/ap_header_info.rb

@@ -0,0 +1,148 @@
+class Schema::ApHeaderInfo < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+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.
+  # 
+  # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
+  # @type: string
+  # @format: uuid
+  field :group_key
+
+  # The date of the report
+  # @type: string
+  # @format: date
+  field :report_date
+
+  # The date of the report
+  # @type: string
+  # @format: uuid
+  field :company_id
+
+  # The total number of vendors..
+  # @type: integer
+  # @format: int32
+  field :total_vendors
+
+  # The total number of bills.
+  # @type: integer
+  # @format: int32
+  field :total_bills
+
+  # The total amount billed.
+  # @type: number
+  # @format: double
+  field :total_billed_amount
+
+  # The total number of advance payments.
+  # @type: number
+  # @format: double
+  field :total_advance_payments
+
+  # The total amount paid.
+  # @type: number
+  # @format: double
+  field :total_paid
+
+  # The total accounts payable amount.
+  # @type: number
+  # @format: double
+  field :total_ap_amount
+
+  # The number of paid bills.
+  # @type: integer
+  # @format: int32
+  field :total_bills_paid
+
+  # The number of past due bills.
+  # @type: integer
+  # @format: int32
+  field :total_bills_past_due
+
+  # The number of bills 90+ days past due.
+  # @type: integer
+  # @format: int32
+  field :total_bills90_days_past_due
+
+  # The total amount past due.
+  # @type: number
+  # @format: double
+  field :total_past_due_amount
+
+  # The total amount for bills 90+ days past due.
+  # @type: number
+  # @format: double
+  field :total_past_due_amount90_days
+
+  # Portion of Total AP that is Past due.
+  # @type: number
+  # @format: double
+  field :percentage_of_total_ap
+
+  # The total amount billed, due this year.
+  # @type: number
+  # @format: double
+  field :total_billed_amount_current_year
+
+  # The total amount billed, due last year.
+  # @type: number
+  # @format: double
+  field :total_billed_amount_previous_year
+
+  # The total of all payments made this year.
+  # @type: number
+  # @format: double
+  field :total_paid_amount_current_year
+
+  # Portion of Total AP that is 90+ days Past due.
+  # @type: number
+  # @format: double
+  field :percentage_of_total_ap90_days_past_due
+
+  # The number of vendors who were paid within the past thirty days.
+  # @type: integer
+  # @format: int32
+  field :vendors_paid_past_thirty_days
+
+  # The total amount paid over the past thirty days.
+  # @type: number
+  # @format: double
+  field :amount_paid_past_thirty_days
+
+  # The amount in advance from the payments made over the past thirty days.
+  # @type: number
+  # @format: double
+  field :advance_payment_amount_past_thirty_days
+
+  # The number of bills paid over the past thirty days.
+  # @type: integer
+  # @format: int32
+  field :bills_paid_past_thirty_days
+
+  # The number of vendors that sent bills over the the past thirty days.
+  # @type: integer
+  # @format: int32
+  field :billing_vendors_past_thirty_days
+
+  # The total amount billed over the past thirty days.
+  # @type: number
+  # @format: double
+  field :amount_billed_past_thirty_days
+
+  # The amount outstanding on the bills received over the past thirty days.
+  # @type: number
+  # @format: double
+  field :amount_due_past_thirty_days
+
+  # The number of bills received over the past thirty days.
+  # @type: integer
+  # @format: int32
+  field :bills_past_thirty_days
+
+
+
+end

data/app/platform_api/schema/ar_header_info.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
@@ -16,7 +16,12 @@ end
   # The date of the report
   # @type: string
   # @format: date
-  field :report_period
+  field :report_date
+
+  # The date of the report
+  # @type: string
+  # @format: uuid
+  field :company_id
 
   # The total number of customers.
   # @type: integer

data/app/platform_api/schema/invoice_at_risk_summary.rb

@@ -0,0 +1,90 @@
+class Schema::InvoiceAtRiskSummary < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The date of the report.
+  # @type: string
+  # @format: date
+  field :report_date
+
+  # 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 ID number of the counterparty for the invoice, for example, a customer or vendor.
+  # @type: string
+  # @format: uuid
+  field :customer_id
+
+  # The unique ID number of this invoice.
+  # @type: string
+  # @format: uuid
+  field :invoice_id
+
+  # 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
+
+  # The reporting date for this invoice.
+  # @type: string
+  # @format: date
+  field :invoice_date
+
+  # The name of the counterparty for the invoice, for example, a customer or vendor.
+  # @type: string
+  field :customer_name
+
+  # The status of the invoice.
+  # @type: string
+  field :status
+
+  # The due date of the invoice.
+  # @type: string
+  # @format: date
+  field :payment_due_date
+
+  # The total amount of the Invoice.
+  # @type: number
+  # @format: double
+  field :invoice_amount
+
+  # The remaining balance value of this invoice.
+  # @type: number
+  # @format: double
+  field :outstanding_balance
+
+  # A code identifying the type of this Invoice.
+  # @type: string
+  field :invoice_type_code
+
+  # The date stamp for the newest Activity on this Invoice.
+  # @type: string
+  # @format: date
+  field :newest_activity
+
+  # The number of days this Invoice is past due.
+  # @type: integer
+  # @format: int32
+  field :days_past_due
+
+  # The memo text of the payments associated to this invoice.
+  # @type: array
+  field :payment_numbers
+
+  # The ids of the payments associated to this invoice.
+  # @type: array
+  field :payment_ids
+
+  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"}
+
+
+end

data/lib/lockstep_rails/version.rb

@@ -1,3 +1,3 @@
 module LockstepRails
-  VERSION = "0.3.34"
+  VERSION = "0.3.36"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockstep_rails
 version: !ruby/object:Gem::Version
-  version: 0.3.34
+  version: 0.3.36
 platform: ruby
 authors:
 - Vivek AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-17 00:00:00.000000000 Z
+date: 2022-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -46,12 +46,15 @@ files:
 - app/concepts/lockstep/relation_array.rb
 - app/helpers/types.rb
 - app/models/lockstep/account.rb
+- app/models/lockstep/ap_header.rb
 - app/models/lockstep/api_key.rb
 - app/models/lockstep/app_enrollment.rb
+- app/models/lockstep/ar_header.rb
 - app/models/lockstep/connection.rb
 - app/models/lockstep/contact.rb
 - app/models/lockstep/customer_summary.rb
 - app/models/lockstep/invoice.rb
+- app/models/lockstep/invoice_at_risk_summary.rb
 - app/models/lockstep/invoice_summary.rb
 - app/models/lockstep/invoices/address.rb
 - app/models/lockstep/note.rb
@@ -77,6 +80,7 @@ files:
 - app/platform_api/schema/activity_x_ref.rb
 - app/platform_api/schema/aging.rb
 - app/platform_api/schema/ap_aging_header_info.rb
+- app/platform_api/schema/ap_header_info.rb
 - app/platform_api/schema/api_key.rb
 - app/platform_api/schema/api_key_fetch_result.rb
 - app/platform_api/schema/app_enrollment.rb
@@ -150,6 +154,7 @@ files:
 - app/platform_api/schema/invite_submit.rb
 - app/platform_api/schema/invoice.rb
 - app/platform_api/schema/invoice_address.rb
+- app/platform_api/schema/invoice_at_risk_summary.rb
 - app/platform_api/schema/invoice_fetch_result.rb
 - app/platform_api/schema/invoice_history.rb
 - app/platform_api/schema/invoice_history_fetch_result.rb