lockstep_sdk 2023.13.37.0 → 2023.28.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (29) hide show
  1. checksums.yaml +4 -4
  2. data/lib/lockstep_sdk/clients/definitions_client.rb +0 -4
  3. data/lib/lockstep_sdk/clients/financial_institution_accounts_client.rb +49 -0
  4. data/lib/lockstep_sdk/clients/invoices_client.rb +3 -1
  5. data/lib/lockstep_sdk/clients/leads_client.rb +0 -1
  6. data/lib/lockstep_sdk/clients/payments_client.rb +12 -1
  7. data/lib/lockstep_sdk/clients/profiles_companies_client.rb +0 -2
  8. data/lib/lockstep_sdk/clients/status_client.rb +0 -1
  9. data/lib/lockstep_sdk/clients/user_accounts_client.rb +0 -1
  10. data/lib/lockstep_sdk/lockstep_api.rb +8 -3
  11. data/lib/lockstep_sdk/models/cashflow_report_model.rb +8 -2
  12. data/lib/lockstep_sdk/models/company_sync_model.rb +1 -1
  13. data/lib/lockstep_sdk/models/financial_account_balance_history_sync_model.rb +1 -1
  14. data/lib/lockstep_sdk/models/financial_account_sync_model.rb +1 -1
  15. data/lib/lockstep_sdk/models/financial_institution_account_model.rb +119 -0
  16. data/lib/lockstep_sdk/models/insert_payment_applied_request_model.rb +83 -0
  17. data/lib/lockstep_sdk/models/insert_payment_request_model.rb +179 -0
  18. data/lib/lockstep_sdk/models/insert_payment_request_model_erp_write_sync_submit_model.rb +54 -0
  19. data/lib/lockstep_sdk/models/invoice_line_model.rb +18 -0
  20. data/lib/lockstep_sdk/models/invoice_model.rb +18 -0
  21. data/lib/lockstep_sdk/models/invoice_summary_model_invoice_summary_totals_model_summary_fetch_result.rb +6 -6
  22. data/lib/lockstep_sdk/models/payment_model.rb +6 -0
  23. data/lib/lockstep_sdk/models/payment_model_erp_write_result.rb +77 -0
  24. data/lib/lockstep_sdk/models/payment_summary_model_payment_summary_totals_model_summary_fetch_result.rb +6 -6
  25. data/lib/lockstep_sdk/models/payment_sync_model.rb +6 -0
  26. data/lib/lockstep_sdk/models/user_account_model.rb +6 -0
  27. data/lib/lockstep_sdk/version.rb +1 -1
  28. metadata +8 -3
  29. data/lib/lockstep_sdk/models/error_result.rb +0 -77
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 94c3d82bb006438d2d6083a2a1f777ec72d8e3e53a8e9f9d15f97c739c5c7fa3
4
- data.tar.gz: f4a97901a63f1ff48303b5439c197a013255e160aea87e32e5e4da928381a147
3
+ metadata.gz: 89d89e36f182a9dc0df9de4c64f8d0f5e6b746a1c97e0dc2192fb76c04fafa58
4
+ data.tar.gz: be9e2cc6dab403e7b2fabde7b86a94690e552b0a4f931bcfb5ad4f2d16b63719
5
5
  SHA512:
6
- metadata.gz: 15a56c02466b9db83340d47aaca8d230fbd44be948d30c034c302a203ebb1309a3286522d15195fe59704676e4dcdef012b7d50f303a37929df5dd69b7e12a91
7
- data.tar.gz: c92e2b1e5e991cc98029cecd28adfcd780a643bd223bc1682bdfc7e7a1d7bf68bd60fbe351b77df0ba2e0818638ac1d7b899dddbe04e7863e1f0c1bdcc929ce2
6
+ metadata.gz: 896d279b860eed578020f323a70683d8fdbcd468d7d49b7eb3c32e72d2c4a8d01b386882f531b2abe1782bfc2c13fcf8b4db5e4506e7999be2e44a805219fc29
7
+ data.tar.gz: fd10fac66bd3b0951864c7df8e7b6094f5d72d29d7cced8ae8f0b05eefe15c2e8aee24c5bdd1c3abb0f92fe29d7dc1f47eb53f32be06b02eb661fe2b4475df5c
@@ -30,7 +30,6 @@ class DefinitionsClient
30
30
  # 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.
31
31
  #
32
32
  # 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.
33
- #
34
33
  # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
35
34
  # @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.
36
35
  # @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
48
47
  # 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.
49
48
  #
50
49
  # 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.
51
- #
52
50
  # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
53
51
  # @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.
54
52
  # @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
66
64
  # 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.
67
65
  #
68
66
  # 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.
69
- #
70
67
  # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
71
68
  # @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.
72
69
  # @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
84
81
  # 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.
85
82
  #
86
83
  # 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.
87
- #
88
84
  # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
89
85
  # @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.
90
86
  # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
@@ -0,0 +1,49 @@
1
+ #
2
+ # Lockstep Platform SDK for Ruby
3
+ #
4
+ # (c) 2021-2023 Lockstep, Inc.
5
+ #
6
+ # For the full copyright and license information, please view the LICENSE
7
+ # file that was distributed with this source code.
8
+ #
9
+ # @author Lockstep Network <support@lockstep.io>
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
+ # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
+ #
13
+
14
+
15
+ require 'awrence'
16
+
17
+ class FinancialInstitutionAccountsClient
18
+
19
+ ##
20
+ # Initialize the FinancialInstitutionAccountsClient class with an API client instance.
21
+ # @param connection [LockstepApi] The API client object for this connection
22
+ def initialize(connection)
23
+ @connection = connection
24
+ end
25
+
26
+
27
+ ##
28
+ # Retrieves the financial institution account specified by this unique identifier.
29
+ #
30
+ # @param id [uuid] The unique Lockstep Platform ID number of this institution account; NOT the customer's ERP key
31
+ def retrieve_financial_institution_accounts(id:)
32
+ path = "/api/v1/financial-institution-accounts/#{id}"
33
+ @connection.request(:get, path, nil, nil)
34
+ end
35
+
36
+ ##
37
+ #
38
+ #
39
+ # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
40
+ # @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.
41
+ # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
42
+ # @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)
43
+ # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
44
+ def query_financial_institution_accounts(filter:, include_param:, order:, page_size:, page_number:)
45
+ path = "/api/v1/financial-institution-accounts/query"
46
+ params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
47
+ @connection.request(:get, path, nil, params)
48
+ end
49
+ end
@@ -105,10 +105,12 @@ class InvoicesClient
105
105
  #
106
106
  # Sage Intacct supports AR Invoices.
107
107
  #
108
- # Quickbooks Online supports AR Invoices, and AR Credit Memos.
108
+ # QuickBooks Online supports AR Invoices, and AR Credit Memos.
109
109
  #
110
110
  # Xero supports AR Invoices, AP Invoices, AR Credit Memos, and AP Credit Memos.
111
111
  #
112
+ # Sage 50 supports AR Invoices and AR Credit Memos.
113
+ #
112
114
  # @param id [uuid] The unique Lockstep Platform ID number of this invoice; NOT the customer's ERP key
113
115
  def retrieve_invoice_pdf(id:)
114
116
  path = "/api/v1/Invoices/#{id}/pdf"
@@ -28,7 +28,6 @@ class LeadsClient
28
28
  # Creates one or more Leads within the Lockstep platform and returns the records as created.
29
29
  #
30
30
  # 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.
31
- #
32
31
  # @param body [LeadModel] The Leads to create
33
32
  def create_leads(body:)
34
33
  path = "/api/v1/Leads"
@@ -94,7 +94,7 @@ class PaymentsClient
94
94
  ##
95
95
  # Retrieves a PDF file for this payment if it has been synced using an app enrollment to one of the supported apps.
96
96
  #
97
- # Quickbooks Online supports AR Payments.
97
+ # QuickBooks Online supports AR Payments.
98
98
  #
99
99
  # @param id [uuid] The unique Lockstep Platform ID number of this payment; NOT the customer's ERP key
100
100
  def retrieve_payment_pdf(id:)
@@ -143,4 +143,15 @@ class PaymentsClient
143
143
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
144
144
  @connection.request(:get, path, nil, params)
145
145
  end
146
+
147
+ ##
148
+ # **This API endpoint is under maintenance and may not function properly.** Schedule an ERP post request for payments.
149
+ #
150
+ # The payments must be associated with an active app enrollment and have a valid `AppEnrollmentId`.
151
+ #
152
+ # @param body [InsertPaymentRequestModelErpWriteSyncSubmitModel] The payments to submit to the connected ERP
153
+ def write_payments_to_connected_erp(body:)
154
+ path = "/api/v1/Payments/erp-write"
155
+ @connection.request(:post, path, body, nil)
156
+ end
146
157
  end
@@ -28,7 +28,6 @@ class ProfilesCompaniesClient
28
28
  # Retrieves the Public Company Profile specified by the public url slug.
29
29
  #
30
30
  # 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>
31
- #
32
31
  # @param url_slug [string]
33
32
  def retrieve_public_company_profile(url_slug:)
34
33
  path = "/api/v1/profiles/companies/#{urlSlug}"
@@ -43,7 +42,6 @@ class ProfilesCompaniesClient
43
42
  # A Public Company Profile makes available the following information:
44
43
  #
45
44
  # <ul><li>Company Name</li><li>Company Logo Url</li><li>Description</li><li>Website</li></ul>
46
- #
47
45
  # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
48
46
  # @param order [string] The sort order for the results, in the [Searchlight order syntax](https://github.com/tspence/csharp-searchlight).
49
47
  # @param page_size [int32] The page size for results (default 250, maximum of 500)
@@ -28,7 +28,6 @@ class StatusClient
28
28
  # Verifies that your application can successfully call the Lockstep Platform API and returns a successful code regardless of your authentication status or permissions.
29
29
  #
30
30
  # 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
31
- #
32
31
  def ping()
33
32
  path = "/api/v1/Status"
34
33
  @connection.request(:get, path, nil, nil)
@@ -77,7 +77,6 @@ class UserAccountsClient
77
77
  # Retrieves invite information for the specified invite token.
78
78
  #
79
79
  # 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.
80
- #
81
80
  # @param code [uuid] The code of the invite
82
81
  def retrieve_invite_data(code:)
83
82
  path = "/api/v1/UserAccounts/invite"
@@ -9,7 +9,7 @@
9
9
  # @author Lockstep Network <support@lockstep.io>
10
10
  # Manish Narayan B S <manish.n@lockstep.io>, Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
11
11
  # @copyright 2021-2023 Lockstep, Inc.
12
- # @version 2023.13.37
12
+ # @version 2023.28.10
13
13
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
14
14
  #
15
15
 
@@ -96,6 +96,10 @@ module lockstep_sdk
96
96
  # @return [FinancialAccountBalanceHistoryClient] Client object for FinancialAccountBalanceHistory endpoints
97
97
  attr_accessor :financial_account_balance_history
98
98
 
99
+ ##
100
+ # @return [FinancialInstitutionAccountsClient] Client object for FinancialInstitutionAccounts endpoints
101
+ attr_accessor :financial_institution_accounts
102
+
99
103
  ##
100
104
  # @return [FinancialYearSettingsClient] Client object for FinancialYearSettings endpoints
101
105
  attr_accessor :financial_year_settings
@@ -194,7 +198,7 @@ module lockstep_sdk
194
198
  #
195
199
  # @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
196
200
  def initialize(env)
197
- @version = "2023.13.37.0"
201
+ @version = "2023.28.10.0"
198
202
  @env = case env
199
203
  when "sbx"
200
204
  "https://api.sbx.lockstep.io/"
@@ -221,6 +225,7 @@ module lockstep_sdk
221
225
  @feature_flags = FeatureFlagsClient.new(self)
222
226
  @financial_account = FinancialAccountClient.new(self)
223
227
  @financial_account_balance_history = FinancialAccountBalanceHistoryClient.new(self)
228
+ @financial_institution_accounts = FinancialInstitutionAccountsClient.new(self)
224
229
  @financial_year_settings = FinancialYearSettingsClient.new(self)
225
230
  @group_accounts = GroupAccountsClient.new(self)
226
231
  @invoice_addresses = InvoiceAddressesClient.new(self)
@@ -307,7 +312,7 @@ module lockstep_sdk
307
312
  request["Accept"] = 'application/json'
308
313
  request["Content-Type"] = 'application/*+json'
309
314
  request["SdkType"] = 'Ruby'
310
- request["SdkVersion"] = '2023.13.37.0'
315
+ request["SdkVersion"] = '2023.28.10.0'
311
316
  request["MachineName"] = Socket.gethostname
312
317
  request.body = body
313
318
 
@@ -24,6 +24,7 @@ module LockstepSdk
24
24
  # Initialize the CashflowReportModel using the provided prototype
25
25
  def initialize(params = {})
26
26
  @timeframe = params.dig(:timeframe)
27
+ @base_currency_code = params.dig(:base_currency_code)
27
28
  @payments_collected = params.dig(:payments_collected)
28
29
  @payments_collected_count = params.dig(:payments_collected_count)
29
30
  @invoices_billed = params.dig(:invoices_billed)
@@ -35,7 +36,11 @@ module LockstepSdk
35
36
  attr_accessor :timeframe
36
37
 
37
38
  ##
38
- # @return [Double] Amount of payments collected based in the timeframe
39
+ # @return [String] The base currency code of the group.
40
+ attr_accessor :base_currency_code
41
+
42
+ ##
43
+ # @return [Double] Amount of payments collected based in the timeframe in the group's base currency
39
44
  attr_accessor :payments_collected
40
45
 
41
46
  ##
@@ -43,7 +48,7 @@ module LockstepSdk
43
48
  attr_accessor :payments_collected_count
44
49
 
45
50
  ##
46
- # @return [Double] Amount of invoices billed based in the timeframe
51
+ # @return [Double] Amount of invoices billed based in the timeframe in the group's base currency
47
52
  attr_accessor :invoices_billed
48
53
 
49
54
  ##
@@ -55,6 +60,7 @@ module LockstepSdk
55
60
  def as_json(options={})
56
61
  {
57
62
  'timeframe' => @timeframe,
63
+ 'baseCurrencyCode' => @base_currency_code,
58
64
  'paymentsCollected' => @payments_collected,
59
65
  'paymentsCollectedCount' => @payments_collected_count,
60
66
  'invoicesBilled' => @invoices_billed,
@@ -66,7 +66,7 @@ module LockstepSdk
66
66
  attr_accessor :on_match_action
67
67
 
68
68
  ##
69
- # @return [String] This is the primary key of the Company record. For this field, you should use whatever the company's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your company records in a database, whatever the primary key for the company table is in the database should be the `ErpKey`. Example: If you use a financial system such as Quickbooks or Xero, look for the primary ID number of the company record within that financial system. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
69
+ # @return [String] This is the primary key of the Company record. For this field, you should use whatever the company's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your company records in a database, whatever the primary key for the company table is in the database should be the `ErpKey`. Example: If you use a financial system such as QuickBooks or Xero, look for the primary ID number of the company record within that financial system. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
70
70
  attr_accessor :erp_key
71
71
 
72
72
  ##
@@ -50,7 +50,7 @@ module LockstepSdk
50
50
  attr_accessor :financial_account_code
51
51
 
52
52
  ##
53
- # @return [String] This is the primary key of the FinancialAccount record. For this field, you should use whatever the company's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your company records in a database, whatever the primary key for the company table is in the database should be the ErpKey. Example: If you use a financial system such as Quickbooks or Xero, look for the primary ID number of the company record within that financial system.
53
+ # @return [String] This is the primary key of the FinancialAccount record. For this field, you should use whatever the company's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your company records in a database, whatever the primary key for the company table is in the database should be the ErpKey. Example: If you use a financial system such as QuickBooks or Xero, look for the primary ID number of the company record within that financial system.
54
54
  attr_accessor :financial_account_erp_key
55
55
 
56
56
  ##
@@ -72,7 +72,7 @@ module LockstepSdk
72
72
  attr_accessor :description
73
73
 
74
74
  ##
75
- # @return [String] The classification for the Financial Account. Possible values are Asset, Equity, Expense, Liability or Income.
75
+ # @return [String] The classification for the Financial Account. Possible values are Asset, Equity, Expense, Liability, Income, CreditCard, Checking, or Savings.
76
76
  attr_accessor :classification
77
77
 
78
78
  ##
@@ -0,0 +1,119 @@
1
+ #
2
+ # Lockstep Platform SDK for Ruby
3
+ #
4
+ # (c) 2021-2023 Lockstep, Inc.
5
+ #
6
+ # For the full copyright and license information, please view the LICENSE
7
+ # file that was distributed with this source code.
8
+ #
9
+ # @author Lockstep Network <support@lockstep.io>
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
+ # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
+ #
13
+
14
+
15
+ require 'json'
16
+
17
+ module LockstepSdk
18
+
19
+ ##
20
+ # An Financial Institution Account represents an account used for monetary transactions. E.g. - checking, savings, or credit card accounts.
21
+ class FinancialInstitutionAccountModel
22
+
23
+ ##
24
+ # Initialize the FinancialInstitutionAccountModel using the provided prototype
25
+ def initialize(params = {})
26
+ @financial_institution_account_id = params.dig(:financial_institution_account_id)
27
+ @group_key = params.dig(:group_key)
28
+ @bank_account_id = params.dig(:bank_account_id)
29
+ @erp_key = params.dig(:erp_key)
30
+ @app_enrollment_id = params.dig(:app_enrollment_id)
31
+ @name = params.dig(:name)
32
+ @status = params.dig(:status)
33
+ @description = params.dig(:description)
34
+ @account_type = params.dig(:account_type)
35
+ @created = params.dig(:created)
36
+ @created_user_id = params.dig(:created_user_id)
37
+ @modified = params.dig(:modified)
38
+ @modified_user_id = params.dig(:modified_user_id)
39
+ end
40
+
41
+ ##
42
+ # @return [Uuid] The unique identifier for the Financial Institution Account.
43
+ attr_accessor :financial_institution_account_id
44
+
45
+ ##
46
+ # @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).
47
+ attr_accessor :group_key
48
+
49
+ ##
50
+ # @return [String] An alternate account id for the Financial Institution Account.
51
+ attr_accessor :bank_account_id
52
+
53
+ ##
54
+ # @return [String] The External Id for the Financial Institution Account.
55
+ attr_accessor :erp_key
56
+
57
+ ##
58
+ # @return [Uuid] The App Enrollment Id this Financial Institution is associated with.
59
+ attr_accessor :app_enrollment_id
60
+
61
+ ##
62
+ # @return [String] The name of the Financial Institution Account.
63
+ attr_accessor :name
64
+
65
+ ##
66
+ # @return [String] The status of the Financial Institution Account. Possible values are active, inactive, deleted or archived.
67
+ attr_accessor :status
68
+
69
+ ##
70
+ # @return [String] The description for the Financial Institution Account.
71
+ attr_accessor :description
72
+
73
+ ##
74
+ # @return [String] The classification for the Financial Institution Account. Possible values are Asset, Equity, Expense, Liability or Income.
75
+ attr_accessor :account_type
76
+
77
+ ##
78
+ # @return [Date-time] The date the Financial Institution Account was created.
79
+ attr_accessor :created
80
+
81
+ ##
82
+ # @return [Uuid] The user that has created the Financial Institution Account.
83
+ attr_accessor :created_user_id
84
+
85
+ ##
86
+ # @return [Date-time] The date the Financial Institution Account was modified.
87
+ attr_accessor :modified
88
+
89
+ ##
90
+ # @return [Uuid] The user that has modified the Financial Institution Account.
91
+ attr_accessor :modified_user_id
92
+
93
+ ##
94
+ # @return [object] This object as a JSON key-value structure
95
+ def as_json(options={})
96
+ {
97
+ 'financialInstitutionAccountId' => @financial_institution_account_id,
98
+ 'groupKey' => @group_key,
99
+ 'bankAccountId' => @bank_account_id,
100
+ 'erpKey' => @erp_key,
101
+ 'appEnrollmentId' => @app_enrollment_id,
102
+ 'name' => @name,
103
+ 'status' => @status,
104
+ 'description' => @description,
105
+ 'accountType' => @account_type,
106
+ 'created' => @created,
107
+ 'createdUserId' => @created_user_id,
108
+ 'modified' => @modified,
109
+ 'modifiedUserId' => @modified_user_id,
110
+ }
111
+ end
112
+
113
+ ##
114
+ # @return [String] This object converted to a JSON string
115
+ def to_json(*options)
116
+ "[#{as_json(*options).to_json(*options)}]"
117
+ end
118
+ end
119
+ end
@@ -0,0 +1,83 @@
1
+ #
2
+ # Lockstep Platform SDK for Ruby
3
+ #
4
+ # (c) 2021-2023 Lockstep, Inc.
5
+ #
6
+ # For the full copyright and license information, please view the LICENSE
7
+ # file that was distributed with this source code.
8
+ #
9
+ # @author Lockstep Network <support@lockstep.io>
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
+ # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
+ #
13
+
14
+
15
+ require 'json'
16
+
17
+ module LockstepSdk
18
+
19
+ ##
20
+ # A request to insert a payment application
21
+ class InsertPaymentAppliedRequestModel
22
+
23
+ ##
24
+ # Initialize the InsertPaymentAppliedRequestModel using the provided prototype
25
+ def initialize(params = {})
26
+ @payment_applied_id = params.dig(:payment_applied_id)
27
+ @invoice_id = params.dig(:invoice_id)
28
+ @payment_id = params.dig(:payment_id)
29
+ @erp_key = params.dig(:erp_key)
30
+ @invoice_erp_key = params.dig(:invoice_erp_key)
31
+ @apply_to_invoice_date = params.dig(:apply_to_invoice_date)
32
+ @payment_applied_amount = params.dig(:payment_applied_amount)
33
+ end
34
+
35
+ ##
36
+ # @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`.
37
+ attr_accessor :payment_applied_id
38
+
39
+ ##
40
+ # @return [Uuid] The Invoice this payment is applied to.
41
+ attr_accessor :invoice_id
42
+
43
+ ##
44
+ # @return [Uuid] The Payment this application applies from.
45
+ attr_accessor :payment_id
46
+
47
+ ##
48
+ # @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).
49
+ attr_accessor :erp_key
50
+
51
+ ##
52
+ # @return [String] The ERP key of the Invoice this payment is applied to.
53
+ attr_accessor :invoice_erp_key
54
+
55
+ ##
56
+ # @return [Date-time] The date this payment was applied to this invoice.
57
+ attr_accessor :apply_to_invoice_date
58
+
59
+ ##
60
+ # @return [Double] The total amount that was applied to this Invoice from the Payment.
61
+ attr_accessor :payment_applied_amount
62
+
63
+ ##
64
+ # @return [object] This object as a JSON key-value structure
65
+ def as_json(options={})
66
+ {
67
+ 'paymentAppliedId' => @payment_applied_id,
68
+ 'invoiceId' => @invoice_id,
69
+ 'paymentId' => @payment_id,
70
+ 'erpKey' => @erp_key,
71
+ 'invoiceErpKey' => @invoice_erp_key,
72
+ 'applyToInvoiceDate' => @apply_to_invoice_date,
73
+ 'paymentAppliedAmount' => @payment_applied_amount,
74
+ }
75
+ end
76
+
77
+ ##
78
+ # @return [String] This object converted to a JSON string
79
+ def to_json(*options)
80
+ "[#{as_json(*options).to_json(*options)}]"
81
+ end
82
+ end
83
+ end
@@ -0,0 +1,179 @@
1
+ #
2
+ # Lockstep Platform SDK for Ruby
3
+ #
4
+ # (c) 2021-2023 Lockstep, Inc.
5
+ #
6
+ # For the full copyright and license information, please view the LICENSE
7
+ # file that was distributed with this source code.
8
+ #
9
+ # @author Lockstep Network <support@lockstep.io>
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
+ # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
+ #
13
+
14
+
15
+ require 'json'
16
+
17
+ module LockstepSdk
18
+
19
+ ##
20
+ # A request to insert a new Payment
21
+ class InsertPaymentRequestModel
22
+
23
+ ##
24
+ # Initialize the InsertPaymentRequestModel using the provided prototype
25
+ def initialize(params = {})
26
+ @app_enrollment_id = params.dig(:app_enrollment_id)
27
+ @payment_id = params.dig(:payment_id)
28
+ @company_id = params.dig(:company_id)
29
+ @company_erp_key = params.dig(:company_erp_key)
30
+ @company_external_reference = params.dig(:company_external_reference)
31
+ @erp_key = params.dig(:erp_key)
32
+ @payment_type = params.dig(:payment_type)
33
+ @tender_type = params.dig(:tender_type)
34
+ @memo_text = params.dig(:memo_text)
35
+ @payment_date = params.dig(:payment_date)
36
+ @post_date = params.dig(:post_date)
37
+ @payment_amount = params.dig(:payment_amount)
38
+ @unapplied_amount = params.dig(:unapplied_amount)
39
+ @currency_code = params.dig(:currency_code)
40
+ @reference_code = params.dig(:reference_code)
41
+ @is_voided = params.dig(:is_voided)
42
+ @in_dispute = params.dig(:in_dispute)
43
+ @currency_rate = params.dig(:currency_rate)
44
+ @base_currency_payment_amount = params.dig(:base_currency_payment_amount)
45
+ @base_currency_unapplied_amount = params.dig(:base_currency_unapplied_amount)
46
+ @bank_account_id = params.dig(:bank_account_id)
47
+ @group_key = params.dig(:group_key)
48
+ @applications = params.dig(:applications)
49
+ end
50
+
51
+ ##
52
+ # @return [Uuid] The AppEnrollmentId of the application to write this record to.
53
+ attr_accessor :app_enrollment_id
54
+
55
+ ##
56
+ # @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`.
57
+ attr_accessor :payment_id
58
+
59
+ ##
60
+ # @return [Uuid] The ID of the company to which this payment belongs.
61
+ attr_accessor :company_id
62
+
63
+ ##
64
+ # @return [String] The ERP key for the company to which this payment belongs.
65
+ attr_accessor :company_erp_key
66
+
67
+ ##
68
+ # @return [String] A additional reference that may be used in the ERP
69
+ attr_accessor :company_external_reference
70
+
71
+ ##
72
+ # @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).
73
+ attr_accessor :erp_key
74
+
75
+ ##
76
+ # @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
77
+ attr_accessor :payment_type
78
+
79
+ ##
80
+ # @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.
81
+ attr_accessor :tender_type
82
+
83
+ ##
84
+ # @return [String] Memo or reference text (ex. memo field on a check).
85
+ attr_accessor :memo_text
86
+
87
+ ##
88
+ # @return [Date-time] The date when this payment was received.
89
+ attr_accessor :payment_date
90
+
91
+ ##
92
+ # @return [Date-time] The date when a payment was posted to a ledger.
93
+ attr_accessor :post_date
94
+
95
+ ##
96
+ # @return [Double] Total amount of this payment in it's received currency.
97
+ attr_accessor :payment_amount
98
+
99
+ ##
100
+ # @return [Double] Unapplied balance of this payment in it's received currency. If this amount is nonzero, the field `IsOpen` will be true.
101
+ attr_accessor :unapplied_amount
102
+
103
+ ##
104
+ # @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).
105
+ attr_accessor :currency_code
106
+
107
+ ##
108
+ # @return [String] Reference code for the payment for the given Erp system.
109
+ attr_accessor :reference_code
110
+
111
+ ##
112
+ # @return [Boolean] Is the payment voided?
113
+ attr_accessor :is_voided
114
+
115
+ ##
116
+ # @return [Boolean] Is the payment in dispute?
117
+ attr_accessor :in_dispute
118
+
119
+ ##
120
+ # @return [Double] The Currency Rate used to get from the account's base currency to the payment amount.
121
+ attr_accessor :currency_rate
122
+
123
+ ##
124
+ # @return [Double] Total amount of this payment in the group's base currency.
125
+ attr_accessor :base_currency_payment_amount
126
+
127
+ ##
128
+ # @return [Double] Unapplied balance of this payment in the group's base currency. If this amount is nonzero, the field `IsOpen` will be true.
129
+ attr_accessor :base_currency_unapplied_amount
130
+
131
+ ##
132
+ # @return [String] The Bank account id for the company to which this payment belongs.
133
+ attr_accessor :bank_account_id
134
+
135
+ ##
136
+ # @return [Uuid] The GroupKey this request belongs to.
137
+ attr_accessor :group_key
138
+
139
+ ##
140
+ # @return [InsertPaymentAppliedRequestModel] All applications this payment is associated with. To retrieve this collection, specify `Applications` in the "Include" parameter for your query.
141
+ attr_accessor :applications
142
+
143
+ ##
144
+ # @return [object] This object as a JSON key-value structure
145
+ def as_json(options={})
146
+ {
147
+ 'appEnrollmentId' => @app_enrollment_id,
148
+ 'paymentId' => @payment_id,
149
+ 'companyId' => @company_id,
150
+ 'companyErpKey' => @company_erp_key,
151
+ 'companyExternalReference' => @company_external_reference,
152
+ 'erpKey' => @erp_key,
153
+ 'paymentType' => @payment_type,
154
+ 'tenderType' => @tender_type,
155
+ 'memoText' => @memo_text,
156
+ 'paymentDate' => @payment_date,
157
+ 'postDate' => @post_date,
158
+ 'paymentAmount' => @payment_amount,
159
+ 'unappliedAmount' => @unapplied_amount,
160
+ 'currencyCode' => @currency_code,
161
+ 'referenceCode' => @reference_code,
162
+ 'isVoided' => @is_voided,
163
+ 'inDispute' => @in_dispute,
164
+ 'currencyRate' => @currency_rate,
165
+ 'baseCurrencyPaymentAmount' => @base_currency_payment_amount,
166
+ 'baseCurrencyUnappliedAmount' => @base_currency_unapplied_amount,
167
+ 'bankAccountId' => @bank_account_id,
168
+ 'groupKey' => @group_key,
169
+ 'applications' => @applications,
170
+ }
171
+ end
172
+
173
+ ##
174
+ # @return [String] This object converted to a JSON string
175
+ def to_json(*options)
176
+ "[#{as_json(*options).to_json(*options)}]"
177
+ end
178
+ end
179
+ end
@@ -0,0 +1,54 @@
1
+ #
2
+ # Lockstep Platform SDK for Ruby
3
+ #
4
+ # (c) 2021-2023 Lockstep, Inc.
5
+ #
6
+ # For the full copyright and license information, please view the LICENSE
7
+ # file that was distributed with this source code.
8
+ #
9
+ # @author Lockstep Network <support@lockstep.io>
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
+ # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
+ #
13
+
14
+
15
+ require 'json'
16
+
17
+ module LockstepSdk
18
+
19
+ ##
20
+ # Lockstep.Shared.Models.Sync.ErpWriteSyncSubmitModel`1 represents a request to write back a collection
21
+ # of requests to the connected AppEnrollment.
22
+ class InsertPaymentRequestModelErpWriteSyncSubmitModel
23
+
24
+ ##
25
+ # Initialize the InsertPaymentRequestModelErpWriteSyncSubmitModel using the provided prototype
26
+ def initialize(params = {})
27
+ @app_enrollment_id = params.dig(:app_enrollment_id)
28
+ @requests = params.dig(:requests)
29
+ end
30
+
31
+ ##
32
+ # @return [Uuid] The connected App Enrollment id.
33
+ attr_accessor :app_enrollment_id
34
+
35
+ ##
36
+ # @return [InsertPaymentRequestModel] An array of requests to write back.
37
+ attr_accessor :requests
38
+
39
+ ##
40
+ # @return [object] This object as a JSON key-value structure
41
+ def as_json(options={})
42
+ {
43
+ 'appEnrollmentId' => @app_enrollment_id,
44
+ 'requests' => @requests,
45
+ }
46
+ end
47
+
48
+ ##
49
+ # @return [String] This object converted to a JSON string
50
+ def to_json(*options)
51
+ "[#{as_json(*options).to_json(*options)}]"
52
+ end
53
+ end
54
+ end
@@ -46,6 +46,9 @@ module LockstepSdk
46
46
  @modified = params.dig(:modified)
47
47
  @modified_user_id = params.dig(:modified_user_id)
48
48
  @app_enrollment_id = params.dig(:app_enrollment_id)
49
+ @erp_write_status = params.dig(:erp_write_status)
50
+ @erp_write_status_name = params.dig(:erp_write_status_name)
51
+ @source_modified_date = params.dig(:source_modified_date)
49
52
  @notes = params.dig(:notes)
50
53
  @attachments = params.dig(:attachments)
51
54
  end
@@ -142,6 +145,18 @@ module LockstepSdk
142
145
  # @return [Uuid] The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.
143
146
  attr_accessor :app_enrollment_id
144
147
 
148
+ ##
149
+ # @return [ErpWriteStatuses] Possible statuses for a record that supports ERP write.
150
+ attr_accessor :erp_write_status
151
+
152
+ ##
153
+ # @return [String] The name of the ErpWriteStatus for this Invoice
154
+ attr_accessor :erp_write_status_name
155
+
156
+ ##
157
+ # @return [Date-time] The date on which this record was last modified in source ERP.
158
+ attr_accessor :source_modified_date
159
+
145
160
  ##
146
161
  # @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 `InvoiceLine` and the `ObjectKey` set to the `InvoiceLineId` 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).
147
162
  attr_accessor :notes
@@ -177,6 +192,9 @@ module LockstepSdk
177
192
  'modified' => @modified,
178
193
  'modifiedUserId' => @modified_user_id,
179
194
  'appEnrollmentId' => @app_enrollment_id,
195
+ 'erpWriteStatus' => @erp_write_status,
196
+ 'erpWriteStatusName' => @erp_write_status_name,
197
+ 'sourceModifiedDate' => @source_modified_date,
180
198
  'notes' => @notes,
181
199
  'attachments' => @attachments,
182
200
  }
@@ -69,6 +69,9 @@ module LockstepSdk
69
69
  @base_currency_sales_tax_amount = params.dig(:base_currency_sales_tax_amount)
70
70
  @base_currency_discount_amount = params.dig(:base_currency_discount_amount)
71
71
  @base_currency_outstanding_balance_amount = params.dig(:base_currency_outstanding_balance_amount)
72
+ @erp_write_status = params.dig(:erp_write_status)
73
+ @erp_write_status_name = params.dig(:erp_write_status_name)
74
+ @source_modified_date = params.dig(:source_modified_date)
72
75
  @addresses = params.dig(:addresses)
73
76
  @lines = params.dig(:lines)
74
77
  @payments = params.dig(:payments)
@@ -246,6 +249,18 @@ module LockstepSdk
246
249
  # @return [Double] The remaining balance value of this invoice in the group's base currency.
247
250
  attr_accessor :base_currency_outstanding_balance_amount
248
251
 
252
+ ##
253
+ # @return [ErpWriteStatuses] Possible statuses for a record that supports ERP write.
254
+ attr_accessor :erp_write_status
255
+
256
+ ##
257
+ # @return [String] The name of the ErpWriteStatus for this Invoice
258
+ attr_accessor :erp_write_status_name
259
+
260
+ ##
261
+ # @return [Date-time] The date on which this record was last modified in source ERP.
262
+ attr_accessor :source_modified_date
263
+
249
264
  ##
250
265
  # @return [InvoiceAddressModel] All addresses connected to this invoice. To retrieve this collection, specify `Addresses` in the "Include" parameter for your query.
251
266
  attr_accessor :addresses
@@ -335,6 +350,9 @@ module LockstepSdk
335
350
  'baseCurrencySalesTaxAmount' => @base_currency_sales_tax_amount,
336
351
  'baseCurrencyDiscountAmount' => @base_currency_discount_amount,
337
352
  'baseCurrencyOutstandingBalanceAmount' => @base_currency_outstanding_balance_amount,
353
+ 'erpWriteStatus' => @erp_write_status,
354
+ 'erpWriteStatusName' => @erp_write_status_name,
355
+ 'sourceModifiedDate' => @source_modified_date,
338
356
  'addresses' => @addresses,
339
357
  'lines' => @lines,
340
358
  'payments' => @payments,
@@ -21,18 +21,14 @@ module LockstepSdk
21
21
  ##
22
22
  # Initialize the InvoiceSummaryModelInvoiceSummaryTotalsModelSummaryFetchResult using the provided prototype
23
23
  def initialize(params = {})
24
- @records = params.dig(:records)
25
24
  @total_count = params.dig(:total_count)
26
25
  @page_size = params.dig(:page_size)
27
26
  @page_number = params.dig(:page_number)
27
+ @records = params.dig(:records)
28
28
  @summary = params.dig(:summary)
29
29
  @aging_summary = params.dig(:aging_summary)
30
30
  end
31
31
 
32
- ##
33
- # @return [InvoiceSummaryModel]
34
- attr_accessor :records
35
-
36
32
  ##
37
33
  # @return [Int32]
38
34
  attr_accessor :total_count
@@ -45,6 +41,10 @@ module LockstepSdk
45
41
  # @return [Int32]
46
42
  attr_accessor :page_number
47
43
 
44
+ ##
45
+ # @return [InvoiceSummaryModel]
46
+ attr_accessor :records
47
+
48
48
  ##
49
49
  # @return [InvoiceSummaryTotalsModel] The totals for an Invoice Summary
50
50
  attr_accessor :summary
@@ -57,10 +57,10 @@ module LockstepSdk
57
57
  # @return [object] This object as a JSON key-value structure
58
58
  def as_json(options={})
59
59
  {
60
- 'records' => @records,
61
60
  'totalCount' => @total_count,
62
61
  'pageSize' => @page_size,
63
62
  'pageNumber' => @page_number,
63
+ 'records' => @records,
64
64
  'summary' => @summary,
65
65
  'agingSummary' => @aging_summary,
66
66
  }
@@ -44,6 +44,7 @@ module LockstepSdk
44
44
  @payment_amount = params.dig(:payment_amount)
45
45
  @unapplied_amount = params.dig(:unapplied_amount)
46
46
  @currency_code = params.dig(:currency_code)
47
+ @bank_account_id = params.dig(:bank_account_id)
47
48
  @reference_code = params.dig(:reference_code)
48
49
  @created = params.dig(:created)
49
50
  @created_user_id = params.dig(:created_user_id)
@@ -124,6 +125,10 @@ module LockstepSdk
124
125
  # @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).
125
126
  attr_accessor :currency_code
126
127
 
128
+ ##
129
+ # @return [String] The Bank account id for the company to which this payment belongs.
130
+ attr_accessor :bank_account_id
131
+
127
132
  ##
128
133
  # @return [String] Reference code for the payment for the given Erp system.
129
134
  attr_accessor :reference_code
@@ -215,6 +220,7 @@ module LockstepSdk
215
220
  'paymentAmount' => @payment_amount,
216
221
  'unappliedAmount' => @unapplied_amount,
217
222
  'currencyCode' => @currency_code,
223
+ 'bankAccountId' => @bank_account_id,
218
224
  'referenceCode' => @reference_code,
219
225
  'created' => @created,
220
226
  'createdUserId' => @created_user_id,
@@ -0,0 +1,77 @@
1
+ #
2
+ # Lockstep Platform SDK for Ruby
3
+ #
4
+ # (c) 2021-2023 Lockstep, Inc.
5
+ #
6
+ # For the full copyright and license information, please view the LICENSE
7
+ # file that was distributed with this source code.
8
+ #
9
+ # @author Lockstep Network <support@lockstep.io>
10
+ # @copyright 2021-2023 Lockstep, Inc.
11
+ # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
+ #
13
+
14
+
15
+ require 'json'
16
+
17
+ module LockstepSdk
18
+
19
+ ##
20
+ # Contains results of a write back request
21
+ class PaymentModelErpWriteResult
22
+
23
+ ##
24
+ # Initialize the PaymentModelErpWriteResult using the provided prototype
25
+ def initialize(params = {})
26
+ @app_enrollment_id = params.dig(:app_enrollment_id)
27
+ @erp_key = params.dig(:erp_key)
28
+ @group_key = params.dig(:group_key)
29
+ @message = params.dig(:message)
30
+ @sync_request_id = params.dig(:sync_request_id)
31
+ @results = params.dig(:results)
32
+ end
33
+
34
+ ##
35
+ # @return [Uuid] The id of the connected AppEnrollmentModel
36
+ attr_accessor :app_enrollment_id
37
+
38
+ ##
39
+ # @return [String] The ErpKey for the object written to the Erp if created
40
+ attr_accessor :erp_key
41
+
42
+ ##
43
+ # @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).
44
+ attr_accessor :group_key
45
+
46
+ ##
47
+ # @return [String] An optional message to return with the result
48
+ attr_accessor :message
49
+
50
+ ##
51
+ # @return [Uuid] The id of the SyncRequestModel the requests were added to
52
+ attr_accessor :sync_request_id
53
+
54
+ ##
55
+ # @return [PaymentModel] Results from the ERP write operation
56
+ attr_accessor :results
57
+
58
+ ##
59
+ # @return [object] This object as a JSON key-value structure
60
+ def as_json(options={})
61
+ {
62
+ 'appEnrollmentId' => @app_enrollment_id,
63
+ 'erpKey' => @erp_key,
64
+ 'groupKey' => @group_key,
65
+ 'message' => @message,
66
+ 'syncRequestId' => @sync_request_id,
67
+ 'results' => @results,
68
+ }
69
+ end
70
+
71
+ ##
72
+ # @return [String] This object converted to a JSON string
73
+ def to_json(*options)
74
+ "[#{as_json(*options).to_json(*options)}]"
75
+ end
76
+ end
77
+ end
@@ -21,18 +21,14 @@ module LockstepSdk
21
21
  ##
22
22
  # Initialize the PaymentSummaryModelPaymentSummaryTotalsModelSummaryFetchResult using the provided prototype
23
23
  def initialize(params = {})
24
- @records = params.dig(:records)
25
24
  @total_count = params.dig(:total_count)
26
25
  @page_size = params.dig(:page_size)
27
26
  @page_number = params.dig(:page_number)
27
+ @records = params.dig(:records)
28
28
  @summary = params.dig(:summary)
29
29
  @aging_summary = params.dig(:aging_summary)
30
30
  end
31
31
 
32
- ##
33
- # @return [PaymentSummaryModel]
34
- attr_accessor :records
35
-
36
32
  ##
37
33
  # @return [Int32]
38
34
  attr_accessor :total_count
@@ -45,6 +41,10 @@ module LockstepSdk
45
41
  # @return [Int32]
46
42
  attr_accessor :page_number
47
43
 
44
+ ##
45
+ # @return [PaymentSummaryModel]
46
+ attr_accessor :records
47
+
48
48
  ##
49
49
  # @return [PaymentSummaryTotalsModel] The totals for a Payment Summary
50
50
  attr_accessor :summary
@@ -57,10 +57,10 @@ module LockstepSdk
57
57
  # @return [object] This object as a JSON key-value structure
58
58
  def as_json(options={})
59
59
  {
60
- 'records' => @records,
61
60
  'totalCount' => @total_count,
62
61
  'pageSize' => @page_size,
63
62
  'pageNumber' => @page_number,
63
+ 'records' => @records,
64
64
  'summary' => @summary,
65
65
  'agingSummary' => @aging_summary,
66
66
  }
@@ -51,6 +51,7 @@ module LockstepSdk
51
51
  @currency_rate = params.dig(:currency_rate)
52
52
  @base_currency_payment_amount = params.dig(:base_currency_payment_amount)
53
53
  @base_currency_unapplied_amount = params.dig(:base_currency_unapplied_amount)
54
+ @bank_account_id = params.dig(:bank_account_id)
54
55
  end
55
56
 
56
57
  ##
@@ -133,6 +134,10 @@ module LockstepSdk
133
134
  # @return [Double] Unapplied balance of this payment in the erp's base currency. If this amount is nonzero, the field `IsOpen` will be true.
134
135
  attr_accessor :base_currency_unapplied_amount
135
136
 
137
+ ##
138
+ # @return [String] Bank account id for the payment.
139
+ attr_accessor :bank_account_id
140
+
136
141
  ##
137
142
  # @return [object] This object as a JSON key-value structure
138
143
  def as_json(options={})
@@ -157,6 +162,7 @@ module LockstepSdk
157
162
  'currencyRate' => @currency_rate,
158
163
  'baseCurrencyPaymentAmount' => @base_currency_payment_amount,
159
164
  'baseCurrencyUnappliedAmount' => @base_currency_unapplied_amount,
165
+ 'bankAccountId' => @bank_account_id,
160
166
  }
161
167
  end
162
168
 
@@ -56,6 +56,7 @@ module LockstepSdk
56
56
  @description = params.dig(:description)
57
57
  @b2_clast_logged_in = params.dig(:b2_clast_logged_in)
58
58
  @default_currency_code = params.dig(:default_currency_code)
59
+ @locale = params.dig(:locale)
59
60
  @notes = params.dig(:notes)
60
61
  @attachments = params.dig(:attachments)
61
62
  @custom_field_values = params.dig(:custom_field_values)
@@ -178,6 +179,10 @@ module LockstepSdk
178
179
  # @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
179
180
  attr_accessor :default_currency_code
180
181
 
182
+ ##
183
+ # @return [String] The IETF language tag for the user's preferred locale.
184
+ attr_accessor :locale
185
+
181
186
  ##
182
187
  # @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).
183
188
  attr_accessor :notes
@@ -227,6 +232,7 @@ module LockstepSdk
227
232
  'description' => @description,
228
233
  'b2CLastLoggedIn' => @b2_clast_logged_in,
229
234
  'defaultCurrencyCode' => @default_currency_code,
235
+ 'locale' => @locale,
230
236
  'notes' => @notes,
231
237
  'attachments' => @attachments,
232
238
  'customFieldValues' => @custom_field_values,
@@ -1,3 +1,3 @@
1
1
  module LockstepSdk
2
- VERSION = "2023.13.37.0"
2
+ VERSION = "2023.28.10.0"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: lockstep_sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 2023.13.37.0
4
+ version: 2023.28.10.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Lockstep
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-03-31 00:00:00.000000000 Z
11
+ date: 2023-07-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: awrence
@@ -48,6 +48,7 @@ files:
48
48
  - lib/lockstep_sdk/clients/feature_flags_client.rb
49
49
  - lib/lockstep_sdk/clients/financial_account_balance_history_client.rb
50
50
  - lib/lockstep_sdk/clients/financial_account_client.rb
51
+ - lib/lockstep_sdk/clients/financial_institution_accounts_client.rb
51
52
  - lib/lockstep_sdk/clients/financial_year_settings_client.rb
52
53
  - lib/lockstep_sdk/clients/group_accounts_client.rb
53
54
  - lib/lockstep_sdk/clients/invoice_addresses_client.rb
@@ -124,19 +125,22 @@ files:
124
125
  - lib/lockstep_sdk/models/email_reply_generator_response.rb
125
126
  - lib/lockstep_sdk/models/email_reply_generator_suggestions.rb
126
127
  - lib/lockstep_sdk/models/erp_model.rb
127
- - lib/lockstep_sdk/models/error_result.rb
128
128
  - lib/lockstep_sdk/models/feature_flags_request_model.rb
129
129
  - lib/lockstep_sdk/models/feature_flags_response_model.rb
130
130
  - lib/lockstep_sdk/models/financial_account_balance_history_model.rb
131
131
  - lib/lockstep_sdk/models/financial_account_balance_history_sync_model.rb
132
132
  - lib/lockstep_sdk/models/financial_account_model.rb
133
133
  - lib/lockstep_sdk/models/financial_account_sync_model.rb
134
+ - lib/lockstep_sdk/models/financial_institution_account_model.rb
134
135
  - lib/lockstep_sdk/models/financial_report_cell_model.rb
135
136
  - lib/lockstep_sdk/models/financial_report_model.rb
136
137
  - lib/lockstep_sdk/models/financial_report_row_model.rb
137
138
  - lib/lockstep_sdk/models/financial_year_setting_model.rb
138
139
  - lib/lockstep_sdk/models/financial_year_setting_sync_model.rb
139
140
  - lib/lockstep_sdk/models/group_account_model.rb
141
+ - lib/lockstep_sdk/models/insert_payment_applied_request_model.rb
142
+ - lib/lockstep_sdk/models/insert_payment_request_model.rb
143
+ - lib/lockstep_sdk/models/insert_payment_request_model_erp_write_sync_submit_model.rb
140
144
  - lib/lockstep_sdk/models/invite_data_model.rb
141
145
  - lib/lockstep_sdk/models/invite_model.rb
142
146
  - lib/lockstep_sdk/models/invite_submit_model.rb
@@ -162,6 +166,7 @@ files:
162
166
  - lib/lockstep_sdk/models/payment_detail_header_model.rb
163
167
  - lib/lockstep_sdk/models/payment_detail_model.rb
164
168
  - lib/lockstep_sdk/models/payment_model.rb
169
+ - lib/lockstep_sdk/models/payment_model_erp_write_result.rb
165
170
  - lib/lockstep_sdk/models/payment_summary_model.rb
166
171
  - lib/lockstep_sdk/models/payment_summary_model_payment_summary_totals_model_summary_fetch_result.rb
167
172
  - lib/lockstep_sdk/models/payment_summary_totals_model.rb
@@ -1,77 +0,0 @@
1
- #
2
- # Lockstep Platform SDK for Ruby
3
- #
4
- # (c) 2021-2023 Lockstep, Inc.
5
- #
6
- # For the full copyright and license information, please view the LICENSE
7
- # file that was distributed with this source code.
8
- #
9
- # @author Lockstep Network <support@lockstep.io>
10
- # @copyright 2021-2023 Lockstep, Inc.
11
- # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
12
- #
13
-
14
-
15
- require 'json'
16
-
17
- module LockstepSdk
18
-
19
- ##
20
- # Represents a failed API request.
21
- class ErrorResult
22
-
23
- ##
24
- # Initialize the ErrorResult using the provided prototype
25
- def initialize(params = {})
26
- @type = params.dig(:type)
27
- @title = params.dig(:title)
28
- @status = params.dig(:status)
29
- @detail = params.dig(:detail)
30
- @instance = params.dig(:instance)
31
- @content = params.dig(:content)
32
- end
33
-
34
- ##
35
- # @return [String] A description of the type of error that occurred.
36
- attr_accessor :type
37
-
38
- ##
39
- # @return [String] A short title describing the error.
40
- attr_accessor :title
41
-
42
- ##
43
- # @return [Int32] If an error code is applicable, this contains an error number.
44
- attr_accessor :status
45
-
46
- ##
47
- # @return [String] If detailed information about this error is available, this value contains more information.
48
- attr_accessor :detail
49
-
50
- ##
51
- # @return [String] If this error corresponds to a specific instance or object, this field indicates which one.
52
- attr_accessor :instance
53
-
54
- ##
55
- # @return [String] The full content of the HTTP response.
56
- attr_accessor :content
57
-
58
- ##
59
- # @return [object] This object as a JSON key-value structure
60
- def as_json(options={})
61
- {
62
- 'type' => @type,
63
- 'title' => @title,
64
- 'status' => @status,
65
- 'detail' => @detail,
66
- 'instance' => @instance,
67
- 'content' => @content,
68
- }
69
- end
70
-
71
- ##
72
- # @return [String] This object converted to a JSON string
73
- def to_json(*options)
74
- "[#{as_json(*options).to_json(*options)}]"
75
- end
76
- end
77
- end