lockstep_sdk 2023.17.21.0 → 2023.28.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e57962a47787588b19a99264be9b2ef7601dd8cf52a6f78c704a06c7f8c8355a
-  data.tar.gz: 336f18be792f9724a82227839a68c06ebb2d6d4487d63672ca3f0ae3f0d56346
+  metadata.gz: 89d89e36f182a9dc0df9de4c64f8d0f5e6b746a1c97e0dc2192fb76c04fafa58
+  data.tar.gz: be9e2cc6dab403e7b2fabde7b86a94690e552b0a4f931bcfb5ad4f2d16b63719
 SHA512:
-  metadata.gz: e86e45271e0b3b2a71655232f64595b20a7c4e0442e27b0d4d7bb8ac5974bdbb709279b751811e1d8c393080cd0a77e05c5bc541bc54518b70a5e5bdbaa9a1cc
-  data.tar.gz: a31ff3a91b040e7a18cd6bc93e31dad6d515a6c0bb94b81ac6ed36978bcf2191a8138517896d14aa3303739ecdec806a5f599991d6835aa94a395157c760d514
+  metadata.gz: 896d279b860eed578020f323a70683d8fdbcd468d7d49b7eb3c32e72d2c4a8d01b386882f531b2abe1782bfc2c13fcf8b4db5e4506e7999be2e44a805219fc29
+  data.tar.gz: fd10fac66bd3b0951864c7df8e7b6094f5d72d29d7cced8ae8f0b05eefe15c2e8aee24c5bdd1c3abb0f92fe29d7dc1f47eb53f32be06b02eb661fe2b4475df5c

data/lib/lockstep_sdk/clients/definitions_client.rb

@@ -30,7 +30,6 @@ class DefinitionsClient
     # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
     #
     # Your program may want to show a list of countries. The ISO maintains a list of countries called [ISO3166](https://www.iso.org/iso-3166-country-codes.html). For convenience, this list is available in the API.
-    #
     # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available, but may be offered in the future.
     # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
@@ -48,7 +47,6 @@ class DefinitionsClient
     # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
     #
     # Your app may wish to make use of a reference list that contains names and attributes for all ISO-4217 defined currency codes.  This information is provided via a query endpoint so that you can use this API to provide a user selection screen.
-    #
     # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available, but may be offered in the future.
     # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
@@ -66,7 +64,6 @@ class DefinitionsClient
     # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
     #
     # Your app may wish to make use of a reference list that contains names and codes for all states in the United States.  This information is provided for the United States since many financial systems require mailing addresses that use codes for states.
-    #
     # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available, but may be offered in the future.
     # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
@@ -84,7 +81,6 @@ class DefinitionsClient
     # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
     #
     # Lockstep provides a list of financial systems that may be useful as a selection screen that allows customers to select from a list.  You can query these items by name or attributes and use this data source to help users complete a selection.
-    #
     # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available, but may be offered in the future.
     # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)

data/lib/lockstep_sdk/clients/financial_institution_accounts_client.rb

@@ -0,0 +1,49 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2023 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2023 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class FinancialInstitutionAccountsClient
+
+    ##
+    # Initialize the FinancialInstitutionAccountsClient class with an API client instance.
+    # @param connection [LockstepApi] The API client object for this connection
+    def initialize(connection)
+        @connection = connection
+    end
+
+
+    ##
+    # Retrieves the financial institution account specified by this unique identifier.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this institution account; NOT the customer's ERP key
+    def retrieve_financial_institution_accounts(id:)
+        path = "/api/v1/financial-institution-accounts/#{id}"
+        @connection.request(:get, path, nil, nil)
+    end
+
+    ##
+    #
+    #
+    # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available but may be offered in the future.
+    # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_financial_institution_accounts(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/financial-institution-accounts/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @connection.request(:get, path, nil, params)
+    end
+end

data/lib/lockstep_sdk/clients/invoices_client.rb

@@ -109,6 +109,8 @@ class InvoicesClient
     #
     # Xero supports AR Invoices, AP Invoices, AR Credit Memos, and AP Credit Memos.
     #
+    # Sage 50 supports AR Invoices and AR Credit Memos.
+    #
     # @param id [uuid] The unique Lockstep Platform ID number of this invoice; NOT the customer's ERP key
     def retrieve_invoice_pdf(id:)
         path = "/api/v1/Invoices/#{id}/pdf"

data/lib/lockstep_sdk/clients/leads_client.rb

@@ -28,7 +28,6 @@ class LeadsClient
     # Creates one or more Leads within the Lockstep platform and returns the records as created.
     #
     # A Lead is a person who is interested in the Lockstep platform but needs certain new features in order to use it. If you are interested in the Lockstep platform, you can create a lead with your information and our team will prioritize the feature you need.
-    #
     # @param body [LeadModel] The Leads to create
     def create_leads(body:)
         path = "/api/v1/Leads"

data/lib/lockstep_sdk/clients/payments_client.rb

@@ -143,4 +143,15 @@ class PaymentsClient
         params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
         @connection.request(:get, path, nil, params)
     end
+
+    ##
+    # **This API endpoint is under maintenance and may not function properly.**  Schedule an ERP post request for payments.
+    #
+    # The payments must be associated with an active app enrollment and have a valid `AppEnrollmentId`.
+    #
+    # @param body [InsertPaymentRequestModelErpWriteSyncSubmitModel] The payments to submit to the connected ERP
+    def write_payments_to_connected_erp(body:)
+        path = "/api/v1/Payments/erp-write"
+        @connection.request(:post, path, body, nil)
+    end
 end

data/lib/lockstep_sdk/clients/profiles_companies_client.rb

@@ -28,7 +28,6 @@ class ProfilesCompaniesClient
     # Retrieves the Public Company Profile specified by the public url slug.
     #
     # A Public Company Profile makes available the following information: <ul><li>Company Name</li><li>Company Logo Url</li><li>Description</li><li>Website</li></ul>
-    #
     # @param url_slug [string] 
     def retrieve_public_company_profile(url_slug:)
         path = "/api/v1/profiles/companies/#{urlSlug}"
@@ -43,7 +42,6 @@ class ProfilesCompaniesClient
     # A Public Company Profile makes available the following information:
     #
     # <ul><li>Company Name</li><li>Company Logo Url</li><li>Description</li><li>Website</li></ul>
-    #
     # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param order [string] The sort order for the results, in the [Searchlight order syntax](https://github.com/tspence/csharp-searchlight).
     # @param page_size [int32] The page size for results (default 250, maximum of 500)

data/lib/lockstep_sdk/clients/status_client.rb

@@ -28,7 +28,6 @@ class StatusClient
     # Verifies that your application can successfully call the Lockstep Platform API and returns a successful code regardless of your authentication status or permissions.
     #
     # The Ping API can be used to verify that your app is working correctly.  The Ping API will always return 200 OK.  If you call this API and you receive a code other than 200 OK, you should check your network connectivity.  A response code of anything other than 200 means that a routing issue or proxy issue may prevent your application from reaching the Lockstep API
-    #
     def ping()
         path = "/api/v1/Status"
         @connection.request(:get, path, nil, nil)

data/lib/lockstep_sdk/clients/user_accounts_client.rb

@@ -77,7 +77,6 @@ class UserAccountsClient
     # Retrieves invite information for the specified invite token.
     #
     # A User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox.  A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account.  All Users must validate their email to make use of Lockstep platform services.  Users may have different privileges and access control rights within the Lockstep Platform.
-    #
     # @param code [uuid] The code of the invite
     def retrieve_invite_data(code:)
         path = "/api/v1/UserAccounts/invite"

data/lib/lockstep_sdk/lockstep_api.rb

@@ -9,7 +9,7 @@
 # @author     Lockstep Network <support@lockstep.io>
 #             Manish Narayan B S <manish.n@lockstep.io>, Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
 # @copyright  2021-2023 Lockstep, Inc.
-# @version    2023.17.21
+# @version    2023.28.10
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -96,6 +96,10 @@ module lockstep_sdk
         # @return [FinancialAccountBalanceHistoryClient] Client object for FinancialAccountBalanceHistory endpoints
         attr_accessor :financial_account_balance_history
 
+        ##
+        # @return [FinancialInstitutionAccountsClient] Client object for FinancialInstitutionAccounts endpoints
+        attr_accessor :financial_institution_accounts
+
         ##
         # @return [FinancialYearSettingsClient] Client object for FinancialYearSettings endpoints
         attr_accessor :financial_year_settings
@@ -194,7 +198,7 @@ module lockstep_sdk
         #
         # @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
         def initialize(env)
-            @version = "2023.17.21.0"
+            @version = "2023.28.10.0"
             @env = case env
                 when "sbx"
                     "https://api.sbx.lockstep.io/"
@@ -221,6 +225,7 @@ module lockstep_sdk
             @feature_flags = FeatureFlagsClient.new(self)
             @financial_account = FinancialAccountClient.new(self)
             @financial_account_balance_history = FinancialAccountBalanceHistoryClient.new(self)
+            @financial_institution_accounts = FinancialInstitutionAccountsClient.new(self)
             @financial_year_settings = FinancialYearSettingsClient.new(self)
             @group_accounts = GroupAccountsClient.new(self)
             @invoice_addresses = InvoiceAddressesClient.new(self)
@@ -307,7 +312,7 @@ module lockstep_sdk
             request["Accept"] = 'application/json'
             request["Content-Type"] = 'application/*+json'
             request["SdkType"] = 'Ruby'
-            request["SdkVersion"] = '2023.17.21.0'
+            request["SdkVersion"] = '2023.28.10.0'
             request["MachineName"] = Socket.gethostname
             request.body = body
 

data/lib/lockstep_sdk/models/financial_account_sync_model.rb

@@ -72,7 +72,7 @@ module LockstepSdk
         attr_accessor :description
 
         ##
-        # @return [String] The classification for the Financial Account. Possible values are Asset, Equity, Expense, Liability or Income.
+        # @return [String] The classification for the Financial Account. Possible values are Asset, Equity, Expense, Liability, Income, CreditCard, Checking, or Savings.
         attr_accessor :classification
 
         ##

data/lib/lockstep_sdk/models/financial_institution_account_model.rb

@@ -0,0 +1,119 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2023 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2023 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # An Financial Institution Account represents an account used for monetary transactions. E.g. - checking, savings,  or credit card accounts.
+    class FinancialInstitutionAccountModel
+
+        ##
+        # Initialize the FinancialInstitutionAccountModel using the provided prototype
+        def initialize(params = {})
+            @financial_institution_account_id = params.dig(:financial_institution_account_id)
+            @group_key = params.dig(:group_key)
+            @bank_account_id = params.dig(:bank_account_id)
+            @erp_key = params.dig(:erp_key)
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @name = params.dig(:name)
+            @status = params.dig(:status)
+            @description = params.dig(:description)
+            @account_type = params.dig(:account_type)
+            @created = params.dig(:created)
+            @created_user_id = params.dig(:created_user_id)
+            @modified = params.dig(:modified)
+            @modified_user_id = params.dig(:modified_user_id)
+        end
+
+        ##
+        # @return [Uuid] The unique identifier for the Financial Institution Account.
+        attr_accessor :financial_institution_account_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] An alternate account id for the Financial Institution Account.
+        attr_accessor :bank_account_id
+
+        ##
+        # @return [String] The External Id for the Financial Institution Account.
+        attr_accessor :erp_key
+
+        ##
+        # @return [Uuid] The App Enrollment Id this Financial Institution is associated with.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [String] The name of the Financial Institution Account.
+        attr_accessor :name
+
+        ##
+        # @return [String] The status of the Financial Institution Account. Possible values are active, inactive, deleted or archived.
+        attr_accessor :status
+
+        ##
+        # @return [String] The description for the Financial Institution Account.
+        attr_accessor :description
+
+        ##
+        # @return [String] The classification for the Financial Institution Account. Possible values are Asset, Equity, Expense, Liability or Income.
+        attr_accessor :account_type
+
+        ##
+        # @return [Date-time] The date the Financial Institution Account was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The user that has created the Financial Institution Account.
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date the Financial Institution Account was modified.
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The user that has modified the Financial Institution Account.
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'financialInstitutionAccountId' => @financial_institution_account_id,
+                'groupKey' => @group_key,
+                'bankAccountId' => @bank_account_id,
+                'erpKey' => @erp_key,
+                'appEnrollmentId' => @app_enrollment_id,
+                'name' => @name,
+                'status' => @status,
+                'description' => @description,
+                'accountType' => @account_type,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_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/insert_payment_applied_request_model.rb

@@ -0,0 +1,83 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2023 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2023 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # A request to insert a payment application
+    class InsertPaymentAppliedRequestModel
+
+        ##
+        # Initialize the InsertPaymentAppliedRequestModel using the provided prototype
+        def initialize(params = {})
+            @payment_applied_id = params.dig(:payment_applied_id)
+            @invoice_id = params.dig(:invoice_id)
+            @payment_id = params.dig(:payment_id)
+            @erp_key = params.dig(:erp_key)
+            @invoice_erp_key = params.dig(:invoice_erp_key)
+            @apply_to_invoice_date = params.dig(:apply_to_invoice_date)
+            @payment_applied_amount = params.dig(:payment_applied_amount)
+        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 :payment_applied_id
+
+        ##
+        # @return [Uuid] The Invoice this payment is applied to.
+        attr_accessor :invoice_id
+
+        ##
+        # @return [Uuid] The Payment this application applies from.
+        attr_accessor :payment_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 ERP key of the Invoice this payment is applied to.
+        attr_accessor :invoice_erp_key
+
+        ##
+        # @return [Date-time] The date this payment was applied to this invoice.
+        attr_accessor :apply_to_invoice_date
+
+        ##
+        # @return [Double] The total amount that was applied to this Invoice from the Payment.
+        attr_accessor :payment_applied_amount
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'paymentAppliedId' => @payment_applied_id,
+                'invoiceId' => @invoice_id,
+                'paymentId' => @payment_id,
+                'erpKey' => @erp_key,
+                'invoiceErpKey' => @invoice_erp_key,
+                'applyToInvoiceDate' => @apply_to_invoice_date,
+                'paymentAppliedAmount' => @payment_applied_amount,
+            }
+        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/insert_payment_request_model.rb

@@ -0,0 +1,179 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2023 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2023 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # A request to insert a new Payment
+    class InsertPaymentRequestModel
+
+        ##
+        # Initialize the InsertPaymentRequestModel using the provided prototype
+        def initialize(params = {})
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @payment_id = params.dig(:payment_id)
+            @company_id = params.dig(:company_id)
+            @company_erp_key = params.dig(:company_erp_key)
+            @company_external_reference = params.dig(:company_external_reference)
+            @erp_key = params.dig(:erp_key)
+            @payment_type = params.dig(:payment_type)
+            @tender_type = params.dig(:tender_type)
+            @memo_text = params.dig(:memo_text)
+            @payment_date = params.dig(:payment_date)
+            @post_date = params.dig(:post_date)
+            @payment_amount = params.dig(:payment_amount)
+            @unapplied_amount = params.dig(:unapplied_amount)
+            @currency_code = params.dig(:currency_code)
+            @reference_code = params.dig(:reference_code)
+            @is_voided = params.dig(:is_voided)
+            @in_dispute = params.dig(:in_dispute)
+            @currency_rate = params.dig(:currency_rate)
+            @base_currency_payment_amount = params.dig(:base_currency_payment_amount)
+            @base_currency_unapplied_amount = params.dig(:base_currency_unapplied_amount)
+            @bank_account_id = params.dig(:bank_account_id)
+            @group_key = params.dig(:group_key)
+            @applications = params.dig(:applications)
+        end
+
+        ##
+        # @return [Uuid] The AppEnrollmentId of the application to write this record to.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @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 :payment_id
+
+        ##
+        # @return [Uuid] The ID of the company to which this payment belongs.
+        attr_accessor :company_id
+
+        ##
+        # @return [String] The ERP key for the company to which this payment belongs.
+        attr_accessor :company_erp_key
+
+        ##
+        # @return [String] A additional reference that may be used in the ERP
+        attr_accessor :company_external_reference
+
+        ##
+        # @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 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
+        attr_accessor :payment_type
+
+        ##
+        # @return [String] 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.
+        attr_accessor :tender_type
+
+        ##
+        # @return [String] Memo or reference text (ex. memo field on a check).
+        attr_accessor :memo_text
+
+        ##
+        # @return [Date-time] The date when this payment was received.
+        attr_accessor :payment_date
+
+        ##
+        # @return [Date-time] The date when a payment was posted to a ledger.
+        attr_accessor :post_date
+
+        ##
+        # @return [Double] Total amount of this payment in it's received currency.
+        attr_accessor :payment_amount
+
+        ##
+        # @return [Double] Unapplied balance of this payment in it's received currency. If this amount is nonzero, the field `IsOpen` will be true.
+        attr_accessor :unapplied_amount
+
+        ##
+        # @return [String] 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).
+        attr_accessor :currency_code
+
+        ##
+        # @return [String] Reference code for the payment for the given Erp system.
+        attr_accessor :reference_code
+
+        ##
+        # @return [Boolean] Is the payment voided?
+        attr_accessor :is_voided
+
+        ##
+        # @return [Boolean] Is the payment in dispute?
+        attr_accessor :in_dispute
+
+        ##
+        # @return [Double] The Currency Rate used to get from the account's base currency to the payment amount.
+        attr_accessor :currency_rate
+
+        ##
+        # @return [Double] Total amount of this payment in the group's base currency.
+        attr_accessor :base_currency_payment_amount
+
+        ##
+        # @return [Double] Unapplied balance of this payment in the group's base currency. If this amount is nonzero, the field `IsOpen` will be true.
+        attr_accessor :base_currency_unapplied_amount
+
+        ##
+        # @return [String] The Bank account id for the company to which this payment belongs.
+        attr_accessor :bank_account_id
+
+        ##
+        # @return [Uuid] The GroupKey this request belongs to.
+        attr_accessor :group_key
+
+        ##
+        # @return [InsertPaymentAppliedRequestModel] All applications this payment is associated with. To retrieve this collection, specify `Applications` in the "Include" parameter for your query.
+        attr_accessor :applications
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'appEnrollmentId' => @app_enrollment_id,
+                'paymentId' => @payment_id,
+                'companyId' => @company_id,
+                'companyErpKey' => @company_erp_key,
+                'companyExternalReference' => @company_external_reference,
+                'erpKey' => @erp_key,
+                'paymentType' => @payment_type,
+                'tenderType' => @tender_type,
+                'memoText' => @memo_text,
+                'paymentDate' => @payment_date,
+                'postDate' => @post_date,
+                'paymentAmount' => @payment_amount,
+                'unappliedAmount' => @unapplied_amount,
+                'currencyCode' => @currency_code,
+                'referenceCode' => @reference_code,
+                'isVoided' => @is_voided,
+                'inDispute' => @in_dispute,
+                'currencyRate' => @currency_rate,
+                'baseCurrencyPaymentAmount' => @base_currency_payment_amount,
+                'baseCurrencyUnappliedAmount' => @base_currency_unapplied_amount,
+                'bankAccountId' => @bank_account_id,
+                'groupKey' => @group_key,
+                'applications' => @applications,
+            }
+        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/insert_payment_request_model_erp_write_sync_submit_model.rb

@@ -0,0 +1,54 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2023 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2023 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Lockstep.Shared.Models.Sync.ErpWriteSyncSubmitModel`1 represents a request to write back a collection
+    #             of requests to the connected AppEnrollment.
+    class InsertPaymentRequestModelErpWriteSyncSubmitModel
+
+        ##
+        # Initialize the InsertPaymentRequestModelErpWriteSyncSubmitModel using the provided prototype
+        def initialize(params = {})
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @requests = params.dig(:requests)
+        end
+
+        ##
+        # @return [Uuid] The connected App Enrollment id.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [InsertPaymentRequestModel] An array of requests to write back.
+        attr_accessor :requests
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'appEnrollmentId' => @app_enrollment_id,
+                'requests' => @requests,
+            }
+        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_summary_model_invoice_summary_totals_model_summary_fetch_result.rb

@@ -21,18 +21,14 @@ module LockstepSdk
         ##
         # Initialize the InvoiceSummaryModelInvoiceSummaryTotalsModelSummaryFetchResult using the provided prototype
         def initialize(params = {})
-            @records = params.dig(:records)
             @total_count = params.dig(:total_count)
             @page_size = params.dig(:page_size)
             @page_number = params.dig(:page_number)
+            @records = params.dig(:records)
             @summary = params.dig(:summary)
             @aging_summary = params.dig(:aging_summary)
         end
 
-        ##
-        # @return [InvoiceSummaryModel] 
-        attr_accessor :records
-
         ##
         # @return [Int32] 
         attr_accessor :total_count
@@ -45,6 +41,10 @@ module LockstepSdk
         # @return [Int32] 
         attr_accessor :page_number
 
+        ##
+        # @return [InvoiceSummaryModel] 
+        attr_accessor :records
+
         ##
         # @return [InvoiceSummaryTotalsModel] The totals for an Invoice Summary
         attr_accessor :summary
@@ -57,10 +57,10 @@ module LockstepSdk
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
-                'records' => @records,
                 'totalCount' => @total_count,
                 'pageSize' => @page_size,
                 'pageNumber' => @page_number,
+                'records' => @records,
                 'summary' => @summary,
                 'agingSummary' => @aging_summary,
             }

data/lib/lockstep_sdk/models/payment_model.rb

@@ -44,6 +44,7 @@ module LockstepSdk
             @payment_amount = params.dig(:payment_amount)
             @unapplied_amount = params.dig(:unapplied_amount)
             @currency_code = params.dig(:currency_code)
+            @bank_account_id = params.dig(:bank_account_id)
             @reference_code = params.dig(:reference_code)
             @created = params.dig(:created)
             @created_user_id = params.dig(:created_user_id)
@@ -124,6 +125,10 @@ module LockstepSdk
         # @return [String] 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).
         attr_accessor :currency_code
 
+        ##
+        # @return [String] The Bank account id for the company to which this payment belongs.
+        attr_accessor :bank_account_id
+
         ##
         # @return [String] Reference code for the payment for the given Erp system.
         attr_accessor :reference_code
@@ -215,6 +220,7 @@ module LockstepSdk
                 'paymentAmount' => @payment_amount,
                 'unappliedAmount' => @unapplied_amount,
                 'currencyCode' => @currency_code,
+                'bankAccountId' => @bank_account_id,
                 'referenceCode' => @reference_code,
                 'created' => @created,
                 'createdUserId' => @created_user_id,

data/lib/lockstep_sdk/models/payment_model_erp_write_result.rb

@@ -0,0 +1,77 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2023 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2023 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Contains results of a write back request
+    class PaymentModelErpWriteResult
+
+        ##
+        # Initialize the PaymentModelErpWriteResult using the provided prototype
+        def initialize(params = {})
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @erp_key = params.dig(:erp_key)
+            @group_key = params.dig(:group_key)
+            @message = params.dig(:message)
+            @sync_request_id = params.dig(:sync_request_id)
+            @results = params.dig(:results)
+        end
+
+        ##
+        # @return [Uuid] The id of the connected AppEnrollmentModel
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [String] The ErpKey for the object written to the Erp if created
+        attr_accessor :erp_key
+
+        ##
+        # @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] An optional message to return with the result
+        attr_accessor :message
+
+        ##
+        # @return [Uuid] The id of the SyncRequestModel the requests were added to
+        attr_accessor :sync_request_id
+
+        ##
+        # @return [PaymentModel] Results from the ERP write operation
+        attr_accessor :results
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'appEnrollmentId' => @app_enrollment_id,
+                'erpKey' => @erp_key,
+                'groupKey' => @group_key,
+                'message' => @message,
+                'syncRequestId' => @sync_request_id,
+                'results' => @results,
+            }
+        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/payment_sync_model.rb

@@ -51,6 +51,7 @@ module LockstepSdk
             @currency_rate = params.dig(:currency_rate)
             @base_currency_payment_amount = params.dig(:base_currency_payment_amount)
             @base_currency_unapplied_amount = params.dig(:base_currency_unapplied_amount)
+            @bank_account_id = params.dig(:bank_account_id)
         end
 
         ##
@@ -133,6 +134,10 @@ module LockstepSdk
         # @return [Double] Unapplied balance of this payment in the erp's base currency. If this amount is nonzero, the field `IsOpen` will be true.
         attr_accessor :base_currency_unapplied_amount
 
+        ##
+        # @return [String] Bank account id for the payment.
+        attr_accessor :bank_account_id
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -157,6 +162,7 @@ module LockstepSdk
                 'currencyRate' => @currency_rate,
                 'baseCurrencyPaymentAmount' => @base_currency_payment_amount,
                 'baseCurrencyUnappliedAmount' => @base_currency_unapplied_amount,
+                'bankAccountId' => @bank_account_id,
             }
         end
 

data/lib/lockstep_sdk/models/user_account_model.rb

@@ -56,6 +56,7 @@ module LockstepSdk
             @description = params.dig(:description)
             @b2_clast_logged_in = params.dig(:b2_clast_logged_in)
             @default_currency_code = params.dig(:default_currency_code)
+            @locale = params.dig(:locale)
             @notes = params.dig(:notes)
             @attachments = params.dig(:attachments)
             @custom_field_values = params.dig(:custom_field_values)
@@ -178,6 +179,10 @@ module LockstepSdk
         # @return [String] The default currency code used by this user 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) This will be validated by the /api/v1/definitions/currencies data set
         attr_accessor :default_currency_code
 
+        ##
+        # @return [String] The IETF language tag for the user's preferred locale.
+        attr_accessor :locale
+
         ##
         # @return [NoteModel] A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the `include` parameter when retrieving data. To create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes) endpoint with the `TableKey` to `UserAccount` and the `ObjectKey` set to the `UserId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :notes
@@ -227,6 +232,7 @@ module LockstepSdk
                 'description' => @description,
                 'b2CLastLoggedIn' => @b2_clast_logged_in,
                 'defaultCurrencyCode' => @default_currency_code,
+                'locale' => @locale,
                 'notes' => @notes,
                 'attachments' => @attachments,
                 'customFieldValues' => @custom_field_values,

data/lib/lockstep_sdk/version.rb

@@ -1,3 +1,3 @@
 module LockstepSdk
-    VERSION = "2023.17.21.0"
+    VERSION = "2023.28.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockstep_sdk
 version: !ruby/object:Gem::Version
-  version: 2023.17.21.0
+  version: 2023.28.10.0
 platform: ruby
 authors:
 - Lockstep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-27 00:00:00.000000000 Z
+date: 2023-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awrence
@@ -48,6 +48,7 @@ files:
 - lib/lockstep_sdk/clients/feature_flags_client.rb
 - lib/lockstep_sdk/clients/financial_account_balance_history_client.rb
 - lib/lockstep_sdk/clients/financial_account_client.rb
+- lib/lockstep_sdk/clients/financial_institution_accounts_client.rb
 - lib/lockstep_sdk/clients/financial_year_settings_client.rb
 - lib/lockstep_sdk/clients/group_accounts_client.rb
 - lib/lockstep_sdk/clients/invoice_addresses_client.rb
@@ -130,12 +131,16 @@ files:
 - lib/lockstep_sdk/models/financial_account_balance_history_sync_model.rb
 - lib/lockstep_sdk/models/financial_account_model.rb
 - lib/lockstep_sdk/models/financial_account_sync_model.rb
+- lib/lockstep_sdk/models/financial_institution_account_model.rb
 - lib/lockstep_sdk/models/financial_report_cell_model.rb
 - lib/lockstep_sdk/models/financial_report_model.rb
 - lib/lockstep_sdk/models/financial_report_row_model.rb
 - lib/lockstep_sdk/models/financial_year_setting_model.rb
 - lib/lockstep_sdk/models/financial_year_setting_sync_model.rb
 - lib/lockstep_sdk/models/group_account_model.rb
+- lib/lockstep_sdk/models/insert_payment_applied_request_model.rb
+- lib/lockstep_sdk/models/insert_payment_request_model.rb
+- lib/lockstep_sdk/models/insert_payment_request_model_erp_write_sync_submit_model.rb
 - lib/lockstep_sdk/models/invite_data_model.rb
 - lib/lockstep_sdk/models/invite_model.rb
 - lib/lockstep_sdk/models/invite_submit_model.rb
@@ -161,6 +166,7 @@ files:
 - lib/lockstep_sdk/models/payment_detail_header_model.rb
 - lib/lockstep_sdk/models/payment_detail_model.rb
 - lib/lockstep_sdk/models/payment_model.rb
+- lib/lockstep_sdk/models/payment_model_erp_write_result.rb
 - lib/lockstep_sdk/models/payment_summary_model.rb
 - lib/lockstep_sdk/models/payment_summary_model_payment_summary_totals_model_summary_fetch_result.rb
 - lib/lockstep_sdk/models/payment_summary_totals_model.rb