lockstep_sdk 2022.6.49.0 → 2022.9.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/lockstep_sdk/clients/api_keys_client.rb +17 -5
- data/lib/lockstep_sdk/clients/applications_client.rb +9 -3
- data/lib/lockstep_sdk/clients/companies_client.rb +22 -6
- data/lib/lockstep_sdk/clients/contacts_client.rb +9 -3
- data/lib/lockstep_sdk/clients/credit_memo_applied_client.rb +6 -2
- data/lib/lockstep_sdk/clients/custom_field_definitions_client.rb +17 -5
- data/lib/lockstep_sdk/clients/custom_field_values_client.rb +17 -5
- data/lib/lockstep_sdk/clients/definitions_client.rb +9 -3
- data/lib/lockstep_sdk/clients/financial_account_balance_history_client.rb +92 -0
- data/lib/lockstep_sdk/clients/financial_account_client.rb +79 -0
- data/lib/lockstep_sdk/clients/financial_year_settings_client.rb +92 -0
- data/lib/lockstep_sdk/clients/invoices_client.rb +6 -2
- data/lib/lockstep_sdk/clients/notes_client.rb +9 -3
- data/lib/lockstep_sdk/clients/payment_applications_client.rb +6 -2
- data/lib/lockstep_sdk/clients/provisioning_client.rb +3 -0
- data/lib/lockstep_sdk/clients/webhooks_client.rb +14 -0
- data/lib/lockstep_sdk/lockstep_api.rb +18 -3
- data/lib/lockstep_sdk/models/activity_model.rb +5 -5
- data/lib/lockstep_sdk/models/activity_xref_model.rb +2 -0
- data/lib/lockstep_sdk/models/app_enrollment_model.rb +2 -2
- data/lib/lockstep_sdk/models/application_model.rb +4 -4
- data/lib/lockstep_sdk/models/attachment_model.rb +2 -2
- data/lib/lockstep_sdk/models/company_model.rb +5 -5
- data/lib/lockstep_sdk/models/company_sync_model.rb +6 -6
- data/lib/lockstep_sdk/models/contact_model.rb +6 -6
- data/lib/lockstep_sdk/models/contact_sync_model.rb +3 -3
- data/lib/lockstep_sdk/models/credit_memo_applied_model.rb +5 -5
- data/lib/lockstep_sdk/models/custom_field_definition_model.rb +1 -1
- data/lib/lockstep_sdk/models/custom_field_sync_model.rb +6 -0
- data/lib/lockstep_sdk/models/custom_field_value_model.rb +7 -1
- data/lib/lockstep_sdk/models/email_model.rb +5 -5
- data/lib/lockstep_sdk/models/financial_account_balance_history_model.rb +127 -0
- data/lib/lockstep_sdk/models/financial_account_model.rb +139 -0
- data/lib/lockstep_sdk/models/financial_year_setting_model.rb +111 -0
- data/lib/lockstep_sdk/models/invoice_address_model.rb +6 -0
- data/lib/lockstep_sdk/models/invoice_history_model.rb +6 -0
- data/lib/lockstep_sdk/models/invoice_line_model.rb +3 -3
- data/lib/lockstep_sdk/models/invoice_model.rb +9 -9
- data/lib/lockstep_sdk/models/invoice_sync_model.rb +2 -2
- data/lib/lockstep_sdk/models/note_model.rb +1 -1
- data/lib/lockstep_sdk/models/payment_applied_model.rb +1 -1
- data/lib/lockstep_sdk/models/payment_model.rb +5 -5
- data/lib/lockstep_sdk/models/sync_request_model.rb +1 -1
- data/lib/lockstep_sdk/models/user_account_model.rb +3 -3
- data/lib/lockstep_sdk/models/webhook_history_table_storage_model.rb +103 -0
- data/lib/lockstep_sdk/models/webhook_model.rb +6 -0
- data/lib/lockstep_sdk/version.rb +1 -1
- metadata +9 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5f7d28b1ef83c35d42627844f2d2fdde2a2667cf27f24cb8b3a84af1a851bfd6
|
|
4
|
+
data.tar.gz: b0218ec55ab0195e3a88e404b436a4b734338988d10ad17b25efd37bd3a5bbc5
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c6205052a2b83f67555b3baab91600fae9e10ac04bee0e4eb1e6bd2bef1889ef3cabeda19364d1c9f6a0f7125240c2201f4326ebf14024b7caf608453c9532af
|
|
7
|
+
data.tar.gz: 460ea5e18e294eba3a8c25a48488c413eb75773ae5043bdc23f1aa7c4080c32ba0dace6c5c2a22e35e762a576aaa15b834711d43a7f2a4ee20d82d957e5f4086
|
|
@@ -29,7 +29,9 @@ class ApiKeysClient
|
|
|
29
29
|
##
|
|
30
30
|
# Retrieves the API Key with this identifier.
|
|
31
31
|
#
|
|
32
|
-
# An API Key is an authentication token that you may use with the Lockstep API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the Lockstep API. When you create an API Key, make sure to save the value in a secure location. Lockstep cannot retrieve an API Key once it is created.
|
|
32
|
+
# An API Key is an authentication token that you may use with the Lockstep API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the Lockstep API. When you create an API Key, make sure to save the value in a secure location. Lockstep cannot retrieve an API Key once it is created.
|
|
33
|
+
#
|
|
34
|
+
# For more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).
|
|
33
35
|
#
|
|
34
36
|
# @param id [uuid] The unique ID number of the API Key to retrieve
|
|
35
37
|
# @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.
|
|
@@ -40,9 +42,13 @@ class ApiKeysClient
|
|
|
40
42
|
end
|
|
41
43
|
|
|
42
44
|
##
|
|
43
|
-
# Immediately revokes the API Key with the specified id so it cannot be used to call the API.
|
|
45
|
+
# Immediately revokes the API Key with the specified id so it cannot be used to call the API.
|
|
46
|
+
#
|
|
47
|
+
# The Lockstep Platform guarantees that revocation will be received by all servers within five minutes of revocation. API calls made using this API key after the revocation will fail. A revoked API Key cannot be un-revoked and may be removed 60 days after revocation.
|
|
48
|
+
#
|
|
49
|
+
# An API Key is an authentication token that you may use with the Lockstep API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the Lockstep API. When you create an API Key, make sure to save the value in a secure location. Lockstep cannot retrieve an API Key once it is created.
|
|
44
50
|
#
|
|
45
|
-
#
|
|
51
|
+
# For more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).
|
|
46
52
|
#
|
|
47
53
|
# @param id [uuid] The unique Lockstep Platform ID number of this API Key
|
|
48
54
|
def revoke_api_key(id:)
|
|
@@ -53,7 +59,9 @@ class ApiKeysClient
|
|
|
53
59
|
##
|
|
54
60
|
# Creates an API key with the specified name.
|
|
55
61
|
#
|
|
56
|
-
# An API Key is an authentication token that you may use with the Lockstep API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the Lockstep API. When you create an API Key, make sure to save the value in a secure location. Lockstep cannot retrieve an API Key once it is created.
|
|
62
|
+
# An API Key is an authentication token that you may use with the Lockstep API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the Lockstep API. When you create an API Key, make sure to save the value in a secure location. Lockstep cannot retrieve an API Key once it is created.
|
|
63
|
+
#
|
|
64
|
+
# For more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).
|
|
57
65
|
#
|
|
58
66
|
# @param body [ApiKeyModel] Metadata about the API Key to create.
|
|
59
67
|
def create_api_key(body:)
|
|
@@ -62,7 +70,11 @@ class ApiKeysClient
|
|
|
62
70
|
end
|
|
63
71
|
|
|
64
72
|
##
|
|
65
|
-
# Queries API Keys for this user using the specified filtering, sorting, nested fetch, and pagination rules requested.
|
|
73
|
+
# Queries API Keys for this user using the specified filtering, sorting, nested fetch, and pagination rules requested.
|
|
74
|
+
#
|
|
75
|
+
# An API Key is an authentication token that you may use with the Lockstep API. Because API Keys do not have an expiration date, they are well suited for unattended processes. Each API Key is associated with a user, and may be revoked to prevent it from accessing the Lockstep API. When you create an API Key, make sure to save the value in a secure location. Lockstep cannot retrieve an API Key once it is created.
|
|
76
|
+
#
|
|
77
|
+
# For more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).
|
|
66
78
|
#
|
|
67
79
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
68
80
|
# @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.
|
|
@@ -44,7 +44,9 @@ class ApplicationsClient
|
|
|
44
44
|
##
|
|
45
45
|
# Updates an existing Application with the information supplied to this PATCH call.
|
|
46
46
|
#
|
|
47
|
-
# The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. For example, you can provide the field name "IsActive" and specify the new value "False"; this API will then change the value of IsActive to false.
|
|
47
|
+
# The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. For example, you can provide the field name "IsActive" and specify the new value "False"; this API will then change the value of IsActive to false.
|
|
48
|
+
#
|
|
49
|
+
# An Application represents a feature available to customers within the Lockstep Platform. You can create Applications by working with your Lockstep business development manager and publish them on the platform so that customers can browse and find your Application on the Lockstep Platform Marketplace. When a customer adds an Application to their account, they obtain an AppEnrollment which represents that customer's instance of this Application. The customer-specific AppEnrollment contains a customer's configuration data for the Application, which is not customer-specific.
|
|
48
50
|
#
|
|
49
51
|
# See [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
|
|
50
52
|
#
|
|
@@ -56,7 +58,9 @@ class ApplicationsClient
|
|
|
56
58
|
end
|
|
57
59
|
|
|
58
60
|
##
|
|
59
|
-
# Deletes the Application referred to by this unique identifier. Information about this Application is retained but after the DELETE call, this Application is no longer available for use on the Lockstep Platform.
|
|
61
|
+
# Deletes the Application referred to by this unique identifier. Information about this Application is retained but after the DELETE call, this Application is no longer available for use on the Lockstep Platform.
|
|
62
|
+
#
|
|
63
|
+
# An Application represents a feature available to customers within the Lockstep Platform. You can create Applications by working with your Lockstep business development manager and publish them on the platform so that customers can browse and find your Application on the Lockstep Platform Marketplace. When a customer adds an Application to their account, they obtain an AppEnrollment which represents that customer's instance of this Application. The customer-specific AppEnrollment contains a customer's configuration data for the Application, which is not customer-specific.
|
|
60
64
|
#
|
|
61
65
|
# See [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
|
|
62
66
|
#
|
|
@@ -82,7 +86,9 @@ class ApplicationsClient
|
|
|
82
86
|
##
|
|
83
87
|
# Queries Applications on the Lockstep Platform using the specified filtering, sorting, nested fetch, and pagination rules requested.
|
|
84
88
|
#
|
|
85
|
-
# 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.
|
|
89
|
+
# 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.
|
|
90
|
+
#
|
|
91
|
+
# An Application represents a feature available to customers within the Lockstep Platform. You can create Applications by working with your Lockstep business development manager and publish them on the platform so that customers can browse and find your Application on the Lockstep Platform Marketplace. When a customer adds an Application to their account, they obtain an AppEnrollment which represents that customer's instance of this Application. The customer-specific AppEnrollment contains a customer's configuration data for the Application, which is not customer-specific.
|
|
86
92
|
#
|
|
87
93
|
# See [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
|
|
88
94
|
#
|
|
@@ -27,7 +27,9 @@ class CompaniesClient
|
|
|
27
27
|
|
|
28
28
|
|
|
29
29
|
##
|
|
30
|
-
# Retrieves the Company specified by this unique identifier, optionally including nested data sets.
|
|
30
|
+
# Retrieves the Company specified by this unique identifier, optionally including nested data sets.
|
|
31
|
+
#
|
|
32
|
+
# A Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.
|
|
31
33
|
#
|
|
32
34
|
# See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
|
|
33
35
|
#
|
|
@@ -42,7 +44,9 @@ class CompaniesClient
|
|
|
42
44
|
##
|
|
43
45
|
# Updates a Company that matches the specified id with the requested information.
|
|
44
46
|
#
|
|
45
|
-
# The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.
|
|
47
|
+
# The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.
|
|
48
|
+
#
|
|
49
|
+
# A Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.
|
|
46
50
|
#
|
|
47
51
|
# See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
|
|
48
52
|
#
|
|
@@ -67,7 +71,9 @@ class CompaniesClient
|
|
|
67
71
|
end
|
|
68
72
|
|
|
69
73
|
##
|
|
70
|
-
# Creates one or more Companies from a given model.
|
|
74
|
+
# Creates one or more Companies from a given model.
|
|
75
|
+
#
|
|
76
|
+
# A Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.
|
|
71
77
|
#
|
|
72
78
|
# See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
|
|
73
79
|
#
|
|
@@ -80,7 +86,9 @@ class CompaniesClient
|
|
|
80
86
|
##
|
|
81
87
|
# Queries Companies for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
|
|
82
88
|
#
|
|
83
|
-
# 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.
|
|
89
|
+
# 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.
|
|
90
|
+
#
|
|
91
|
+
# A Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.
|
|
84
92
|
#
|
|
85
93
|
# See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
|
|
86
94
|
#
|
|
@@ -98,7 +106,11 @@ class CompaniesClient
|
|
|
98
106
|
##
|
|
99
107
|
# Queries Customer Summaries for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
|
|
100
108
|
#
|
|
101
|
-
# 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.
|
|
109
|
+
# 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.
|
|
110
|
+
#
|
|
111
|
+
# The Customer Summary View represents a slightly different view of the data and includes some extra fields that might be useful. For more information, see the data format of the Customer Summary Model.
|
|
112
|
+
#
|
|
113
|
+
# See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
|
|
102
114
|
#
|
|
103
115
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
104
116
|
# @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
|
|
@@ -112,7 +124,11 @@ class CompaniesClient
|
|
|
112
124
|
end
|
|
113
125
|
|
|
114
126
|
##
|
|
115
|
-
# Retrieves the Customer Details specified by this unique identifier, optionally including nested data sets.
|
|
127
|
+
# Retrieves the Customer Details specified by this unique identifier, optionally including nested data sets.
|
|
128
|
+
#
|
|
129
|
+
# The Customer Detail View represents a slightly different view of the data and includes some extra fields that might be useful. For more information, see the data format of the Customer Detail Model.
|
|
130
|
+
#
|
|
131
|
+
# See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
|
|
116
132
|
#
|
|
117
133
|
# @param id [uuid] The unique Lockstep Platform ID number of this Company; NOT the customer's ERP key
|
|
118
134
|
def retrieve_customer_detail(id:)
|
|
@@ -27,7 +27,9 @@ class ContactsClient
|
|
|
27
27
|
|
|
28
28
|
|
|
29
29
|
##
|
|
30
|
-
# Retrieves the Contact specified by this unique identifier, optionally including nested data sets.
|
|
30
|
+
# Retrieves the Contact specified by this unique identifier, optionally including nested data sets.
|
|
31
|
+
#
|
|
32
|
+
# A Contact contains information about a person or role within a Company. You can use Contacts to track information about who is responsible for a specific project, who handles invoices, or information about which role at a particular customer or vendor you should speak with about invoices.
|
|
31
33
|
#
|
|
32
34
|
# @param id [uuid] The unique Lockstep Platform ID number of this Contact; NOT the customer's ERP key
|
|
33
35
|
# @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, Notes
|
|
@@ -40,7 +42,9 @@ class ContactsClient
|
|
|
40
42
|
##
|
|
41
43
|
# Updates a contact that matches the specified id with the requested information.
|
|
42
44
|
#
|
|
43
|
-
# The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.
|
|
45
|
+
# The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.
|
|
46
|
+
#
|
|
47
|
+
# A Contact contains information about a person or role within a Company. You can use Contacts to track information about who is responsible for a specific project, who handles invoices, or information about which role at a particular customer or vendor you should speak with about invoices.
|
|
44
48
|
#
|
|
45
49
|
# @param id [uuid] The unique Lockstep Platform ID number of the Contact to update; NOT the customer's ERP key
|
|
46
50
|
# @param body [object] A list of changes to apply to this Contact
|
|
@@ -74,7 +78,9 @@ class ContactsClient
|
|
|
74
78
|
##
|
|
75
79
|
# Queries Contacts for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
|
|
76
80
|
#
|
|
77
|
-
# 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.
|
|
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.
|
|
82
|
+
#
|
|
83
|
+
# A Contact contains information about a person or role within a Company. You can use Contacts to track information about who is responsible for a specific project, who handles invoices, or information about which role at a particular customer or vendor you should speak with about invoices.
|
|
78
84
|
#
|
|
79
85
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
80
86
|
# @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, Notes
|
|
@@ -42,7 +42,9 @@ class CreditMemoAppliedClient
|
|
|
42
42
|
##
|
|
43
43
|
# Updates an existing Credit memo Application with the information supplied to this PATCH call.
|
|
44
44
|
#
|
|
45
|
-
# The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.
|
|
45
|
+
# The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.
|
|
46
|
+
#
|
|
47
|
+
# Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Lockstep creates a Credit Memo Application record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid using this Credit.
|
|
46
48
|
#
|
|
47
49
|
# @param id [uuid] The unique Lockstep Platform ID number of the Credit Memo Application to update; NOT the customer's ERP key
|
|
48
50
|
# @param body [object] A list of changes to apply to this Credit Memo Application
|
|
@@ -76,7 +78,9 @@ class CreditMemoAppliedClient
|
|
|
76
78
|
##
|
|
77
79
|
# Queries Credit Memo Applications for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
|
|
78
80
|
#
|
|
79
|
-
# 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.
|
|
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.
|
|
82
|
+
#
|
|
83
|
+
# Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Lockstep creates a Credit Memo Application record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid using this Credit.
|
|
80
84
|
#
|
|
81
85
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
82
86
|
# @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, Notes
|
|
@@ -29,7 +29,9 @@ class CustomFieldDefinitionsClient
|
|
|
29
29
|
##
|
|
30
30
|
# Retrieves the Custom Field Definition specified by this unique identifier.
|
|
31
31
|
#
|
|
32
|
-
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
32
|
+
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
33
|
+
#
|
|
34
|
+
# See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
|
|
33
35
|
#
|
|
34
36
|
# @param id [uuid] The unique Lockstep Platform ID number of this Custom Field Definition
|
|
35
37
|
# @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No additional data collections are currently defined on this object, but may be supported in the future.
|
|
@@ -44,7 +46,9 @@ class CustomFieldDefinitionsClient
|
|
|
44
46
|
#
|
|
45
47
|
# The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.
|
|
46
48
|
#
|
|
47
|
-
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
49
|
+
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
50
|
+
#
|
|
51
|
+
# See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
|
|
48
52
|
#
|
|
49
53
|
# @param id [uuid] The unique Lockstep Platform ID number of the Custom Field Definition to update
|
|
50
54
|
# @param body [object] A list of changes to apply to this Custom Field Definition
|
|
@@ -56,7 +60,9 @@ class CustomFieldDefinitionsClient
|
|
|
56
60
|
##
|
|
57
61
|
# Deletes the Custom Field Definition referred to by this unique identifier.
|
|
58
62
|
#
|
|
59
|
-
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
63
|
+
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
64
|
+
#
|
|
65
|
+
# See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
|
|
60
66
|
#
|
|
61
67
|
# @param id [uuid] The unique Lockstep Platform ID number of the Custom Field Definition to delete
|
|
62
68
|
def delete_field_definition(id:)
|
|
@@ -65,7 +71,11 @@ class CustomFieldDefinitionsClient
|
|
|
65
71
|
end
|
|
66
72
|
|
|
67
73
|
##
|
|
68
|
-
# Creates one or more Custom Field Definitions and returns the records as created.
|
|
74
|
+
# Creates one or more Custom Field Definitions and returns the records as created.
|
|
75
|
+
#
|
|
76
|
+
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
77
|
+
#
|
|
78
|
+
# See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
|
|
69
79
|
#
|
|
70
80
|
# @param body [CustomFieldDefinitionModel] The Custom Field Definitions to create
|
|
71
81
|
def create_field_definitions(body:)
|
|
@@ -78,7 +88,9 @@ class CustomFieldDefinitionsClient
|
|
|
78
88
|
#
|
|
79
89
|
# 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.
|
|
80
90
|
#
|
|
81
|
-
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
91
|
+
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
92
|
+
#
|
|
93
|
+
# See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
|
|
82
94
|
#
|
|
83
95
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
84
96
|
# @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No additional data collections are currently defined on this object, but may be supported in the future.
|
|
@@ -29,7 +29,9 @@ class CustomFieldValuesClient
|
|
|
29
29
|
##
|
|
30
30
|
# Retrieves all Custom Field Definitions.
|
|
31
31
|
#
|
|
32
|
-
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
32
|
+
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
33
|
+
#
|
|
34
|
+
# See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
|
|
33
35
|
#
|
|
34
36
|
# @param definition_id [uuid] The unique Lockstep Platform ID number of the Custom Field Definition for the Custom Field Value to retrieve.
|
|
35
37
|
# @param record_key [uuid] The unique Lockstep Platform ID number of the Lockstep Platform object the Custom Field Value is attached to.
|
|
@@ -45,7 +47,9 @@ class CustomFieldValuesClient
|
|
|
45
47
|
#
|
|
46
48
|
# The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.
|
|
47
49
|
#
|
|
48
|
-
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
50
|
+
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
51
|
+
#
|
|
52
|
+
# See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
|
|
49
53
|
#
|
|
50
54
|
# @param definition_id [uuid] The unique Lockstep Platform ID number of the Custom Field Definition for the Custom Field Value to retrieve.
|
|
51
55
|
# @param record_key [uuid] The unique Lockstep Platform ID number of the Lockstep Platform object the Custom Field Value is attached to.
|
|
@@ -58,7 +62,9 @@ class CustomFieldValuesClient
|
|
|
58
62
|
##
|
|
59
63
|
# Deletes the Custom Field referred to by this unique identifier.
|
|
60
64
|
#
|
|
61
|
-
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
65
|
+
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
66
|
+
#
|
|
67
|
+
# See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
|
|
62
68
|
#
|
|
63
69
|
# @param definition_id [uuid] The unique Lockstep Platform ID number of the Custom Field Definition for the Custom Field Value to retrieve.
|
|
64
70
|
# @param record_key [uuid] The unique Lockstep Platform ID number of the Lockstep Platform object the Custom Field Value is attached to.
|
|
@@ -68,7 +74,11 @@ class CustomFieldValuesClient
|
|
|
68
74
|
end
|
|
69
75
|
|
|
70
76
|
##
|
|
71
|
-
# Creates one or more Custom Fields and returns the records as created.
|
|
77
|
+
# Creates one or more Custom Fields and returns the records as created.
|
|
78
|
+
#
|
|
79
|
+
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
80
|
+
#
|
|
81
|
+
# See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
|
|
72
82
|
#
|
|
73
83
|
# @param body [CustomFieldValueModel] The Custom Fields to create
|
|
74
84
|
def create_fields(body:)
|
|
@@ -81,7 +91,9 @@ class CustomFieldValuesClient
|
|
|
81
91
|
#
|
|
82
92
|
# 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.
|
|
83
93
|
#
|
|
84
|
-
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
94
|
+
# A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
|
|
95
|
+
#
|
|
96
|
+
# See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
|
|
85
97
|
#
|
|
86
98
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
87
99
|
# @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: CustomFieldDefinition
|
|
@@ -29,7 +29,9 @@ class DefinitionsClient
|
|
|
29
29
|
##
|
|
30
30
|
# Queries the ISO3166 List of Countries using the specified filtering, sorting, nested fetch, and pagination rules requested.
|
|
31
31
|
#
|
|
32
|
-
# 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.
|
|
32
|
+
# 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.
|
|
33
|
+
#
|
|
34
|
+
# 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
35
|
#
|
|
34
36
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
35
37
|
# @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.
|
|
@@ -63,7 +65,9 @@ class DefinitionsClient
|
|
|
63
65
|
##
|
|
64
66
|
# Queries the list of States in the United States using the specified filtering, sorting, nested fetch, and pagination rules requested.
|
|
65
67
|
#
|
|
66
|
-
# 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.
|
|
68
|
+
# 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.
|
|
69
|
+
#
|
|
70
|
+
# 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.
|
|
67
71
|
#
|
|
68
72
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
69
73
|
# @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.
|
|
@@ -79,7 +83,9 @@ class DefinitionsClient
|
|
|
79
83
|
##
|
|
80
84
|
# Queries a list of financial systems using the specified filtering, sorting, nested fetch, and pagination rules requested.
|
|
81
85
|
#
|
|
82
|
-
# 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.
|
|
86
|
+
# 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.
|
|
87
|
+
#
|
|
88
|
+
# 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.
|
|
83
89
|
#
|
|
84
90
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
85
91
|
# @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.
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
#
|
|
2
|
+
# Lockstep Software Development Kit for Ruby
|
|
3
|
+
#
|
|
4
|
+
# (c) 2021-2022 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 Ted Spence <tspence@lockstep.io>
|
|
10
|
+
# @author Manish Narayan B S <manish.n@lockstep.io>
|
|
11
|
+
# @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
|
12
|
+
# @copyright 2021-2022 Lockstep, Inc.
|
|
13
|
+
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
|
14
|
+
#
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
require 'awrence'
|
|
18
|
+
|
|
19
|
+
class FinancialAccountBalanceHistoryClient
|
|
20
|
+
|
|
21
|
+
##
|
|
22
|
+
# Initialize the FinancialAccountBalanceHistoryClient class with a lockstepsdk instance.
|
|
23
|
+
# @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
|
|
24
|
+
def initialize(lockstepsdk)
|
|
25
|
+
@lockstepsdk = lockstepsdk
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
##
|
|
30
|
+
# Retrieves the Financial Account Balance History specified by this unique identifier.
|
|
31
|
+
#
|
|
32
|
+
# A Financial Account Balance History records either the current or end of period balance for a corresponding financial account.
|
|
33
|
+
#
|
|
34
|
+
# @param id [uuid] The unique Lockstep Platform ID number of this Financial Account Balance History
|
|
35
|
+
def retrieve_financial_account_balance_history(id:)
|
|
36
|
+
path = "/api/v1/FinancialAccountBalanceHistory/#{id}"
|
|
37
|
+
@lockstepsdk.request(:get, path, nil, nil)
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
##
|
|
41
|
+
# Updates a Financial Account Balance History that matches the specified id with the requested information.
|
|
42
|
+
#
|
|
43
|
+
# The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.
|
|
44
|
+
#
|
|
45
|
+
# A Financial Account Balance History records either the current or end of period balance for a corresponding financial account.
|
|
46
|
+
#
|
|
47
|
+
# @param id [uuid] The unique Lockstep Platform ID number of the Financial Account Balance History to update
|
|
48
|
+
# @param body [object] A list of changes to apply to this Financial Account Balance History
|
|
49
|
+
def update_financial_account_balance_history(id:, body:)
|
|
50
|
+
path = "/api/v1/FinancialAccountBalanceHistory/#{id}"
|
|
51
|
+
@lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
##
|
|
55
|
+
# Delete the Financial Account Balance History referred to by this unique identifier.
|
|
56
|
+
#
|
|
57
|
+
# A Financial Account Balance History records either the current or end of period balance for a corresponding financial account.
|
|
58
|
+
#
|
|
59
|
+
# @param id [uuid] The unique Lockstep Platform ID number of the Financial Account Balance History to disable
|
|
60
|
+
def delete_financial_account_balance_history(id:)
|
|
61
|
+
path = "/api/v1/FinancialAccountBalanceHistory/#{id}"
|
|
62
|
+
@lockstepsdk.request(:delete, path, nil, nil)
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
##
|
|
66
|
+
# Creates a Financial Account Balance History from a given model.
|
|
67
|
+
#
|
|
68
|
+
# A Financial Account Balance History records either the current or end of period balance for a corresponding financial account.
|
|
69
|
+
#
|
|
70
|
+
# @param body [FinancialAccountBalanceHistoryModel] The Financial Account Balance Histories to create
|
|
71
|
+
def create_financial_account_balance_history(body:)
|
|
72
|
+
path = "/api/v1/FinancialAccountBalanceHistory"
|
|
73
|
+
@lockstepsdk.request(:post, path, body, nil)
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
##
|
|
77
|
+
# Queries Financial Account Balance History for this account using the specified filtering, sorting, and pagination rules requested.
|
|
78
|
+
#
|
|
79
|
+
# 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.
|
|
80
|
+
#
|
|
81
|
+
# A Financial Account Balance History records either the current or end of period balance for a corresponding financial account.
|
|
82
|
+
#
|
|
83
|
+
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
84
|
+
# @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
85
|
+
# @param page_size [int32] The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
86
|
+
# @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
87
|
+
def query_financial_account_balance_history(filter:, order:, page_size:, page_number:)
|
|
88
|
+
path = "/api/v1/FinancialAccountBalanceHistory/query"
|
|
89
|
+
params = {:filter => filter, :order => order, :pageSize => page_size, :pageNumber => page_number}
|
|
90
|
+
@lockstepsdk.request(:get, path, nil, params)
|
|
91
|
+
end
|
|
92
|
+
end
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
#
|
|
2
|
+
# Lockstep Software Development Kit for Ruby
|
|
3
|
+
#
|
|
4
|
+
# (c) 2021-2022 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 Ted Spence <tspence@lockstep.io>
|
|
10
|
+
# @author Manish Narayan B S <manish.n@lockstep.io>
|
|
11
|
+
# @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
|
12
|
+
# @copyright 2021-2022 Lockstep, Inc.
|
|
13
|
+
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
|
14
|
+
#
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
require 'awrence'
|
|
18
|
+
|
|
19
|
+
class FinancialAccountClient
|
|
20
|
+
|
|
21
|
+
##
|
|
22
|
+
# Initialize the FinancialAccountClient class with a lockstepsdk instance.
|
|
23
|
+
# @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
|
|
24
|
+
def initialize(lockstepsdk)
|
|
25
|
+
@lockstepsdk = lockstepsdk
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
##
|
|
30
|
+
# Creates a financial account with the specified name.
|
|
31
|
+
#
|
|
32
|
+
# @param body [FinancialAccountModel] Metadata about the financial account to create.
|
|
33
|
+
def create_financial_account(body:)
|
|
34
|
+
path = "/api/v1/FinancialAccount"
|
|
35
|
+
@lockstepsdk.request(:post, path, body, nil)
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
##
|
|
39
|
+
# Retrieves the financial account specified by this unique identifier.
|
|
40
|
+
#
|
|
41
|
+
# @param id [uuid] The unique Lockstep Platform ID number of this Account; NOT the customer's ERP key
|
|
42
|
+
def retrieve_financial_account(id:)
|
|
43
|
+
path = "/api/v1/FinancialAccount/#{id}"
|
|
44
|
+
@lockstepsdk.request(:get, path, nil, nil)
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
##
|
|
48
|
+
#
|
|
49
|
+
#
|
|
50
|
+
# @param id [uuid] The unique Lockstep Platform ID number of the Account to update; NOT the customer's ERP key
|
|
51
|
+
# @param body [object] A list of changes to apply to this Account
|
|
52
|
+
def update_financial_account(id:, body:)
|
|
53
|
+
path = "/api/v1/FinancialAccount/#{id}"
|
|
54
|
+
@lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
##
|
|
58
|
+
# Deletes the Financial Account referred to by this unique identifier.
|
|
59
|
+
#
|
|
60
|
+
# @param id [uuid] The unique Lockstep Platform ID number of the Financial Account to disable; NOT the customer's ERP key
|
|
61
|
+
def deletes_financial_account(id:)
|
|
62
|
+
path = "/api/v1/FinancialAccount/#{id}"
|
|
63
|
+
@lockstepsdk.request(:delete, path, nil, nil)
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
##
|
|
67
|
+
#
|
|
68
|
+
#
|
|
69
|
+
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
70
|
+
# @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve.
|
|
71
|
+
# @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
72
|
+
# @param page_size [int32] The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
73
|
+
# @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
|
74
|
+
def query_financial_accounts(filter:, include_param:, order:, page_size:, page_number:)
|
|
75
|
+
path = "/api/v1/FinancialAccount/query"
|
|
76
|
+
params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
|
|
77
|
+
@lockstepsdk.request(:get, path, nil, params)
|
|
78
|
+
end
|
|
79
|
+
end
|