invoicetronic_sdk 1.6 → 1.8
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/CHANGELOG.md +1 -1
- data/Gemfile.lock +2 -2
- data/README.md +12 -5
- data/docs/Company.md +5 -5
- data/docs/CompanyApi.md +42 -6
- data/docs/Event.md +4 -4
- data/docs/ExportApi.md +7 -1
- data/docs/HealthApi.md +7 -1
- data/docs/LogApi.md +14 -2
- data/docs/ModelSend.md +20 -18
- data/docs/Receive.md +16 -16
- data/docs/ReceiveApi.md +31 -7
- data/docs/SendApi.md +89 -15
- data/docs/SendReduced.md +3 -1
- data/docs/Status.md +5 -1
- data/docs/StatusApi.md +7 -1
- data/docs/Update.md +4 -4
- data/docs/UpdateApi.md +14 -2
- data/docs/WebHook.md +13 -11
- data/docs/WebHookHistory.md +7 -5
- data/docs/WebhookApi.md +51 -9
- data/invoicetronic_sdk.gemspec +1 -1
- data/lib/invoicetronic_sdk/api/company_api.rb +7 -7
- data/lib/invoicetronic_sdk/api/export_api.rb +2 -2
- data/lib/invoicetronic_sdk/api/health_api.rb +2 -2
- data/lib/invoicetronic_sdk/api/log_api.rb +3 -3
- data/lib/invoicetronic_sdk/api/receive_api.rb +11 -11
- data/lib/invoicetronic_sdk/api/send_api.rb +18 -15
- data/lib/invoicetronic_sdk/api/status_api.rb +2 -2
- data/lib/invoicetronic_sdk/api/update_api.rb +3 -3
- data/lib/invoicetronic_sdk/api/webhook_api.rb +8 -8
- data/lib/invoicetronic_sdk/api_client.rb +2 -2
- data/lib/invoicetronic_sdk/api_error.rb +1 -1
- data/lib/invoicetronic_sdk/api_model_base.rb +1 -1
- data/lib/invoicetronic_sdk/configuration.rb +1 -1
- data/lib/invoicetronic_sdk/models/company.rb +3 -3
- data/lib/invoicetronic_sdk/models/document_data.rb +1 -1
- data/lib/invoicetronic_sdk/models/error.rb +1 -1
- data/lib/invoicetronic_sdk/models/event.rb +2 -2
- data/lib/invoicetronic_sdk/models/model_send.rb +29 -6
- data/lib/invoicetronic_sdk/models/problem_details.rb +1 -1
- data/lib/invoicetronic_sdk/models/receive.rb +5 -5
- data/lib/invoicetronic_sdk/models/send_reduced.rb +51 -6
- data/lib/invoicetronic_sdk/models/status.rb +25 -5
- data/lib/invoicetronic_sdk/models/update.rb +2 -2
- data/lib/invoicetronic_sdk/models/web_hook.rb +20 -9
- data/lib/invoicetronic_sdk/models/web_hook_history.rb +15 -4
- data/lib/invoicetronic_sdk/version.rb +2 -2
- data/lib/invoicetronic_sdk.rb +1 -1
- data/spec/api/company_api_spec.rb +1 -1
- data/spec/api/export_api_spec.rb +1 -1
- data/spec/api/health_api_spec.rb +1 -1
- data/spec/api/log_api_spec.rb +1 -1
- data/spec/api/receive_api_spec.rb +4 -4
- data/spec/api/send_api_spec.rb +3 -2
- data/spec/api/status_api_spec.rb +1 -1
- data/spec/api/update_api_spec.rb +1 -1
- data/spec/api/webhook_api_spec.rb +1 -1
- data/spec/models/company_spec.rb +1 -1
- data/spec/models/document_data_spec.rb +1 -1
- data/spec/models/error_spec.rb +1 -1
- data/spec/models/event_spec.rb +1 -1
- data/spec/models/model_send_spec.rb +11 -1
- data/spec/models/problem_details_spec.rb +1 -1
- data/spec/models/receive_spec.rb +1 -1
- data/spec/models/send_reduced_spec.rb +11 -1
- data/spec/models/status_spec.rb +13 -1
- data/spec/models/update_spec.rb +1 -1
- data/spec/models/web_hook_history_spec.rb +7 -1
- data/spec/models/web_hook_spec.rb +7 -1
- data/spec/spec_helper.rb +1 -1
- data/vendor/bundle/ruby/3.3.0/cache/parallel-1.28.0.gem +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-13.0.0/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.5.1/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/io-console-0.8.2/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/jaro_winkler-1.5.6/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.3.1/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.2.0/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/gems/parallel-1.28.0/lib/parallel/version.rb +4 -0
- data/vendor/bundle/ruby/3.3.0/gems/{parallel-1.27.0 → parallel-1.28.0}/lib/parallel.rb +11 -0
- data/vendor/bundle/ruby/3.3.0/specifications/{parallel-1.27.0.gemspec → parallel-1.28.0.gemspec} +5 -5
- metadata +20 -20
- data/vendor/bundle/ruby/3.3.0/cache/parallel-1.27.0.gem +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/parallel-1.27.0/lib/parallel/version.rb +0 -4
- /data/vendor/bundle/ruby/3.3.0/gems/{parallel-1.27.0 → parallel-1.28.0}/MIT-LICENSE.txt +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3552bf7b33706df5138c817bc21092dd75df818bd9f3002a43d97a5b8d71d8cd
|
|
4
|
+
data.tar.gz: '03961b3e8d89f3727ce5fd28f8bee81419426dc77a417e0fb9734b133f4a646c'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 78407c0495ed036cb734529eabbdc352f9bb94750eaa23b5fa3cfdb76216d90900cd8732e55e005cf070fd4f7c832e08b7691b541e4ef4c9bb052483280158a8
|
|
7
|
+
data.tar.gz: 31be69a91c1ba4a70976ae2f477048c25f56e4fcf1a8d89fb6e2bb9a6c2ea1fd81b4a5fbbb092d2ed759b0b31cd4b3ce80a4098f0c2e3f29b8224e5ef7b94b8c
|
data/CHANGELOG.md
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
# Changelog\n\n## [1.
|
|
1
|
+
# Changelog\n\n## [1.7.0] - 2026-04-02\nSee main repository changelog for details.
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
invoicetronic_sdk (1.
|
|
4
|
+
invoicetronic_sdk (1.8)
|
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
|
6
6
|
|
|
7
7
|
GEM
|
|
@@ -31,7 +31,7 @@ GEM
|
|
|
31
31
|
jaro_winkler (1.5.6)
|
|
32
32
|
logger (1.7.0)
|
|
33
33
|
method_source (1.1.0)
|
|
34
|
-
parallel (1.
|
|
34
|
+
parallel (1.28.0)
|
|
35
35
|
parser (3.3.11.1)
|
|
36
36
|
ast (~> 2.4.1)
|
|
37
37
|
racc
|
data/README.md
CHANGED
|
@@ -9,8 +9,8 @@ For more information, see [Invoicetronic website][2]
|
|
|
9
9
|
|
|
10
10
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
11
11
|
|
|
12
|
-
- API version: 1.
|
|
13
|
-
- Package version: 1.
|
|
12
|
+
- API version: 1.12.0
|
|
13
|
+
- Package version: 1.8
|
|
14
14
|
- Generator version: 7.20.0
|
|
15
15
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
16
16
|
For more information, please visit [https://invoicetronic.com/en/contact/](https://invoicetronic.com/en/contact/)
|
|
@@ -28,16 +28,16 @@ gem build invoicetronic_sdk.gemspec
|
|
|
28
28
|
Then either install the gem locally:
|
|
29
29
|
|
|
30
30
|
```shell
|
|
31
|
-
gem install ./invoicetronic_sdk-1.
|
|
31
|
+
gem install ./invoicetronic_sdk-1.8.gem
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
(for development, run `gem install --dev ./invoicetronic_sdk-1.
|
|
34
|
+
(for development, run `gem install --dev ./invoicetronic_sdk-1.8.gem` to install the development dependencies)
|
|
35
35
|
|
|
36
36
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
37
37
|
|
|
38
38
|
Finally add this to the Gemfile:
|
|
39
39
|
|
|
40
|
-
gem 'invoicetronic_sdk', '~> 1.
|
|
40
|
+
gem 'invoicetronic_sdk', '~> 1.8'
|
|
41
41
|
|
|
42
42
|
### Install from Git
|
|
43
43
|
|
|
@@ -61,6 +61,13 @@ Please follow the [installation](#installation) procedure and then run the follo
|
|
|
61
61
|
# Load the gem
|
|
62
62
|
require 'invoicetronic_sdk'
|
|
63
63
|
|
|
64
|
+
# Setup authorization
|
|
65
|
+
Invoicetronic_Sdk.configure do |config|
|
|
66
|
+
# Configure HTTP basic authorization: Basic
|
|
67
|
+
config.username = 'YOUR_USERNAME'
|
|
68
|
+
config.password = 'YOUR_PASSWORD'
|
|
69
|
+
end
|
|
70
|
+
|
|
64
71
|
api_instance = Invoicetronic_Sdk::CompanyApi.new
|
|
65
72
|
opts = {
|
|
66
73
|
page: 56, # Integer | Page number.
|
data/docs/Company.md
CHANGED
|
@@ -4,10 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **Integer** | Unique identifier.
|
|
8
|
-
| **created** | **Time** | Creation date. It is set automatically. | [optional] |
|
|
9
|
-
| **version** | **Integer** | Row version, for optimistic concurrency. It is set automatically. | [optional] |
|
|
10
|
-
| **user_id** | **Integer** | User id. | [optional] |
|
|
7
|
+
| **id** | **Integer** | Unique identifier. For POST requests, leave it at `0` — the server will assign one automatically. For PUT requests, set it to the id of the record you want to update. | [optional] |
|
|
8
|
+
| **created** | **Time** | Creation date. It is set automatically. | [optional][readonly] |
|
|
9
|
+
| **version** | **Integer** | Row version, for optimistic concurrency. It is set automatically. | [optional][readonly] |
|
|
10
|
+
| **user_id** | **Integer** | User id. It is set automatically based on the authenticated user. | [optional][readonly] |
|
|
11
11
|
| **vat** | **String** | Vat number. Must include the country code. | |
|
|
12
12
|
| **fiscal_code** | **String** | Fiscal code. In most cases it's the same as the vat number. | |
|
|
13
13
|
| **name** | **String** | Name | |
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
require 'invoicetronic_sdk'
|
|
19
19
|
|
|
20
20
|
instance = Invoicetronic_Sdk::Company.new(
|
|
21
|
-
id:
|
|
21
|
+
id: 0,
|
|
22
22
|
created: null,
|
|
23
23
|
version: null,
|
|
24
24
|
user_id: null,
|
data/docs/CompanyApi.md
CHANGED
|
@@ -25,6 +25,12 @@ Retrieve a paginated list of companies. Results can be filtered by free-text sea
|
|
|
25
25
|
```ruby
|
|
26
26
|
require 'time'
|
|
27
27
|
require 'invoicetronic_sdk'
|
|
28
|
+
# setup authorization
|
|
29
|
+
Invoicetronic_Sdk.configure do |config|
|
|
30
|
+
# Configure HTTP basic authorization: Basic
|
|
31
|
+
config.username = 'YOUR USERNAME'
|
|
32
|
+
config.password = 'YOUR PASSWORD'
|
|
33
|
+
end
|
|
28
34
|
|
|
29
35
|
api_instance = Invoicetronic_Sdk::CompanyApi.new
|
|
30
36
|
opts = {
|
|
@@ -76,7 +82,7 @@ end
|
|
|
76
82
|
|
|
77
83
|
### Authorization
|
|
78
84
|
|
|
79
|
-
|
|
85
|
+
[Basic](../README.md#Basic)
|
|
80
86
|
|
|
81
87
|
### HTTP request headers
|
|
82
88
|
|
|
@@ -97,6 +103,12 @@ Delete a company by its internal id. **Companies** are the entities that send a
|
|
|
97
103
|
```ruby
|
|
98
104
|
require 'time'
|
|
99
105
|
require 'invoicetronic_sdk'
|
|
106
|
+
# setup authorization
|
|
107
|
+
Invoicetronic_Sdk.configure do |config|
|
|
108
|
+
# Configure HTTP basic authorization: Basic
|
|
109
|
+
config.username = 'YOUR USERNAME'
|
|
110
|
+
config.password = 'YOUR PASSWORD'
|
|
111
|
+
end
|
|
100
112
|
|
|
101
113
|
api_instance = Invoicetronic_Sdk::CompanyApi.new
|
|
102
114
|
id = 56 # Integer | Item id
|
|
@@ -144,7 +156,7 @@ end
|
|
|
144
156
|
|
|
145
157
|
### Authorization
|
|
146
158
|
|
|
147
|
-
|
|
159
|
+
[Basic](../README.md#Basic)
|
|
148
160
|
|
|
149
161
|
### HTTP request headers
|
|
150
162
|
|
|
@@ -165,6 +177,12 @@ Retrieve a company by its internal id. **Companies** are the entities that send
|
|
|
165
177
|
```ruby
|
|
166
178
|
require 'time'
|
|
167
179
|
require 'invoicetronic_sdk'
|
|
180
|
+
# setup authorization
|
|
181
|
+
Invoicetronic_Sdk.configure do |config|
|
|
182
|
+
# Configure HTTP basic authorization: Basic
|
|
183
|
+
config.username = 'YOUR USERNAME'
|
|
184
|
+
config.password = 'YOUR PASSWORD'
|
|
185
|
+
end
|
|
168
186
|
|
|
169
187
|
api_instance = Invoicetronic_Sdk::CompanyApi.new
|
|
170
188
|
id = 56 # Integer | Item id
|
|
@@ -208,7 +226,7 @@ end
|
|
|
208
226
|
|
|
209
227
|
### Authorization
|
|
210
228
|
|
|
211
|
-
|
|
229
|
+
[Basic](../README.md#Basic)
|
|
212
230
|
|
|
213
231
|
### HTTP request headers
|
|
214
232
|
|
|
@@ -229,6 +247,12 @@ Add a new company. **Companies** are the entities that send and receive invoice
|
|
|
229
247
|
```ruby
|
|
230
248
|
require 'time'
|
|
231
249
|
require 'invoicetronic_sdk'
|
|
250
|
+
# setup authorization
|
|
251
|
+
Invoicetronic_Sdk.configure do |config|
|
|
252
|
+
# Configure HTTP basic authorization: Basic
|
|
253
|
+
config.username = 'YOUR USERNAME'
|
|
254
|
+
config.password = 'YOUR PASSWORD'
|
|
255
|
+
end
|
|
232
256
|
|
|
233
257
|
api_instance = Invoicetronic_Sdk::CompanyApi.new
|
|
234
258
|
company = Invoicetronic_Sdk::Company.new({vat: 'IT01234567891', fiscal_code: 'RSSMRA70A01F205V', name: 'Mario Rossi Srl'}) # Company |
|
|
@@ -272,7 +296,7 @@ end
|
|
|
272
296
|
|
|
273
297
|
### Authorization
|
|
274
298
|
|
|
275
|
-
|
|
299
|
+
[Basic](../README.md#Basic)
|
|
276
300
|
|
|
277
301
|
### HTTP request headers
|
|
278
302
|
|
|
@@ -293,6 +317,12 @@ Update an existing company. **Companies** are the entities that send and receiv
|
|
|
293
317
|
```ruby
|
|
294
318
|
require 'time'
|
|
295
319
|
require 'invoicetronic_sdk'
|
|
320
|
+
# setup authorization
|
|
321
|
+
Invoicetronic_Sdk.configure do |config|
|
|
322
|
+
# Configure HTTP basic authorization: Basic
|
|
323
|
+
config.username = 'YOUR USERNAME'
|
|
324
|
+
config.password = 'YOUR PASSWORD'
|
|
325
|
+
end
|
|
296
326
|
|
|
297
327
|
api_instance = Invoicetronic_Sdk::CompanyApi.new
|
|
298
328
|
company = Invoicetronic_Sdk::Company.new({vat: 'IT01234567891', fiscal_code: 'RSSMRA70A01F205V', name: 'Mario Rossi Srl'}) # Company |
|
|
@@ -336,7 +366,7 @@ end
|
|
|
336
366
|
|
|
337
367
|
### Authorization
|
|
338
368
|
|
|
339
|
-
|
|
369
|
+
[Basic](../README.md#Basic)
|
|
340
370
|
|
|
341
371
|
### HTTP request headers
|
|
342
372
|
|
|
@@ -357,6 +387,12 @@ Retrieve a company by its VAT number. **Companies** are the entities that send
|
|
|
357
387
|
```ruby
|
|
358
388
|
require 'time'
|
|
359
389
|
require 'invoicetronic_sdk'
|
|
390
|
+
# setup authorization
|
|
391
|
+
Invoicetronic_Sdk.configure do |config|
|
|
392
|
+
# Configure HTTP basic authorization: Basic
|
|
393
|
+
config.username = 'YOUR USERNAME'
|
|
394
|
+
config.password = 'YOUR PASSWORD'
|
|
395
|
+
end
|
|
360
396
|
|
|
361
397
|
api_instance = Invoicetronic_Sdk::CompanyApi.new
|
|
362
398
|
vat = 'vat_example' # String |
|
|
@@ -400,7 +436,7 @@ end
|
|
|
400
436
|
|
|
401
437
|
### Authorization
|
|
402
438
|
|
|
403
|
-
|
|
439
|
+
[Basic](../README.md#Basic)
|
|
404
440
|
|
|
405
441
|
### HTTP request headers
|
|
406
442
|
|
data/docs/Event.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **Integer** | Unique identifier.
|
|
8
|
-
| **created** | **Time** | Creation date. It is set automatically. | [optional] |
|
|
9
|
-
| **version** | **Integer** | Row version, for optimistic concurrency. It is set automatically. | [optional] |
|
|
7
|
+
| **id** | **Integer** | Unique identifier. For POST requests, leave it at `0` — the server will assign one automatically. For PUT requests, set it to the id of the record you want to update. | [optional] |
|
|
8
|
+
| **created** | **Time** | Creation date. It is set automatically. | [optional][readonly] |
|
|
9
|
+
| **version** | **Integer** | Row version, for optimistic concurrency. It is set automatically. | [optional][readonly] |
|
|
10
10
|
| **user_id** | **Integer** | User id. | [optional] |
|
|
11
11
|
| **api_key_id** | **Integer** | Api key id. | [optional] |
|
|
12
12
|
| **company_id** | **Integer** | Company id. | [optional] |
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
require 'invoicetronic_sdk'
|
|
29
29
|
|
|
30
30
|
instance = Invoicetronic_Sdk::Event.new(
|
|
31
|
-
id:
|
|
31
|
+
id: 0,
|
|
32
32
|
created: null,
|
|
33
33
|
version: null,
|
|
34
34
|
user_id: null,
|
data/docs/ExportApi.md
CHANGED
|
@@ -20,6 +20,12 @@ Export invoices as a ZIP archive of FatturaPA XML files, suitable for import int
|
|
|
20
20
|
```ruby
|
|
21
21
|
require 'time'
|
|
22
22
|
require 'invoicetronic_sdk'
|
|
23
|
+
# setup authorization
|
|
24
|
+
Invoicetronic_Sdk.configure do |config|
|
|
25
|
+
# Configure HTTP basic authorization: Basic
|
|
26
|
+
config.username = 'YOUR USERNAME'
|
|
27
|
+
config.password = 'YOUR PASSWORD'
|
|
28
|
+
end
|
|
23
29
|
|
|
24
30
|
api_instance = Invoicetronic_Sdk::ExportApi.new
|
|
25
31
|
opts = {
|
|
@@ -76,7 +82,7 @@ nil (empty response body)
|
|
|
76
82
|
|
|
77
83
|
### Authorization
|
|
78
84
|
|
|
79
|
-
|
|
85
|
+
[Basic](../README.md#Basic)
|
|
80
86
|
|
|
81
87
|
### HTTP request headers
|
|
82
88
|
|
data/docs/HealthApi.md
CHANGED
|
@@ -20,6 +20,12 @@ Returns the health status of the API and its dependencies. No authentication req
|
|
|
20
20
|
```ruby
|
|
21
21
|
require 'time'
|
|
22
22
|
require 'invoicetronic_sdk'
|
|
23
|
+
# setup authorization
|
|
24
|
+
Invoicetronic_Sdk.configure do |config|
|
|
25
|
+
# Configure HTTP basic authorization: Basic
|
|
26
|
+
config.username = 'YOUR USERNAME'
|
|
27
|
+
config.password = 'YOUR PASSWORD'
|
|
28
|
+
end
|
|
23
29
|
|
|
24
30
|
api_instance = Invoicetronic_Sdk::HealthApi.new
|
|
25
31
|
|
|
@@ -59,7 +65,7 @@ nil (empty response body)
|
|
|
59
65
|
|
|
60
66
|
### Authorization
|
|
61
67
|
|
|
62
|
-
|
|
68
|
+
[Basic](../README.md#Basic)
|
|
63
69
|
|
|
64
70
|
### HTTP request headers
|
|
65
71
|
|
data/docs/LogApi.md
CHANGED
|
@@ -21,6 +21,12 @@ Retrieve a paginated list of log events. Results can be filtered by various crit
|
|
|
21
21
|
```ruby
|
|
22
22
|
require 'time'
|
|
23
23
|
require 'invoicetronic_sdk'
|
|
24
|
+
# setup authorization
|
|
25
|
+
Invoicetronic_Sdk.configure do |config|
|
|
26
|
+
# Configure HTTP basic authorization: Basic
|
|
27
|
+
config.username = 'YOUR USERNAME'
|
|
28
|
+
config.password = 'YOUR PASSWORD'
|
|
29
|
+
end
|
|
24
30
|
|
|
25
31
|
api_instance = Invoicetronic_Sdk::LogApi.new
|
|
26
32
|
opts = {
|
|
@@ -94,7 +100,7 @@ end
|
|
|
94
100
|
|
|
95
101
|
### Authorization
|
|
96
102
|
|
|
97
|
-
|
|
103
|
+
[Basic](../README.md#Basic)
|
|
98
104
|
|
|
99
105
|
### HTTP request headers
|
|
100
106
|
|
|
@@ -115,6 +121,12 @@ Retrieve a log event by its internal id. **Logs** record every API request. The
|
|
|
115
121
|
```ruby
|
|
116
122
|
require 'time'
|
|
117
123
|
require 'invoicetronic_sdk'
|
|
124
|
+
# setup authorization
|
|
125
|
+
Invoicetronic_Sdk.configure do |config|
|
|
126
|
+
# Configure HTTP basic authorization: Basic
|
|
127
|
+
config.username = 'YOUR USERNAME'
|
|
128
|
+
config.password = 'YOUR PASSWORD'
|
|
129
|
+
end
|
|
118
130
|
|
|
119
131
|
api_instance = Invoicetronic_Sdk::LogApi.new
|
|
120
132
|
id = 56 # Integer | Item id
|
|
@@ -158,7 +170,7 @@ end
|
|
|
158
170
|
|
|
159
171
|
### Authorization
|
|
160
172
|
|
|
161
|
-
|
|
173
|
+
[Basic](../README.md#Basic)
|
|
162
174
|
|
|
163
175
|
### HTTP request headers
|
|
164
176
|
|
data/docs/ModelSend.md
CHANGED
|
@@ -4,23 +4,24 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **Integer** | Unique identifier.
|
|
8
|
-
| **created** | **Time** | Creation date. It is set automatically. | [optional] |
|
|
9
|
-
| **version** | **Integer** | Row version, for optimistic concurrency. It is set automatically. | [optional] |
|
|
10
|
-
| **user_id** | **Integer** | User id. | [optional] |
|
|
11
|
-
| **company_id** | **Integer** | Company id.
|
|
12
|
-
| **committente** | **String** | VAT number of the Cessionario/Committente (customer). This is automatically set based on the recipient's VAT number. | [optional] |
|
|
13
|
-
| **prestatore** | **String** | VAT number of the Cedente/Prestatore (vendor). This is automatically set based on the sender's VAT number. | [optional] |
|
|
14
|
-
| **identifier** | **String** | SDI identifier. This is set by the SDI and is guaranteed to be unique within the SDI system. | [optional] |
|
|
15
|
-
| **file_name** | **String** | Xml file name. | [optional] |
|
|
7
|
+
| **id** | **Integer** | Unique identifier. For POST requests, leave it at `0` — the server will assign one automatically. For PUT requests, set it to the id of the record you want to update. | [optional] |
|
|
8
|
+
| **created** | **Time** | Creation date. It is set automatically. | [optional][readonly] |
|
|
9
|
+
| **version** | **Integer** | Row version, for optimistic concurrency. It is set automatically. | [optional][readonly] |
|
|
10
|
+
| **user_id** | **Integer** | User id. It is set automatically based on the authenticated user. | [optional][readonly] |
|
|
11
|
+
| **company_id** | **Integer** | Company id. It is set automatically based on the VAT number extracted from the invoice payload (the sender for `send`, the recipient for `receive`). | [optional][readonly] |
|
|
12
|
+
| **committente** | **String** | VAT number of the Cessionario/Committente (customer). This is automatically set based on the recipient's VAT number. | [optional][readonly] |
|
|
13
|
+
| **prestatore** | **String** | VAT number of the Cedente/Prestatore (vendor). This is automatically set based on the sender's VAT number. | [optional][readonly] |
|
|
14
|
+
| **identifier** | **String** | SDI identifier. This is set by the SDI and is guaranteed to be unique within the SDI system. | [optional][readonly] |
|
|
15
|
+
| **file_name** | **String** | Xml file name. If not provided on send, it will be auto-generated. | [optional] |
|
|
16
16
|
| **format** | **String** | SDI format (FPA12, FPR12, FSM10, ...) | [optional] |
|
|
17
17
|
| **payload** | **String** | Xml payload. This is the actual xml content, as string. On send, it can be base64 encoded. If it's not, it will be encoded before sending. It is guaranteed to be encrypted at rest. | |
|
|
18
|
-
| **last_update** | **Time** | Last update from SDI. | [optional] |
|
|
19
|
-
| **date_sent** | **Time** | When the invoice was sent to SDI. | [optional] |
|
|
20
|
-
| **documents** | [**Array<DocumentData>**](DocumentData.md) | The invoices included in the payload. This is set by the system, based on the xml content. | [optional] |
|
|
18
|
+
| **last_update** | **Time** | Last update from SDI. | [optional][readonly] |
|
|
19
|
+
| **date_sent** | **Time** | When the invoice was sent to SDI. | [optional][readonly] |
|
|
20
|
+
| **documents** | [**Array<DocumentData>**](DocumentData.md) | The invoices included in the payload. This is set by the system, based on the xml content. | [optional][readonly] |
|
|
21
21
|
| **encoding** | **String** | Whether the payload is Base64 encoded or a plain XML (text). | [optional] |
|
|
22
|
-
| **nome_committente** | **String** | Business name of the committente (client/buyer) extracted from the invoice XML. | [optional] |
|
|
22
|
+
| **nome_committente** | **String** | Business name of the committente (client/buyer) extracted from the invoice XML. | [optional][readonly] |
|
|
23
23
|
| **meta_data** | **Hash<String, String>** | Optional metadata, as json. | [optional] |
|
|
24
|
+
| **latest_state** | **String** | Current SDI state of the invoice. Reflects the most recent update received from SDI. Null when no update has been received yet. | [optional][readonly] |
|
|
24
25
|
| **company** | [**Company**](Company.md) | | [optional] |
|
|
25
26
|
|
|
26
27
|
## Example
|
|
@@ -29,7 +30,7 @@
|
|
|
29
30
|
require 'invoicetronic_sdk'
|
|
30
31
|
|
|
31
32
|
instance = Invoicetronic_Sdk::ModelSend.new(
|
|
32
|
-
id:
|
|
33
|
+
id: 0,
|
|
33
34
|
created: null,
|
|
34
35
|
version: null,
|
|
35
36
|
user_id: null,
|
|
@@ -37,15 +38,16 @@ instance = Invoicetronic_Sdk::ModelSend.new(
|
|
|
37
38
|
committente: null,
|
|
38
39
|
prestatore: null,
|
|
39
40
|
identifier: null,
|
|
40
|
-
file_name:
|
|
41
|
-
format:
|
|
42
|
-
payload:
|
|
41
|
+
file_name: IT01180680397ITRON_00001.xml,
|
|
42
|
+
format: FPR12,
|
|
43
|
+
payload: PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48cDpGYXR0dXJhRWxldHRyb25pY2EgLi4uPjwvcDpGYXR0dXJhRWxldHRyb25pY2E+,
|
|
43
44
|
last_update: null,
|
|
44
45
|
date_sent: null,
|
|
45
46
|
documents: null,
|
|
46
47
|
encoding: null,
|
|
47
48
|
nome_committente: null,
|
|
48
|
-
meta_data:
|
|
49
|
+
meta_data: {"order_id":"ORD-123"},
|
|
50
|
+
latest_state: null,
|
|
49
51
|
company: null
|
|
50
52
|
)
|
|
51
53
|
```
|
data/docs/Receive.md
CHANGED
|
@@ -4,20 +4,20 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **Integer** | Unique identifier.
|
|
8
|
-
| **created** | **Time** | Creation date. It is set automatically. | [optional] |
|
|
9
|
-
| **version** | **Integer** | Row version, for optimistic concurrency. It is set automatically. | [optional] |
|
|
10
|
-
| **user_id** | **Integer** | User id. | [optional] |
|
|
11
|
-
| **company_id** | **Integer** | Company id.
|
|
12
|
-
| **committente** | **String** | VAT number of the Cessionario/Committente (customer). This is automatically set based on the recipient's VAT number. | [optional] |
|
|
13
|
-
| **prestatore** | **String** | VAT number of the Cedente/Prestatore (vendor). This is automatically set based on the sender's VAT number. | [optional] |
|
|
14
|
-
| **identifier** | **String** | SDI identifier. This is set by the SDI and is guaranteed to be unique within the SDI system. | [optional] |
|
|
15
|
-
| **file_name** | **String** | Xml file name. | [optional] |
|
|
7
|
+
| **id** | **Integer** | Unique identifier. For POST requests, leave it at `0` — the server will assign one automatically. For PUT requests, set it to the id of the record you want to update. | [optional] |
|
|
8
|
+
| **created** | **Time** | Creation date. It is set automatically. | [optional][readonly] |
|
|
9
|
+
| **version** | **Integer** | Row version, for optimistic concurrency. It is set automatically. | [optional][readonly] |
|
|
10
|
+
| **user_id** | **Integer** | User id. It is set automatically based on the authenticated user. | [optional][readonly] |
|
|
11
|
+
| **company_id** | **Integer** | Company id. It is set automatically based on the VAT number extracted from the invoice payload (the sender for `send`, the recipient for `receive`). | [optional][readonly] |
|
|
12
|
+
| **committente** | **String** | VAT number of the Cessionario/Committente (customer). This is automatically set based on the recipient's VAT number. | [optional][readonly] |
|
|
13
|
+
| **prestatore** | **String** | VAT number of the Cedente/Prestatore (vendor). This is automatically set based on the sender's VAT number. | [optional][readonly] |
|
|
14
|
+
| **identifier** | **String** | SDI identifier. This is set by the SDI and is guaranteed to be unique within the SDI system. | [optional][readonly] |
|
|
15
|
+
| **file_name** | **String** | Xml file name. If not provided on send, it will be auto-generated. | [optional] |
|
|
16
16
|
| **format** | **String** | SDI format (FPA12, FPR12, FSM10, ...) | [optional] |
|
|
17
17
|
| **payload** | **String** | Xml payload. This is the actual xml content, as string. On send, it can be base64 encoded. If it's not, it will be encoded before sending. It is guaranteed to be encrypted at rest. | |
|
|
18
|
-
| **last_update** | **Time** | Last update from SDI. | [optional] |
|
|
19
|
-
| **date_sent** | **Time** | When the invoice was sent to SDI. | [optional] |
|
|
20
|
-
| **documents** | [**Array<DocumentData>**](DocumentData.md) | The invoices included in the payload. This is set by the system, based on the xml content. | [optional] |
|
|
18
|
+
| **last_update** | **Time** | Last update from SDI. | [optional][readonly] |
|
|
19
|
+
| **date_sent** | **Time** | When the invoice was sent to SDI. | [optional][readonly] |
|
|
20
|
+
| **documents** | [**Array<DocumentData>**](DocumentData.md) | The invoices included in the payload. This is set by the system, based on the xml content. | [optional][readonly] |
|
|
21
21
|
| **encoding** | **String** | Whether the payload is Base64 encoded or a plain XML (text). | [optional] |
|
|
22
22
|
| **nome_prestatore** | **String** | Business name of the prestatore (supplier/seller) extracted from the invoice XML. | [optional] |
|
|
23
23
|
| **is_read** | **Boolean** | Whether the invoice has been read at least once. Set to true only when the invoice is requested with include_payload=true. | [optional] |
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
require 'invoicetronic_sdk'
|
|
30
30
|
|
|
31
31
|
instance = Invoicetronic_Sdk::Receive.new(
|
|
32
|
-
id:
|
|
32
|
+
id: 0,
|
|
33
33
|
created: null,
|
|
34
34
|
version: null,
|
|
35
35
|
user_id: null,
|
|
@@ -37,9 +37,9 @@ instance = Invoicetronic_Sdk::Receive.new(
|
|
|
37
37
|
committente: null,
|
|
38
38
|
prestatore: null,
|
|
39
39
|
identifier: null,
|
|
40
|
-
file_name:
|
|
41
|
-
format:
|
|
42
|
-
payload:
|
|
40
|
+
file_name: IT01180680397ITRON_00001.xml,
|
|
41
|
+
format: FPR12,
|
|
42
|
+
payload: PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48cDpGYXR0dXJhRWxldHRyb25pY2EgLi4uPjwvcDpGYXR0dXJhRWxldHRyb25pY2E+,
|
|
43
43
|
last_update: null,
|
|
44
44
|
date_sent: null,
|
|
45
45
|
documents: null,
|
data/docs/ReceiveApi.md
CHANGED
|
@@ -16,13 +16,19 @@ All URIs are relative to *http://localhost*
|
|
|
16
16
|
|
|
17
17
|
List incoming invoices
|
|
18
18
|
|
|
19
|
-
Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content. Invoices are marked as read (`is_read` = true) only when `include_payload` is true. **Receive** invoices are inbound purchase invoices received from suppliers through Italy's SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
19
|
+
Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content. Invoices are marked as read (`is_read` = true) only when `include_payload` is true. **Receive** invoices are inbound purchase invoices received from suppliers through Italy's SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/). Inbound invoices are routed to your account via the recipient VAT number, so the recipient company must exist in Invoicetronic for the invoice to be matched. If an invoice arrives before its company has been registered, it is held by our SDI infrastructure and automatically re-processed once the company is created—no invoice is lost. See [Prerequisites](https://invoicetronic.com/en/docs/prerequisites/) for the recommended setup order.
|
|
20
20
|
|
|
21
21
|
### Examples
|
|
22
22
|
|
|
23
23
|
```ruby
|
|
24
24
|
require 'time'
|
|
25
25
|
require 'invoicetronic_sdk'
|
|
26
|
+
# setup authorization
|
|
27
|
+
Invoicetronic_Sdk.configure do |config|
|
|
28
|
+
# Configure HTTP basic authorization: Basic
|
|
29
|
+
config.username = 'YOUR USERNAME'
|
|
30
|
+
config.password = 'YOUR PASSWORD'
|
|
31
|
+
end
|
|
26
32
|
|
|
27
33
|
api_instance = Invoicetronic_Sdk::ReceiveApi.new
|
|
28
34
|
opts = {
|
|
@@ -102,7 +108,7 @@ end
|
|
|
102
108
|
|
|
103
109
|
### Authorization
|
|
104
110
|
|
|
105
|
-
|
|
111
|
+
[Basic](../README.md#Basic)
|
|
106
112
|
|
|
107
113
|
### HTTP request headers
|
|
108
114
|
|
|
@@ -116,13 +122,19 @@ No authorization required
|
|
|
116
122
|
|
|
117
123
|
Delete an incoming invoice by id
|
|
118
124
|
|
|
119
|
-
Permanently delete a receive invoice by its internal id. This action cannot be undone. **Receive** invoices are inbound purchase invoices received from suppliers through Italy's SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
125
|
+
Permanently delete a receive invoice by its internal id. This action cannot be undone. **Receive** invoices are inbound purchase invoices received from suppliers through Italy's SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/). Inbound invoices are routed to your account via the recipient VAT number, so the recipient company must exist in Invoicetronic for the invoice to be matched. If an invoice arrives before its company has been registered, it is held by our SDI infrastructure and automatically re-processed once the company is created—no invoice is lost. See [Prerequisites](https://invoicetronic.com/en/docs/prerequisites/) for the recommended setup order.
|
|
120
126
|
|
|
121
127
|
### Examples
|
|
122
128
|
|
|
123
129
|
```ruby
|
|
124
130
|
require 'time'
|
|
125
131
|
require 'invoicetronic_sdk'
|
|
132
|
+
# setup authorization
|
|
133
|
+
Invoicetronic_Sdk.configure do |config|
|
|
134
|
+
# Configure HTTP basic authorization: Basic
|
|
135
|
+
config.username = 'YOUR USERNAME'
|
|
136
|
+
config.password = 'YOUR PASSWORD'
|
|
137
|
+
end
|
|
126
138
|
|
|
127
139
|
api_instance = Invoicetronic_Sdk::ReceiveApi.new
|
|
128
140
|
id = 56 # Integer | Item id
|
|
@@ -166,7 +178,7 @@ end
|
|
|
166
178
|
|
|
167
179
|
### Authorization
|
|
168
180
|
|
|
169
|
-
|
|
181
|
+
[Basic](../README.md#Basic)
|
|
170
182
|
|
|
171
183
|
### HTTP request headers
|
|
172
184
|
|
|
@@ -180,13 +192,19 @@ No authorization required
|
|
|
180
192
|
|
|
181
193
|
Get an incoming invoice by id
|
|
182
194
|
|
|
183
|
-
Retrieve an incoming invoice by its internal id. The `id` is unique and assigned by the system when the invoice is received. Returns invoice metadata; set `include_payload` to true to include the full invoice content. The invoice is marked as read (`is_read` = true) only when `include_payload` is true. **Receive** invoices are inbound purchase invoices received from suppliers through Italy's SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
195
|
+
Retrieve an incoming invoice by its internal id. The `id` is unique and assigned by the system when the invoice is received. Returns invoice metadata; set `include_payload` to true to include the full invoice content. The invoice is marked as read (`is_read` = true) only when `include_payload` is true. **Receive** invoices are inbound purchase invoices received from suppliers through Italy's SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/). Inbound invoices are routed to your account via the recipient VAT number, so the recipient company must exist in Invoicetronic for the invoice to be matched. If an invoice arrives before its company has been registered, it is held by our SDI infrastructure and automatically re-processed once the company is created—no invoice is lost. See [Prerequisites](https://invoicetronic.com/en/docs/prerequisites/) for the recommended setup order.
|
|
184
196
|
|
|
185
197
|
### Examples
|
|
186
198
|
|
|
187
199
|
```ruby
|
|
188
200
|
require 'time'
|
|
189
201
|
require 'invoicetronic_sdk'
|
|
202
|
+
# setup authorization
|
|
203
|
+
Invoicetronic_Sdk.configure do |config|
|
|
204
|
+
# Configure HTTP basic authorization: Basic
|
|
205
|
+
config.username = 'YOUR USERNAME'
|
|
206
|
+
config.password = 'YOUR PASSWORD'
|
|
207
|
+
end
|
|
190
208
|
|
|
191
209
|
api_instance = Invoicetronic_Sdk::ReceiveApi.new
|
|
192
210
|
id = 56 # Integer | Item id
|
|
@@ -234,7 +252,7 @@ end
|
|
|
234
252
|
|
|
235
253
|
### Authorization
|
|
236
254
|
|
|
237
|
-
|
|
255
|
+
[Basic](../README.md#Basic)
|
|
238
256
|
|
|
239
257
|
### HTTP request headers
|
|
240
258
|
|
|
@@ -255,6 +273,12 @@ Retrieve only the payload of a receive invoice, without the full invoice metadat
|
|
|
255
273
|
```ruby
|
|
256
274
|
require 'time'
|
|
257
275
|
require 'invoicetronic_sdk'
|
|
276
|
+
# setup authorization
|
|
277
|
+
Invoicetronic_Sdk.configure do |config|
|
|
278
|
+
# Configure HTTP basic authorization: Basic
|
|
279
|
+
config.username = 'YOUR USERNAME'
|
|
280
|
+
config.password = 'YOUR PASSWORD'
|
|
281
|
+
end
|
|
258
282
|
|
|
259
283
|
api_instance = Invoicetronic_Sdk::ReceiveApi.new
|
|
260
284
|
id = 56 # Integer | Item id
|
|
@@ -297,7 +321,7 @@ nil (empty response body)
|
|
|
297
321
|
|
|
298
322
|
### Authorization
|
|
299
323
|
|
|
300
|
-
|
|
324
|
+
[Basic](../README.md#Basic)
|
|
301
325
|
|
|
302
326
|
### HTTP request headers
|
|
303
327
|
|