invoicetronic_sdk 1.7 → 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/Gemfile.lock +1 -1
- data/README.md +5 -5
- data/docs/Company.md +5 -5
- data/docs/Event.md +4 -4
- data/docs/ModelSend.md +20 -18
- data/docs/Receive.md +16 -16
- data/docs/ReceiveApi.md +3 -3
- data/docs/SendApi.md +5 -3
- data/docs/SendReduced.md +3 -1
- data/docs/Status.md +5 -1
- data/docs/Update.md +4 -4
- data/docs/WebHook.md +13 -11
- data/docs/WebHookHistory.md +7 -5
- data/docs/WebhookApi.md +2 -2
- data/invoicetronic_sdk.gemspec +1 -1
- data/lib/invoicetronic_sdk/api/company_api.rb +1 -1
- data/lib/invoicetronic_sdk/api/export_api.rb +1 -1
- data/lib/invoicetronic_sdk/api/health_api.rb +1 -1
- data/lib/invoicetronic_sdk/api/log_api.rb +1 -1
- data/lib/invoicetronic_sdk/api/receive_api.rb +7 -7
- data/lib/invoicetronic_sdk/api/send_api.rb +6 -3
- data/lib/invoicetronic_sdk/api/status_api.rb +1 -1
- data/lib/invoicetronic_sdk/api/update_api.rb +1 -1
- data/lib/invoicetronic_sdk/api/webhook_api.rb +1 -1
- 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/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
- metadata +15 -15
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/Gemfile.lock
CHANGED
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
|
|
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/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/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,7 +16,7 @@ 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
|
|
|
@@ -122,7 +122,7 @@ end
|
|
|
122
122
|
|
|
123
123
|
Delete an incoming invoice by id
|
|
124
124
|
|
|
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/).
|
|
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.
|
|
126
126
|
|
|
127
127
|
### Examples
|
|
128
128
|
|
|
@@ -192,7 +192,7 @@ end
|
|
|
192
192
|
|
|
193
193
|
Get an incoming invoice by id
|
|
194
194
|
|
|
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/).
|
|
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.
|
|
196
196
|
|
|
197
197
|
### Examples
|
|
198
198
|
|
data/docs/SendApi.md
CHANGED
|
@@ -100,7 +100,7 @@ end
|
|
|
100
100
|
|
|
101
101
|
List invoices
|
|
102
102
|
|
|
103
|
-
Retrieve a paginated list of send invoices. Results can be filtered by various criteria such as company, date ranges, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content. **Send** invoices are outbound sales invoices transmitted to customers through Italy's SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
103
|
+
Retrieve a paginated list of send invoices. Results can be filtered by various criteria such as company, date ranges, document number, and free-text search (`q`). Use `ids` to fetch specific Send records in a single call (comma-separated, up to 100). Returns invoice metadata; set `include_payload` to true to include the full invoice content. **Send** invoices are outbound sales invoices transmitted to customers through Italy's SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
104
104
|
|
|
105
105
|
### Examples
|
|
106
106
|
|
|
@@ -129,6 +129,7 @@ opts = {
|
|
|
129
129
|
document_date_to: Time.parse('2013-10-20T19:20:30+01:00'), # Time | UTC ISO 8601 (2024-11-29T12:34:56Z)
|
|
130
130
|
document_number: 'document_number_example', # String | Document number.
|
|
131
131
|
include_payload: true, # Boolean | Include payload in the response. Defaults to false.
|
|
132
|
+
ids: 'ids_example', # String | Comma-separated list of Send ids (max 100). Filters the collection to the matching rows; unknown or unauthorized ids are silently skipped.
|
|
132
133
|
page: 56, # Integer | Page number.
|
|
133
134
|
page_size: 56, # Integer | Items per page. Cannot be greater than 200.
|
|
134
135
|
sort: 'sort_example', # String | Sort by field. Prefix with '-' for descending order.
|
|
@@ -179,6 +180,7 @@ end
|
|
|
179
180
|
| **document_date_to** | **Time** | UTC ISO 8601 (2024-11-29T12:34:56Z) | [optional] |
|
|
180
181
|
| **document_number** | **String** | Document number. | [optional] |
|
|
181
182
|
| **include_payload** | **Boolean** | Include payload in the response. Defaults to false. | [optional] |
|
|
183
|
+
| **ids** | **String** | Comma-separated list of Send ids (max 100). Filters the collection to the matching rows; unknown or unauthorized ids are silently skipped. | [optional] |
|
|
182
184
|
| **page** | **Integer** | Page number. | [optional][default to 1] |
|
|
183
185
|
| **page_size** | **Integer** | Items per page. Cannot be greater than 200. | [optional][default to 100] |
|
|
184
186
|
| **sort** | **String** | Sort by field. Prefix with '-' for descending order. | [optional] |
|
|
@@ -512,7 +514,7 @@ Invoicetronic_Sdk.configure do |config|
|
|
|
512
514
|
end
|
|
513
515
|
|
|
514
516
|
api_instance = Invoicetronic_Sdk::SendApi.new
|
|
515
|
-
model_send = Invoicetronic_Sdk::ModelSend.new({payload: '
|
|
517
|
+
model_send = Invoicetronic_Sdk::ModelSend.new({payload: 'PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48cDpGYXR0dXJhRWxldHRyb25pY2EgLi4uPjwvcDpGYXR0dXJhRWxldHRyb25pY2E+'}) # ModelSend |
|
|
516
518
|
opts = {
|
|
517
519
|
validate: true, # Boolean | Validate the document first, and reject it on failure.
|
|
518
520
|
signature: 'None' # String | Whether to digitally sign the document.
|
|
@@ -726,7 +728,7 @@ Invoicetronic_Sdk.configure do |config|
|
|
|
726
728
|
end
|
|
727
729
|
|
|
728
730
|
api_instance = Invoicetronic_Sdk::SendApi.new
|
|
729
|
-
model_send = Invoicetronic_Sdk::ModelSend.new({payload: '
|
|
731
|
+
model_send = Invoicetronic_Sdk::ModelSend.new({payload: 'PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48cDpGYXR0dXJhRWxldHRyb25pY2EgLi4uPjwvcDpGYXR0dXJhRWxldHRyb25pY2E+'}) # ModelSend |
|
|
730
732
|
|
|
731
733
|
begin
|
|
732
734
|
# Validate an invoice
|
data/docs/SendReduced.md
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
| **meta_data** | **Hash<String, String>** | Optional metadata, as json. | [optional] |
|
|
10
10
|
| **documents** | [**Array<DocumentData>**](DocumentData.md) | The invoices included in the payload. | [optional] |
|
|
11
11
|
| **date_sent** | **Time** | When the invoice was sent to SDI. | [optional] |
|
|
12
|
+
| **latest_state** | **String** | Current SDI state of the invoice. Reflects the most recent update received from SDI. | [optional] |
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -20,7 +21,8 @@ instance = Invoicetronic_Sdk::SendReduced.new(
|
|
|
20
21
|
prestatore: null,
|
|
21
22
|
meta_data: null,
|
|
22
23
|
documents: null,
|
|
23
|
-
date_sent: null
|
|
24
|
+
date_sent: null,
|
|
25
|
+
latest_state: null
|
|
24
26
|
)
|
|
25
27
|
```
|
|
26
28
|
|
data/docs/Status.md
CHANGED
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **operation_left** | **Integer** | Operations (invoices and validations) left. | [optional] |
|
|
8
8
|
| **signature_left** | **Integer** | Signatures left. | [optional] |
|
|
9
|
+
| **has_active_seat** | **Boolean** | Whether the current API key has an active Desk seat. | [optional] |
|
|
10
|
+
| **is_sub_key** | **Boolean** | Whether the current API key is a sub-key (restricted key). | [optional] |
|
|
9
11
|
|
|
10
12
|
## Example
|
|
11
13
|
|
|
@@ -14,7 +16,9 @@ require 'invoicetronic_sdk'
|
|
|
14
16
|
|
|
15
17
|
instance = Invoicetronic_Sdk::Status.new(
|
|
16
18
|
operation_left: null,
|
|
17
|
-
signature_left: null
|
|
19
|
+
signature_left: null,
|
|
20
|
+
has_active_seat: null,
|
|
21
|
+
is_sub_key: null
|
|
18
22
|
)
|
|
19
23
|
```
|
|
20
24
|
|
data/docs/Update.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
|
| **company_id** | **Integer** | Company id. | [optional] |
|
|
12
12
|
| **send_id** | **Integer** | Send id. This is the id of the sent invoice to which this update refers to. | [optional] |
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
require 'invoicetronic_sdk'
|
|
25
25
|
|
|
26
26
|
instance = Invoicetronic_Sdk::Update.new(
|
|
27
|
-
id:
|
|
27
|
+
id: 0,
|
|
28
28
|
created: null,
|
|
29
29
|
version: null,
|
|
30
30
|
user_id: null,
|
data/docs/WebHook.md
CHANGED
|
@@ -4,16 +4,17 @@
|
|
|
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** |
|
|
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** | Optional company id. If set, the webhook is restricted to events for that company; if omitted, it fires for all companies on the account. | [optional] |
|
|
12
12
|
| **url** | **String** | The url of your application's endpoint that will receive a POST request when the webhook is fired. | |
|
|
13
13
|
| **enabled** | **Boolean** | Whether the webhook is enabled. On creation, this is set to `true`. | [optional] |
|
|
14
14
|
| **secret** | **String** | The secret used to generate webhook signatures, only returned on creation. You should store this value securely and validate it on every call, to ensure that the caller is InvoicetronicApi. | [optional] |
|
|
15
15
|
| **description** | **String** | An optional description. | [optional] |
|
|
16
16
|
| **events** | **Array<String>** | List of events that trigger the webhook. See Invoicetronic.SupportedEvents.Available for a list of valid event names. | [optional] |
|
|
17
|
+
| **failure_notified_at** | **Time** | Timestamp of the last failure notification email sent for this webhook. Set by the notifier service; reset to null on successful delivery. | [optional][readonly] |
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -21,16 +22,17 @@
|
|
|
21
22
|
require 'invoicetronic_sdk'
|
|
22
23
|
|
|
23
24
|
instance = Invoicetronic_Sdk::WebHook.new(
|
|
24
|
-
id:
|
|
25
|
+
id: 0,
|
|
25
26
|
created: null,
|
|
26
27
|
version: null,
|
|
27
28
|
user_id: null,
|
|
28
|
-
company_id:
|
|
29
|
-
url:
|
|
29
|
+
company_id: 1,
|
|
30
|
+
url: https://example.com/webhooks/invoicetronic,
|
|
30
31
|
enabled: null,
|
|
31
|
-
secret:
|
|
32
|
-
description:
|
|
33
|
-
events:
|
|
32
|
+
secret: wh_sec_1a2b3c4d5e6f7g8h9i0j,
|
|
33
|
+
description: Production webhook,
|
|
34
|
+
events: ["send.add","receive.add"],
|
|
35
|
+
failure_notified_at: null
|
|
34
36
|
)
|
|
35
37
|
```
|
|
36
38
|
|
data/docs/WebHookHistory.md
CHANGED
|
@@ -4,13 +4,14 @@
|
|
|
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
|
| **web_hook_id** | **Integer** | Webhook id. | [optional] |
|
|
11
11
|
| **user_id** | **Integer** | User id. | [optional] |
|
|
12
12
|
| **event** | **String** | Event name. | [optional] |
|
|
13
|
-
| **status_code** | **Integer** |
|
|
13
|
+
| **status_code** | **Integer** | HTTP status code returned by the webhook endpoint. A value of 0 means the request could not be completed due to a network error (e.g., DNS resolution failure, connection refused, or timeout). This typically indicates that the endpoint URL is misconfigured or no longer exists. | [optional] |
|
|
14
|
+
| **error** | **String** | Error description, if any. Null when the delivery is successful (2xx). Contains the exception message for network errors (status code 0) or the response body for non-2xx HTTP responses. | [optional] |
|
|
14
15
|
| **date_time** | **Time** | Date and time of the request. | [optional] |
|
|
15
16
|
| **success** | **Boolean** | Whether the request was successful. | [optional][readonly] |
|
|
16
17
|
|
|
@@ -20,13 +21,14 @@
|
|
|
20
21
|
require 'invoicetronic_sdk'
|
|
21
22
|
|
|
22
23
|
instance = Invoicetronic_Sdk::WebHookHistory.new(
|
|
23
|
-
id:
|
|
24
|
+
id: 0,
|
|
24
25
|
created: null,
|
|
25
26
|
version: null,
|
|
26
27
|
web_hook_id: null,
|
|
27
28
|
user_id: null,
|
|
28
29
|
event: null,
|
|
29
30
|
status_code: null,
|
|
31
|
+
error: null,
|
|
30
32
|
date_time: null,
|
|
31
33
|
success: null
|
|
32
34
|
)
|
data/docs/WebhookApi.md
CHANGED
|
@@ -260,7 +260,7 @@ Invoicetronic_Sdk.configure do |config|
|
|
|
260
260
|
end
|
|
261
261
|
|
|
262
262
|
api_instance = Invoicetronic_Sdk::WebhookApi.new
|
|
263
|
-
web_hook = Invoicetronic_Sdk::WebHook.new({url: '
|
|
263
|
+
web_hook = Invoicetronic_Sdk::WebHook.new({url: 'https://example.com/webhooks/invoicetronic'}) # WebHook |
|
|
264
264
|
|
|
265
265
|
begin
|
|
266
266
|
# Add a webhook
|
|
@@ -330,7 +330,7 @@ Invoicetronic_Sdk.configure do |config|
|
|
|
330
330
|
end
|
|
331
331
|
|
|
332
332
|
api_instance = Invoicetronic_Sdk::WebhookApi.new
|
|
333
|
-
web_hook = Invoicetronic_Sdk::WebHook.new({url: '
|
|
333
|
+
web_hook = Invoicetronic_Sdk::WebHook.new({url: 'https://example.com/webhooks/invoicetronic'}) # WebHook |
|
|
334
334
|
|
|
335
335
|
begin
|
|
336
336
|
# Update a webhook
|
data/invoicetronic_sdk.gemspec
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
#The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools. For more information, see [Invoicetronic website][2] [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document: 1.
|
|
8
|
+
The version of the OpenAPI document: 1.12.0
|
|
9
9
|
Contact: info@invoicetronic.com
|
|
10
10
|
Generated by: https://openapi-generator.tech
|
|
11
11
|
Generator version: 7.20.0
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools. For more information, see [Invoicetronic website][2] [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.12.0
|
|
7
7
|
Contact: info@invoicetronic.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.20.0
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools. For more information, see [Invoicetronic website][2] [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.12.0
|
|
7
7
|
Contact: info@invoicetronic.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.20.0
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools. For more information, see [Invoicetronic website][2] [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.12.0
|
|
7
7
|
Contact: info@invoicetronic.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.20.0
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools. For more information, see [Invoicetronic website][2] [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.12.0
|
|
7
7
|
Contact: info@invoicetronic.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.20.0
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools. For more information, see [Invoicetronic website][2] [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.12.0
|
|
7
7
|
Contact: info@invoicetronic.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
Generator version: 7.20.0
|
|
@@ -20,7 +20,7 @@ module Invoicetronic_Sdk
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# List incoming invoices
|
|
23
|
-
# 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/).
|
|
23
|
+
# 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.
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
25
|
# @option opts [Integer] :company_id Company id
|
|
26
26
|
# @option opts [String] :identifier SDI identifier.
|
|
@@ -47,7 +47,7 @@ module Invoicetronic_Sdk
|
|
|
47
47
|
end
|
|
48
48
|
|
|
49
49
|
# List incoming invoices
|
|
50
|
-
# 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/).
|
|
50
|
+
# 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.
|
|
51
51
|
# @param [Hash] opts the optional parameters
|
|
52
52
|
# @option opts [Integer] :company_id Company id
|
|
53
53
|
# @option opts [String] :identifier SDI identifier.
|
|
@@ -131,7 +131,7 @@ module Invoicetronic_Sdk
|
|
|
131
131
|
end
|
|
132
132
|
|
|
133
133
|
# Delete an incoming invoice by id
|
|
134
|
-
# 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/).
|
|
134
|
+
# 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.
|
|
135
135
|
# @param id [Integer] Item id
|
|
136
136
|
# @param [Hash] opts the optional parameters
|
|
137
137
|
# @return [Receive]
|
|
@@ -141,7 +141,7 @@ module Invoicetronic_Sdk
|
|
|
141
141
|
end
|
|
142
142
|
|
|
143
143
|
# Delete an incoming invoice by id
|
|
144
|
-
# 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/).
|
|
144
|
+
# 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.
|
|
145
145
|
# @param id [Integer] Item id
|
|
146
146
|
# @param [Hash] opts the optional parameters
|
|
147
147
|
# @return [Array<(Receive, Integer, Hash)>] Receive data, response status code and response headers
|
|
@@ -194,7 +194,7 @@ module Invoicetronic_Sdk
|
|
|
194
194
|
end
|
|
195
195
|
|
|
196
196
|
# Get an incoming invoice by id
|
|
197
|
-
# 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/).
|
|
197
|
+
# 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.
|
|
198
198
|
# @param id [Integer] Item id
|
|
199
199
|
# @param [Hash] opts the optional parameters
|
|
200
200
|
# @option opts [Boolean] :include_payload Include payload in the response. Defaults to false. (default to false)
|
|
@@ -205,7 +205,7 @@ module Invoicetronic_Sdk
|
|
|
205
205
|
end
|
|
206
206
|
|
|
207
207
|
# Get an incoming invoice by id
|
|
208
|
-
# 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/).
|
|
208
|
+
# 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.
|
|
209
209
|
# @param id [Integer] Item id
|
|
210
210
|
# @param [Hash] opts the optional parameters
|
|
211
211
|
# @option opts [Boolean] :include_payload Include payload in the response. Defaults to false. (default to false)
|