lockstep_sdk 2023.11.28.0 → 2023.17.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/lockstep_sdk/clients/invoices_client.rb +1 -1
- data/lib/lockstep_sdk/clients/payments_client.rb +1 -1
- data/lib/lockstep_sdk/clients/transcriptions_client.rb +11 -0
- data/lib/lockstep_sdk/lockstep_api.rb +3 -3
- data/lib/lockstep_sdk/models/cashflow_report_model.rb +8 -2
- data/lib/lockstep_sdk/models/company_sync_model.rb +1 -1
- data/lib/lockstep_sdk/models/credit_memo_applied_model.rb +18 -0
- data/lib/lockstep_sdk/models/email_reply_generator_request.rb +59 -0
- data/lib/lockstep_sdk/models/email_reply_generator_response.rb +53 -0
- data/lib/lockstep_sdk/models/email_reply_generator_suggestions.rb +53 -0
- data/lib/lockstep_sdk/models/financial_account_balance_history_model.rb +12 -0
- data/lib/lockstep_sdk/models/financial_account_balance_history_sync_model.rb +7 -1
- data/lib/lockstep_sdk/models/invoice_line_model.rb +18 -0
- data/lib/lockstep_sdk/models/invoice_model.rb +18 -0
- data/lib/lockstep_sdk/models/payment_applied_model.rb +18 -0
- data/lib/lockstep_sdk/models/payment_detail_model.rb +12 -0
- data/lib/lockstep_sdk/models/payment_model.rb +18 -0
- data/lib/lockstep_sdk/models/payment_summary_model_payment_summary_totals_model_summary_fetch_result.rb +6 -6
- data/lib/lockstep_sdk/models/sync_entity_result_model.rb +6 -0
- data/lib/lockstep_sdk/version.rb +1 -1
- metadata +5 -3
- 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:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e57962a47787588b19a99264be9b2ef7601dd8cf52a6f78c704a06c7f8c8355a
|
4
|
+
data.tar.gz: 336f18be792f9724a82227839a68c06ebb2d6d4487d63672ca3f0ae3f0d56346
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e86e45271e0b3b2a71655232f64595b20a7c4e0442e27b0d4d7bb8ac5974bdbb709279b751811e1d8c393080cd0a77e05c5bc541bc54518b70a5e5bdbaa9a1cc
|
7
|
+
data.tar.gz: a31ff3a91b040e7a18cd6bc93e31dad6d515a6c0bb94b81ac6ed36978bcf2191a8138517896d14aa3303739ecdec806a5f599991d6835aa94a395157c760d514
|
@@ -105,7 +105,7 @@ class InvoicesClient
|
|
105
105
|
#
|
106
106
|
# Sage Intacct supports AR Invoices.
|
107
107
|
#
|
108
|
-
#
|
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
|
#
|
@@ -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
|
-
#
|
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:)
|
@@ -151,4 +151,15 @@ class TranscriptionsClient
|
|
151
151
|
params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
|
152
152
|
@connection.request(:get, path, nil, params)
|
153
153
|
end
|
154
|
+
|
155
|
+
##
|
156
|
+
# Retrieves the Email Reply Generator Response containing a list of email reply suggestions
|
157
|
+
#
|
158
|
+
# An Email Reply Generator Request represents an email to be sent for a list of email reply suggestions.
|
159
|
+
#
|
160
|
+
# @param body [EmailReplyGeneratorRequest] The Email Reply Generator Request to be sent
|
161
|
+
def retrieve_an_emailreplygeneratorresponse(body:)
|
162
|
+
path = "/api/v1/Transcriptions/email-reply-suggestions"
|
163
|
+
@connection.request(:post, path, body, nil)
|
164
|
+
end
|
154
165
|
end
|
@@ -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.
|
12
|
+
# @version 2023.17.21
|
13
13
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
14
14
|
#
|
15
15
|
|
@@ -194,7 +194,7 @@ module lockstep_sdk
|
|
194
194
|
#
|
195
195
|
# @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
|
196
196
|
def initialize(env)
|
197
|
-
@version = "2023.
|
197
|
+
@version = "2023.17.21.0"
|
198
198
|
@env = case env
|
199
199
|
when "sbx"
|
200
200
|
"https://api.sbx.lockstep.io/"
|
@@ -307,7 +307,7 @@ module lockstep_sdk
|
|
307
307
|
request["Accept"] = 'application/json'
|
308
308
|
request["Content-Type"] = 'application/*+json'
|
309
309
|
request["SdkType"] = 'Ruby'
|
310
|
-
request["SdkVersion"] = '2023.
|
310
|
+
request["SdkVersion"] = '2023.17.21.0'
|
311
311
|
request["MachineName"] = Socket.gethostname
|
312
312
|
request.body = body
|
313
313
|
|
@@ -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 [
|
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
|
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
|
##
|
@@ -32,6 +32,8 @@ module LockstepSdk
|
|
32
32
|
@invoice_id = params.dig(:invoice_id)
|
33
33
|
@credit_memo_invoice_id = params.dig(:credit_memo_invoice_id)
|
34
34
|
@erp_key = params.dig(:erp_key)
|
35
|
+
@erp_write_status = params.dig(:erp_write_status)
|
36
|
+
@erp_write_status_name = params.dig(:erp_write_status_name)
|
35
37
|
@entry_number = params.dig(:entry_number)
|
36
38
|
@apply_to_invoice_date = params.dig(:apply_to_invoice_date)
|
37
39
|
@credit_memo_applied_amount = params.dig(:credit_memo_applied_amount)
|
@@ -40,6 +42,7 @@ module LockstepSdk
|
|
40
42
|
@modified = params.dig(:modified)
|
41
43
|
@modified_user_id = params.dig(:modified_user_id)
|
42
44
|
@app_enrollment_id = params.dig(:app_enrollment_id)
|
45
|
+
@source_modified_date = params.dig(:source_modified_date)
|
43
46
|
@attachments = params.dig(:attachments)
|
44
47
|
@notes = params.dig(:notes)
|
45
48
|
@custom_field_definitions = params.dig(:custom_field_definitions)
|
@@ -68,6 +71,14 @@ module LockstepSdk
|
|
68
71
|
# @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).
|
69
72
|
attr_accessor :erp_key
|
70
73
|
|
74
|
+
##
|
75
|
+
# @return [ErpWriteStatuses] Possible statuses for a record that supports ERP write.
|
76
|
+
attr_accessor :erp_write_status
|
77
|
+
|
78
|
+
##
|
79
|
+
# @return [String] The name of the ErpWriteStatus for this credit memo application
|
80
|
+
attr_accessor :erp_write_status_name
|
81
|
+
|
71
82
|
##
|
72
83
|
# @return [Int32] Reference number for the applied credit memo.
|
73
84
|
attr_accessor :entry_number
|
@@ -100,6 +111,10 @@ module LockstepSdk
|
|
100
111
|
# @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.
|
101
112
|
attr_accessor :app_enrollment_id
|
102
113
|
|
114
|
+
##
|
115
|
+
# @return [Date-time] The date on which this record was last modified in source ERP.
|
116
|
+
attr_accessor :source_modified_date
|
117
|
+
|
103
118
|
##
|
104
119
|
# @return [AttachmentModel] A collection of attachments linked to this record. To retrieve this collection, specify `Attachments` in the `include` parameter when retrieving data. To create an attachment, use the [Upload Attachment](https://developer.lockstep.io/reference/post_api-v1-attachments) endpoint with the `TableKey` to `CreditMemoApplied` and the `ObjectKey` set to the `CreditMemoAppliedId` 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).
|
105
120
|
attr_accessor :attachments
|
@@ -133,6 +148,8 @@ module LockstepSdk
|
|
133
148
|
'invoiceId' => @invoice_id,
|
134
149
|
'creditMemoInvoiceId' => @credit_memo_invoice_id,
|
135
150
|
'erpKey' => @erp_key,
|
151
|
+
'erpWriteStatus' => @erp_write_status,
|
152
|
+
'erpWriteStatusName' => @erp_write_status_name,
|
136
153
|
'entryNumber' => @entry_number,
|
137
154
|
'applyToInvoiceDate' => @apply_to_invoice_date,
|
138
155
|
'creditMemoAppliedAmount' => @credit_memo_applied_amount,
|
@@ -141,6 +158,7 @@ module LockstepSdk
|
|
141
158
|
'modified' => @modified,
|
142
159
|
'modifiedUserId' => @modified_user_id,
|
143
160
|
'appEnrollmentId' => @app_enrollment_id,
|
161
|
+
'sourceModifiedDate' => @source_modified_date,
|
144
162
|
'attachments' => @attachments,
|
145
163
|
'notes' => @notes,
|
146
164
|
'customFieldDefinitions' => @custom_field_definitions,
|
@@ -0,0 +1,59 @@
|
|
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 the request to the SAGE GMS API
|
21
|
+
class EmailReplyGeneratorRequest
|
22
|
+
|
23
|
+
##
|
24
|
+
# Initialize the EmailReplyGeneratorRequest using the provided prototype
|
25
|
+
def initialize(params = {})
|
26
|
+
@date = params.dig(:date)
|
27
|
+
@body = params.dig(:body)
|
28
|
+
@subject = params.dig(:subject)
|
29
|
+
end
|
30
|
+
|
31
|
+
##
|
32
|
+
# @return [Date-time] The date associated with the email
|
33
|
+
attr_accessor :date
|
34
|
+
|
35
|
+
##
|
36
|
+
# @return [String] The body associated with the email
|
37
|
+
attr_accessor :body
|
38
|
+
|
39
|
+
##
|
40
|
+
# @return [String] The subject associated with the email
|
41
|
+
attr_accessor :subject
|
42
|
+
|
43
|
+
##
|
44
|
+
# @return [object] This object as a JSON key-value structure
|
45
|
+
def as_json(options={})
|
46
|
+
{
|
47
|
+
'date' => @date,
|
48
|
+
'body' => @body,
|
49
|
+
'subject' => @subject,
|
50
|
+
}
|
51
|
+
end
|
52
|
+
|
53
|
+
##
|
54
|
+
# @return [String] This object converted to a JSON string
|
55
|
+
def to_json(*options)
|
56
|
+
"[#{as_json(*options).to_json(*options)}]"
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
@@ -0,0 +1,53 @@
|
|
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 the response from SAGE GMS API
|
21
|
+
class EmailReplyGeneratorResponse
|
22
|
+
|
23
|
+
##
|
24
|
+
# Initialize the EmailReplyGeneratorResponse using the provided prototype
|
25
|
+
def initialize(params = {})
|
26
|
+
@message_id = params.dig(:message_id)
|
27
|
+
@suggestions = params.dig(:suggestions)
|
28
|
+
end
|
29
|
+
|
30
|
+
##
|
31
|
+
# @return [Uuid] The id for this request in the GMS system
|
32
|
+
attr_accessor :message_id
|
33
|
+
|
34
|
+
##
|
35
|
+
# @return [EmailReplyGeneratorSuggestions] A list of suggested email reply responses
|
36
|
+
attr_accessor :suggestions
|
37
|
+
|
38
|
+
##
|
39
|
+
# @return [object] This object as a JSON key-value structure
|
40
|
+
def as_json(options={})
|
41
|
+
{
|
42
|
+
'message_id' => @message_id,
|
43
|
+
'suggestions' => @suggestions,
|
44
|
+
}
|
45
|
+
end
|
46
|
+
|
47
|
+
##
|
48
|
+
# @return [String] This object converted to a JSON string
|
49
|
+
def to_json(*options)
|
50
|
+
"[#{as_json(*options).to_json(*options)}]"
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|
@@ -0,0 +1,53 @@
|
|
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 the email reply suggestion from the SAGE GMS API
|
21
|
+
class EmailReplyGeneratorSuggestions
|
22
|
+
|
23
|
+
##
|
24
|
+
# Initialize the EmailReplyGeneratorSuggestions using the provided prototype
|
25
|
+
def initialize(params = {})
|
26
|
+
@kind = params.dig(:kind)
|
27
|
+
@body = params.dig(:body)
|
28
|
+
end
|
29
|
+
|
30
|
+
##
|
31
|
+
# @return [String] The kind of reply generated by the GMS Api
|
32
|
+
attr_accessor :kind
|
33
|
+
|
34
|
+
##
|
35
|
+
# @return [String] The body of the reply generated by the GMS Api
|
36
|
+
attr_accessor :body
|
37
|
+
|
38
|
+
##
|
39
|
+
# @return [object] This object as a JSON key-value structure
|
40
|
+
def as_json(options={})
|
41
|
+
{
|
42
|
+
'kind' => @kind,
|
43
|
+
'body' => @body,
|
44
|
+
}
|
45
|
+
end
|
46
|
+
|
47
|
+
##
|
48
|
+
# @return [String] This object converted to a JSON string
|
49
|
+
def to_json(*options)
|
50
|
+
"[#{as_json(*options).to_json(*options)}]"
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|
@@ -33,6 +33,8 @@ module LockstepSdk
|
|
33
33
|
@period_end_date = params.dig(:period_end_date)
|
34
34
|
@status = params.dig(:status)
|
35
35
|
@balance = params.dig(:balance)
|
36
|
+
@balance_type = params.dig(:balance_type)
|
37
|
+
@balance_type_name = params.dig(:balance_type_name)
|
36
38
|
@created = params.dig(:created)
|
37
39
|
@created_user_id = params.dig(:created_user_id)
|
38
40
|
@modified = params.dig(:modified)
|
@@ -79,6 +81,14 @@ module LockstepSdk
|
|
79
81
|
# @return [Double] The current or end balance of this period.
|
80
82
|
attr_accessor :balance
|
81
83
|
|
84
|
+
##
|
85
|
+
# @return [FinancialAccountBalanceType] Financial Account Balance Types
|
86
|
+
attr_accessor :balance_type
|
87
|
+
|
88
|
+
##
|
89
|
+
# @return [String] The name of the BalanceType for this record.
|
90
|
+
attr_accessor :balance_type_name
|
91
|
+
|
82
92
|
##
|
83
93
|
# @return [Date-time] The date on which this financial account balance history record was created.
|
84
94
|
attr_accessor :created
|
@@ -109,6 +119,8 @@ module LockstepSdk
|
|
109
119
|
'periodEndDate' => @period_end_date,
|
110
120
|
'status' => @status,
|
111
121
|
'balance' => @balance,
|
122
|
+
'balanceType' => @balance_type,
|
123
|
+
'balanceTypeName' => @balance_type_name,
|
112
124
|
'created' => @created,
|
113
125
|
'createdUserId' => @created_user_id,
|
114
126
|
'modified' => @modified,
|
@@ -42,6 +42,7 @@ module LockstepSdk
|
|
42
42
|
@period_end_date = params.dig(:period_end_date)
|
43
43
|
@status = params.dig(:status)
|
44
44
|
@balance = params.dig(:balance)
|
45
|
+
@balance_type = params.dig(:balance_type)
|
45
46
|
end
|
46
47
|
|
47
48
|
##
|
@@ -49,7 +50,7 @@ module LockstepSdk
|
|
49
50
|
attr_accessor :financial_account_code
|
50
51
|
|
51
52
|
##
|
52
|
-
# @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
|
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
54
|
attr_accessor :financial_account_erp_key
|
54
55
|
|
55
56
|
##
|
@@ -76,6 +77,10 @@ module LockstepSdk
|
|
76
77
|
# @return [Double] The current or end balance of this period.
|
77
78
|
attr_accessor :balance
|
78
79
|
|
80
|
+
##
|
81
|
+
# @return [FinancialAccountBalanceType] The balance type of this period. If left null, the balance type will be determined by the balance.
|
82
|
+
attr_accessor :balance_type
|
83
|
+
|
79
84
|
##
|
80
85
|
# @return [object] This object as a JSON key-value structure
|
81
86
|
def as_json(options={})
|
@@ -88,6 +93,7 @@ module LockstepSdk
|
|
88
93
|
'periodEndDate' => @period_end_date,
|
89
94
|
'status' => @status,
|
90
95
|
'balance' => @balance,
|
96
|
+
'balanceType' => @balance_type,
|
91
97
|
}
|
92
98
|
end
|
93
99
|
|
@@ -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,
|
@@ -31,6 +31,8 @@ module LockstepSdk
|
|
31
31
|
@invoice_id = params.dig(:invoice_id)
|
32
32
|
@payment_id = params.dig(:payment_id)
|
33
33
|
@erp_key = params.dig(:erp_key)
|
34
|
+
@erp_write_status = params.dig(:erp_write_status)
|
35
|
+
@erp_write_status_name = params.dig(:erp_write_status_name)
|
34
36
|
@entry_number = params.dig(:entry_number)
|
35
37
|
@apply_to_invoice_date = params.dig(:apply_to_invoice_date)
|
36
38
|
@payment_applied_amount = params.dig(:payment_applied_amount)
|
@@ -39,6 +41,7 @@ module LockstepSdk
|
|
39
41
|
@modified = params.dig(:modified)
|
40
42
|
@modified_user_id = params.dig(:modified_user_id)
|
41
43
|
@app_enrollment_id = params.dig(:app_enrollment_id)
|
44
|
+
@source_modified_date = params.dig(:source_modified_date)
|
42
45
|
@payment = params.dig(:payment)
|
43
46
|
@invoice = params.dig(:invoice)
|
44
47
|
end
|
@@ -63,6 +66,14 @@ module LockstepSdk
|
|
63
66
|
# @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).
|
64
67
|
attr_accessor :erp_key
|
65
68
|
|
69
|
+
##
|
70
|
+
# @return [ErpWriteStatuses] Possible statuses for a record that supports ERP write.
|
71
|
+
attr_accessor :erp_write_status
|
72
|
+
|
73
|
+
##
|
74
|
+
# @return [String] The name of the ErpWriteStatus for this payment application
|
75
|
+
attr_accessor :erp_write_status_name
|
76
|
+
|
66
77
|
##
|
67
78
|
# @return [Int32] The entry number of this payment application. This is often a journal entry number, confirmation code, or other identifying field for this payment application.
|
68
79
|
attr_accessor :entry_number
|
@@ -95,6 +106,10 @@ module LockstepSdk
|
|
95
106
|
# @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.
|
96
107
|
attr_accessor :app_enrollment_id
|
97
108
|
|
109
|
+
##
|
110
|
+
# @return [Date-time] The date on which this record was last modified in source ERP.
|
111
|
+
attr_accessor :source_modified_date
|
112
|
+
|
98
113
|
##
|
99
114
|
# @return [PaymentModel] The payment associated with this applied payment
|
100
115
|
attr_accessor :payment
|
@@ -112,6 +127,8 @@ module LockstepSdk
|
|
112
127
|
'invoiceId' => @invoice_id,
|
113
128
|
'paymentId' => @payment_id,
|
114
129
|
'erpKey' => @erp_key,
|
130
|
+
'erpWriteStatus' => @erp_write_status,
|
131
|
+
'erpWriteStatusName' => @erp_write_status_name,
|
115
132
|
'entryNumber' => @entry_number,
|
116
133
|
'applyToInvoiceDate' => @apply_to_invoice_date,
|
117
134
|
'paymentAppliedAmount' => @payment_applied_amount,
|
@@ -120,6 +137,7 @@ module LockstepSdk
|
|
120
137
|
'modified' => @modified,
|
121
138
|
'modifiedUserId' => @modified_user_id,
|
122
139
|
'appEnrollmentId' => @app_enrollment_id,
|
140
|
+
'sourceModifiedDate' => @source_modified_date,
|
123
141
|
'payment' => @payment,
|
124
142
|
'invoice' => @invoice,
|
125
143
|
}
|
@@ -31,6 +31,8 @@ module LockstepSdk
|
|
31
31
|
@reference_code = params.dig(:reference_code)
|
32
32
|
@primary_contact = params.dig(:primary_contact)
|
33
33
|
@email = params.dig(:email)
|
34
|
+
@erp_write_status = params.dig(:erp_write_status)
|
35
|
+
@erp_write_status_name = params.dig(:erp_write_status_name)
|
34
36
|
@currency_code = params.dig(:currency_code)
|
35
37
|
@payment_amount = params.dig(:payment_amount)
|
36
38
|
@unapplied_amount = params.dig(:unapplied_amount)
|
@@ -84,6 +86,14 @@ module LockstepSdk
|
|
84
86
|
# @return [String] The Email address of the Customer.
|
85
87
|
attr_accessor :email
|
86
88
|
|
89
|
+
##
|
90
|
+
# @return [ErpWriteStatuses] Possible statuses for a record that supports ERP write.
|
91
|
+
attr_accessor :erp_write_status
|
92
|
+
|
93
|
+
##
|
94
|
+
# @return [String] The name of the ErpWriteStatus for this payment
|
95
|
+
attr_accessor :erp_write_status_name
|
96
|
+
|
87
97
|
##
|
88
98
|
# @return [String] The currency code of the payment.
|
89
99
|
attr_accessor :currency_code
|
@@ -172,6 +182,8 @@ module LockstepSdk
|
|
172
182
|
'referenceCode' => @reference_code,
|
173
183
|
'primaryContact' => @primary_contact,
|
174
184
|
'email' => @email,
|
185
|
+
'erpWriteStatus' => @erp_write_status,
|
186
|
+
'erpWriteStatusName' => @erp_write_status_name,
|
175
187
|
'currencyCode' => @currency_code,
|
176
188
|
'paymentAmount' => @payment_amount,
|
177
189
|
'unappliedAmount' => @unapplied_amount,
|
@@ -33,6 +33,8 @@ module LockstepSdk
|
|
33
33
|
@payment_id = params.dig(:payment_id)
|
34
34
|
@company_id = params.dig(:company_id)
|
35
35
|
@erp_key = params.dig(:erp_key)
|
36
|
+
@erp_write_status = params.dig(:erp_write_status)
|
37
|
+
@erp_write_status_name = params.dig(:erp_write_status_name)
|
36
38
|
@payment_type = params.dig(:payment_type)
|
37
39
|
@tender_type = params.dig(:tender_type)
|
38
40
|
@is_open = params.dig(:is_open)
|
@@ -54,6 +56,7 @@ module LockstepSdk
|
|
54
56
|
@base_currency_payment_amount = params.dig(:base_currency_payment_amount)
|
55
57
|
@base_currency_unapplied_amount = params.dig(:base_currency_unapplied_amount)
|
56
58
|
@service_fabric_status = params.dig(:service_fabric_status)
|
59
|
+
@source_modified_date = params.dig(:source_modified_date)
|
57
60
|
@applications = params.dig(:applications)
|
58
61
|
@notes = params.dig(:notes)
|
59
62
|
@attachments = params.dig(:attachments)
|
@@ -77,6 +80,14 @@ module LockstepSdk
|
|
77
80
|
# @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).
|
78
81
|
attr_accessor :erp_key
|
79
82
|
|
83
|
+
##
|
84
|
+
# @return [ErpWriteStatuses] Possible statuses for a record that supports ERP write.
|
85
|
+
attr_accessor :erp_write_status
|
86
|
+
|
87
|
+
##
|
88
|
+
# @return [String] The name of the ErpWriteStatus for this Payment
|
89
|
+
attr_accessor :erp_write_status_name
|
90
|
+
|
80
91
|
##
|
81
92
|
# @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
|
82
93
|
attr_accessor :payment_type
|
@@ -161,6 +172,10 @@ module LockstepSdk
|
|
161
172
|
# @return [String] The status of this payment within Service Fabric. "UNAUTHORISED" "PENDING" "PAID" "PAID_OFFLINE" "FAILED" "CANCELLED" "REJECTED" "REFUNDED" "PARTIALLY" "PARTIALLY_REFUNDED"
|
162
173
|
attr_accessor :service_fabric_status
|
163
174
|
|
175
|
+
##
|
176
|
+
# @return [Date-time] The date on which this record was last modified in source ERP.
|
177
|
+
attr_accessor :source_modified_date
|
178
|
+
|
164
179
|
##
|
165
180
|
# @return [PaymentAppliedModel] All applications this payment is associated with. To retrieve this collection, specify `Applications` in the "Include" parameter for your query.
|
166
181
|
attr_accessor :applications
|
@@ -189,6 +204,8 @@ module LockstepSdk
|
|
189
204
|
'paymentId' => @payment_id,
|
190
205
|
'companyId' => @company_id,
|
191
206
|
'erpKey' => @erp_key,
|
207
|
+
'erpWriteStatus' => @erp_write_status,
|
208
|
+
'erpWriteStatusName' => @erp_write_status_name,
|
192
209
|
'paymentType' => @payment_type,
|
193
210
|
'tenderType' => @tender_type,
|
194
211
|
'isOpen' => @is_open,
|
@@ -210,6 +227,7 @@ module LockstepSdk
|
|
210
227
|
'baseCurrencyPaymentAmount' => @base_currency_payment_amount,
|
211
228
|
'baseCurrencyUnappliedAmount' => @base_currency_unapplied_amount,
|
212
229
|
'serviceFabricStatus' => @service_fabric_status,
|
230
|
+
'sourceModifiedDate' => @source_modified_date,
|
213
231
|
'applications' => @applications,
|
214
232
|
'notes' => @notes,
|
215
233
|
'attachments' => @attachments,
|
@@ -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
|
}
|
@@ -29,6 +29,7 @@ module LockstepSdk
|
|
29
29
|
@skip_count = params.dig(:skip_count)
|
30
30
|
@error_count = params.dig(:error_count)
|
31
31
|
@errors = params.dig(:errors)
|
32
|
+
@skips = params.dig(:skips)
|
32
33
|
end
|
33
34
|
|
34
35
|
##
|
@@ -55,6 +56,10 @@ module LockstepSdk
|
|
55
56
|
# @return [Object] The errors encountered during sync keyed by ERP key
|
56
57
|
attr_accessor :errors
|
57
58
|
|
59
|
+
##
|
60
|
+
# @return [Object] The records that were skipped during sync keyed by ERP key
|
61
|
+
attr_accessor :skips
|
62
|
+
|
58
63
|
##
|
59
64
|
# @return [object] This object as a JSON key-value structure
|
60
65
|
def as_json(options={})
|
@@ -65,6 +70,7 @@ module LockstepSdk
|
|
65
70
|
'skipCount' => @skip_count,
|
66
71
|
'errorCount' => @error_count,
|
67
72
|
'errors' => @errors,
|
73
|
+
'skips' => @skips,
|
68
74
|
}
|
69
75
|
end
|
70
76
|
|
data/lib/lockstep_sdk/version.rb
CHANGED
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.
|
4
|
+
version: 2023.17.21.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-
|
11
|
+
date: 2023-04-27 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: awrence
|
@@ -120,8 +120,10 @@ files:
|
|
120
120
|
- lib/lockstep_sdk/models/developer_account_submit_model.rb
|
121
121
|
- lib/lockstep_sdk/models/dpo_summary_group_total_model.rb
|
122
122
|
- lib/lockstep_sdk/models/dpo_summary_model.rb
|
123
|
+
- lib/lockstep_sdk/models/email_reply_generator_request.rb
|
124
|
+
- lib/lockstep_sdk/models/email_reply_generator_response.rb
|
125
|
+
- lib/lockstep_sdk/models/email_reply_generator_suggestions.rb
|
123
126
|
- lib/lockstep_sdk/models/erp_model.rb
|
124
|
-
- lib/lockstep_sdk/models/error_result.rb
|
125
127
|
- lib/lockstep_sdk/models/feature_flags_request_model.rb
|
126
128
|
- lib/lockstep_sdk/models/feature_flags_response_model.rb
|
127
129
|
- lib/lockstep_sdk/models/financial_account_balance_history_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
|