lockstep_rails 0.3.64 → 0.3.66

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d83e57b6db6e9db14cd4f15009562ccd5d0d04efa90a70b06f5f60a58ac53f40
-  data.tar.gz: c4830314919f4710198deb5e2931808ed9b6533d727eb992ba4d1532473ff427
+  metadata.gz: 6396d7891183413701490cb5cdac6b276b1a69d2af705c501ac299595894f6d8
+  data.tar.gz: 55f1ee34e4ba370b02a5f92ff9a8b74b45fabf55f281fc663f8f0a9d1f3cb7f2
 SHA512:
-  metadata.gz: 70ce01db3c9b2e45047839ab02ca21dc01f82a781c0b2489dc320931b3774c4d8c720aa2665cc142738dd6892ea92f53f708233fee0758f1a29fa14eab20a89c
-  data.tar.gz: 58b0d4ed3f52e6c72a1bd3d52f9b3eaf10b8cf5853e03720d9927f33fb4af2eb8e10362821cf43ea621d0d151bcf314a5975580de01b5526552e2169e506e68c
+  metadata.gz: ee29ce85814ee0b82b2c56325634ec11c16857b5299cdb7f4093074dd15bcb10338c0f8fb42ebad35be35b4ae91687195b90a400d0dbc4e054910f17de7c79db
+  data.tar.gz: 72327b6159631feb9d0757db3c777bf18726cb3f7e8ffe74e711e23d2e36a6922d6beda81c43fdf0251410f43bd661991cc9f9d8e9f3ae0b217082c1797d5c7a

data/app/models/lockstep/payment.rb

@@ -2,6 +2,21 @@ class Lockstep::Payment < Lockstep::ApiRecord
   self.model_name_uri = "v1/Payments"
   self.id_ref = "payment_id"
   load_schema(Schema::Payment)
-
+  ERP_WRITE = "erp_write"
+  ERP_WRITE_PATH_PARAMS = "erp-write"
   belongs_to :connection, class_name: "Lockstep::Connection", foreign_key: :company_id
+
+  # Overriding create to support erp-write in path params
+  def create
+    if attributes_for_saving.key?(ERP_WRITE)
+      attributes_for_saving.delete(ERP_WRITE)
+      attrs = attributes_for_saving.transform_keys { |key| key.camelize(:lower) }
+      resp = resource.post(ERP_WRITE_PATH_PARAMS, body: attrs)
+      result = post_result(resp)
+    else
+      attrs = attributes_for_saving.transform_keys { |key| key.camelize(:lower) }
+      resp = resource.post('', body: [attrs])
+      result = post_result(resp)
+    end
+  end
 end

data/app/platform_api/schema/financial_account_sync.rb

@@ -8,7 +8,7 @@ end
   # Indicates what action to take when an existing object has been found during the sync process.
   field :on_match_action
 
-  # The code for the Financial Account. Can either be a general ledger or
+  # The code for the Financial Account. Can either be a general ledger or
   # an account code.
   # @type: string
   field :code
@@ -21,12 +21,12 @@ end
   # @type: string
   field :name
 
-  # The status of the Financial Account. Possible values are active,
+  # The status of the Financial Account. Possible values are active,
   # inactive, deleted or archived.
   # @type: string
   field :status
 
-  # The cashflow type for the Financial Account. Examples include cash, financing, investment
+  # The cashflow type for the Financial Account. Examples include cash, financing, investment
   # or operation.
   # @type: string
   field :cashflow_type
@@ -35,8 +35,8 @@ end
   # @type: string
   field :description
 
-  # The classification for the Financial Account. Possible values are Asset, Equity,
-  # Expense, Liability or Income.
+  # The classification for the Financial Account. Possible values are Asset, Equity,
+  # Expense, Liability, Income, CreditCard, Checking, or Savings.
   # @type: string
   field :classification
 
@@ -50,4 +50,5 @@ end
 
 
 
-end
+end
+

data/app/platform_api/schema/financial_institution_account.rb

@@ -0,0 +1,77 @@
+class Schema::FinancialInstitutionAccount < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique identifier for the Financial Institution Account.
+  # @type: string
+  # @format: uuid
+  field :financial_institution_account_id
+
+  # 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
+
+  # An alternate account id for the Financial Institution Account.
+  # @type: string
+  field :bank_account_id
+
+  # The External Id for the Financial Institution Account.
+  # @type: string
+  field :erp_key
+
+  # The App Enrollment Id this Financial Institution is associated with.
+  # @type: string
+  # @format: uuid
+  field :app_enrollment_id
+
+  # The name of the Financial Institution Account.
+  # @type: string
+  field :name
+
+  # The status of the Financial Institution Account. Possible values are active,
+  # inactive, deleted or archived.
+  # @type: string
+  field :status
+
+  # The description for the Financial Institution Account.
+  # @type: string
+  field :description
+
+  # The classification for the Financial Institution Account. Possible values are Asset, Equity,
+  # Expense, Liability or Income.
+  # @type: string
+  field :account_type
+
+  # The date the Financial Institution Account was created.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The user that has created the Financial Institution Account.
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date the Financial Institution Account was modified.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The user that has modified the Financial Institution Account.
+  # @type: string
+  # @format: uuid
+  field :modified_user_id
+
+  belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
+  belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
+
+
+end
+

data/app/platform_api/schema/financial_institution_account_fetch_result.rb

@@ -0,0 +1,27 @@
+class Schema::FinancialInstitutionAccountFetchResult < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  
+  # @type: integer
+  # @format: int32
+  field :total_count
+
+  
+  # @type: integer
+  # @format: int32
+  field :page_size
+
+  
+  # @type: integer
+  # @format: int32
+  field :page_number
+
+
+  has_many :records, {:class_name=>"Schema::FinancialInstitutionAccount", :included=>true}
+
+end
+

data/app/platform_api/schema/insert_payment_applied_request.rb

@@ -0,0 +1,53 @@
+class Schema::InsertPaymentAppliedRequest < 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 Lockstep platform.
+  #             
+  # For the ID of this record in its originating financial system, see `ErpKey`.
+  # @type: string
+  # @format: uuid
+  field :payment_applied_id
+
+  # The Invoice this payment is applied to.
+  # @type: string
+  # @format: uuid
+  field :invoice_id
+
+  # The Payment this application applies from.
+  # @type: string
+  # @format: uuid
+  field :payment_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`.
+  #             
+  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+  # @type: string
+  field :erp_key
+
+  # The ERP key of the Invoice this payment is applied to.
+  # @type: string
+  field :invoice_erp_key
+
+  # The date this payment was applied to this invoice.
+  # @type: string
+  # @format: date-time
+  field :apply_to_invoice_date, Types::Params::DateTime
+
+  # 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/insert_payment_request.rb

@@ -0,0 +1,135 @@
+class Schema::InsertPaymentRequest < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The AppEnrollmentId of the application to write this record to.
+  # @type: string
+  # @format: uuid
+  field :app_enrollment_id
+
+  # 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
+  field :payment_id
+
+  # The ID of the company to which this payment belongs.
+  # @type: string
+  # @format: uuid
+  field :company_id
+
+  # The ERP key for the company to which this payment belongs.
+  # @type: string
+  field :company_erp_key
+
+  # A additional reference that may be used in the ERP
+  # @type: string
+  field :company_external_reference
+
+  # 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
+  # * `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.
+  # * `Other` - A payment made via another method not listed above.
+  # @type: string
+  field :tender_type
+
+  # Memo or reference text (ex. memo field on a check).
+  # @type: string
+  field :memo_text
+
+  # The date when this payment was received.
+  # @type: string
+  # @format: date-time
+  field :payment_date, Types::Params::DateTime
+
+  # The date when a payment was posted to a ledger.
+  # @type: string
+  # @format: date-time
+  field :post_date, Types::Params::DateTime
+
+  # Total amount of this payment in it's received currency.
+  # @type: number
+  # @format: double
+  field :payment_amount
+
+  # Unapplied balance of this payment in it's received currency.  If this amount is nonzero, the field `IsOpen` will be true.
+  # @type: number
+  # @format: double
+  field :unapplied_amount
+
+  # 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).
+  # @type: string
+  field :currency_code
+
+  # Reference code for the payment for the given Erp system.
+  # @type: string
+  field :reference_code
+
+  # Is the payment voided?
+  # @type: boolean
+  field :is_voided
+
+  # Is the payment in dispute?
+  # @type: boolean
+  field :in_dispute
+
+  # The Currency Rate used to get from the account's base currency to the payment amount.
+  # @type: number
+  # @format: double
+  field :currency_rate
+
+  # Total amount of this payment in the group's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_payment_amount
+
+  # 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 :base_currency_unapplied_amount
+
+  # The Bank account id for the company to which this payment belongs.
+  # @type: string
+  field :bank_account_id
+
+  # The GroupKey this request belongs to.
+  # @type: string
+  # @format: uuid
+  field :group_key
+
+  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"}
+
+  has_many :applications, {:class_name=>"Schema::InsertPaymentAppliedRequest", :included=>true}
+
+end
+

data/app/platform_api/schema/insert_payment_request_erp_write_sync_submit.rb

@@ -0,0 +1,17 @@
+class Schema::InsertPaymentRequestErpWriteSyncSubmit < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The connected App Enrollment id.
+  # @type: string
+  # @format: uuid
+  field :app_enrollment_id
+
+
+  has_many :requests, {:class_name=>"Schema::InsertPaymentRequest", :included=>true}
+
+end
+

data/app/platform_api/schema/payment_erp_write_result.rb

@@ -0,0 +1,38 @@
+class Schema::PaymentErpWriteResult < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The id of the connected AppEnrollmentModel
+  # @type: string
+  # @format: uuid
+  field :app_enrollment_id
+
+  # The ErpKey for the object written to the Erp if created
+  # @type: string
+  field :erp_key
+
+  # 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
+
+  # An optional message to return with the result
+  # @type: string
+  field :message
+
+  # The id of the SyncRequestModel the requests were added to
+  # @type: string
+  # @format: uuid
+  field :sync_request_id
+
+
+  has_many :results, {:class_name=>"Schema::Payment", :included=>true}
+
+end
+

data/app/platform_api/schema/user_account.rb

@@ -142,6 +142,10 @@ end
   # @type: string
   field :default_currency_code
 
+  # The IETF language tag for the user's preferred locale.
+  # @type: string
+  field :locale
+
   # Accounting role definition for this User.
   # To retrieve this collection, specify `AccountingRole` in the "Include" parameter for your query.
   field :accounting_role_code_definition
@@ -153,4 +157,5 @@ end
   has_many :attachments, {:class_name=>"Schema::Attachment", :included=>true}
   has_many :custom_field_values, {:class_name=>"Schema::CustomFieldValue", :included=>true}
 
-end
+end
+