@invoicetronic/ts-sdk 1.4.0 → 1.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +1 -1
- package/README.md +2 -2
- package/api.ts +2 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +2 -1
- package/dist/api.js +2 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +2 -1
- package/dist/esm/api.js +2 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/src/api/company-api.d.ts +16 -11
- package/dist/esm/src/api/company-api.js +20 -31
- package/dist/esm/src/api/export-api.d.ts +11 -17
- package/dist/esm/src/api/export-api.js +6 -14
- package/dist/esm/src/api/health-api.d.ts +74 -0
- package/dist/esm/src/api/health-api.js +117 -0
- package/dist/esm/src/api/log-api.d.ts +11 -6
- package/dist/esm/src/api/log-api.js +16 -15
- package/dist/esm/src/api/receive-api.d.ts +16 -11
- package/dist/esm/src/api/receive-api.js +20 -25
- package/dist/esm/src/api/send-api.d.ts +56 -52
- package/dist/esm/src/api/send-api.js +76 -105
- package/dist/esm/src/api/status-api.d.ts +1 -1
- package/dist/esm/src/api/status-api.js +2 -5
- package/dist/esm/src/api/update-api.d.ts +11 -11
- package/dist/esm/src/api/update-api.js +10 -16
- package/dist/esm/src/api/webhook-api.d.ts +1 -1
- package/dist/esm/src/api/webhook-api.js +2 -23
- package/dist/esm/src/models/company.d.ts +1 -1
- package/dist/esm/src/models/company.js +1 -1
- package/dist/esm/src/models/document-data.d.ts +15 -0
- package/dist/esm/src/models/document-data.js +14 -0
- package/dist/esm/src/models/event.d.ts +5 -1
- package/dist/esm/src/models/event.js +1 -1
- package/dist/esm/src/models/index.d.ts +4 -0
- package/dist/esm/src/models/index.js +4 -0
- package/dist/esm/src/models/model-error.d.ts +28 -0
- package/dist/esm/src/models/model-error.js +14 -0
- package/dist/esm/src/models/problem-details.d.ts +19 -0
- package/dist/esm/src/models/problem-details.js +14 -0
- package/dist/esm/src/models/receive.d.ts +6 -2
- package/dist/esm/src/models/receive.js +1 -1
- package/dist/esm/src/models/send-reduced.d.ts +39 -0
- package/dist/esm/src/models/send-reduced.js +14 -0
- package/dist/esm/src/models/send.d.ts +6 -2
- package/dist/esm/src/models/send.js +1 -1
- package/dist/esm/src/models/status.d.ts +1 -1
- package/dist/esm/src/models/status.js +1 -1
- package/dist/esm/src/models/update.d.ts +1 -1
- package/dist/esm/src/models/update.js +1 -1
- package/dist/esm/src/models/web-hook-history.d.ts +1 -1
- package/dist/esm/src/models/web-hook-history.js +1 -1
- package/dist/esm/src/models/web-hook.d.ts +2 -2
- package/dist/esm/src/models/web-hook.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/src/api/company-api.d.ts +16 -11
- package/dist/src/api/company-api.js +19 -30
- package/dist/src/api/export-api.d.ts +11 -17
- package/dist/src/api/export-api.js +6 -14
- package/dist/src/api/health-api.d.ts +74 -0
- package/dist/src/api/health-api.js +124 -0
- package/dist/src/api/log-api.d.ts +11 -6
- package/dist/src/api/log-api.js +15 -14
- package/dist/src/api/receive-api.d.ts +16 -11
- package/dist/src/api/receive-api.js +19 -24
- package/dist/src/api/send-api.d.ts +56 -52
- package/dist/src/api/send-api.js +75 -104
- package/dist/src/api/status-api.d.ts +1 -1
- package/dist/src/api/status-api.js +1 -4
- package/dist/src/api/update-api.d.ts +11 -11
- package/dist/src/api/update-api.js +9 -15
- package/dist/src/api/webhook-api.d.ts +1 -1
- package/dist/src/api/webhook-api.js +1 -22
- package/dist/src/models/company.d.ts +1 -1
- package/dist/src/models/company.js +1 -1
- package/dist/src/models/document-data.d.ts +15 -0
- package/dist/src/models/document-data.js +15 -0
- package/dist/src/models/event.d.ts +5 -1
- package/dist/src/models/event.js +1 -1
- package/dist/src/models/index.d.ts +4 -0
- package/dist/src/models/index.js +4 -0
- package/dist/src/models/model-error.d.ts +28 -0
- package/dist/src/models/model-error.js +15 -0
- package/dist/src/models/problem-details.d.ts +19 -0
- package/dist/src/models/problem-details.js +15 -0
- package/dist/src/models/receive.d.ts +6 -2
- package/dist/src/models/receive.js +1 -1
- package/dist/src/models/send-reduced.d.ts +39 -0
- package/dist/src/models/send-reduced.js +15 -0
- package/dist/src/models/send.d.ts +6 -2
- package/dist/src/models/send.js +1 -1
- package/dist/src/models/status.d.ts +1 -1
- package/dist/src/models/status.js +1 -1
- package/dist/src/models/update.d.ts +1 -1
- package/dist/src/models/update.js +1 -1
- package/dist/src/models/web-hook-history.d.ts +1 -1
- package/dist/src/models/web-hook-history.js +1 -1
- package/dist/src/models/web-hook.d.ts +2 -2
- package/dist/src/models/web-hook.js +1 -1
- package/docs/CompanyApi.md +11 -15
- package/docs/DocumentData.md +22 -0
- package/docs/Error.md +25 -0
- package/docs/Event.md +2 -0
- package/docs/ExportApi.md +3 -3
- package/docs/HealthApi.md +54 -0
- package/docs/LogApi.md +6 -4
- package/docs/ProblemDetails.md +28 -0
- package/docs/Receive.md +3 -1
- package/docs/ReceiveApi.md +9 -10
- package/docs/Send.md +3 -1
- package/docs/SendApi.md +37 -48
- package/docs/SendReduced.md +29 -0
- package/docs/StatusApi.md +1 -1
- package/docs/UpdateApi.md +4 -5
- package/docs/WebHook.md +1 -1
- package/docs/WebhookApi.md +7 -14
- package/index.ts +1 -1
- package/package.json +1 -1
- package/src/api/company-api.ts +23 -40
- package/src/api/export-api.ts +11 -21
- package/src/api/health-api.ts +131 -0
- package/src/api/log-api.ts +18 -19
- package/src/api/receive-api.ts +23 -32
- package/src/api/send-api.ts +87 -130
- package/src/api/status-api.ts +1 -5
- package/src/api/update-api.ts +11 -21
- package/src/api/webhook-api.ts +1 -31
- package/src/models/company.ts +1 -1
- package/src/models/document-data.ts +21 -0
- package/src/models/event.ts +5 -1
- package/src/models/index.ts +4 -0
- package/src/models/model-error.ts +34 -0
- package/src/models/problem-details.ts +26 -0
- package/src/models/receive.ts +6 -2
- package/src/models/send-reduced.ts +45 -0
- package/src/models/send.ts +6 -2
- package/src/models/status.ts +1 -1
- package/src/models/update.ts +1 -1
- package/src/models/web-hook-history.ts +1 -1
- package/src/models/web-hook.ts +2 -2
package/docs/ReceiveApi.md
CHANGED
|
@@ -12,7 +12,7 @@ All URIs are relative to *http://localhost*
|
|
|
12
12
|
# **receiveGet**
|
|
13
13
|
> Array<Receive> receiveGet()
|
|
14
14
|
|
|
15
|
-
Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, and
|
|
15
|
+
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/).
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -42,6 +42,7 @@ let includePayload: boolean; //Include payload in the response. Defaults to fals
|
|
|
42
42
|
let page: number; //Page number. (optional) (default to 1)
|
|
43
43
|
let pageSize: number; //Items per page. Cannot be greater than 200. (optional) (default to 100)
|
|
44
44
|
let sort: string; //Sort by field. Prefix with \'-\' for descending order. (optional) (default to undefined)
|
|
45
|
+
let q: string; //Full-text search across committente, prestatore, identifier, and file name. (optional) (default to undefined)
|
|
45
46
|
|
|
46
47
|
const { status, data } = await apiInstance.receiveGet(
|
|
47
48
|
companyId,
|
|
@@ -60,7 +61,8 @@ const { status, data } = await apiInstance.receiveGet(
|
|
|
60
61
|
includePayload,
|
|
61
62
|
page,
|
|
62
63
|
pageSize,
|
|
63
|
-
sort
|
|
64
|
+
sort,
|
|
65
|
+
q
|
|
64
66
|
);
|
|
65
67
|
```
|
|
66
68
|
|
|
@@ -85,6 +87,7 @@ const { status, data } = await apiInstance.receiveGet(
|
|
|
85
87
|
| **page** | [**number**] | Page number. | (optional) defaults to 1|
|
|
86
88
|
| **pageSize** | [**number**] | Items per page. Cannot be greater than 200. | (optional) defaults to 100|
|
|
87
89
|
| **sort** | [**string**] | Sort by field. Prefix with \'-\' for descending order. | (optional) defaults to undefined|
|
|
90
|
+
| **q** | [**string**] | Full-text search across committente, prestatore, identifier, and file name. | (optional) defaults to undefined|
|
|
88
91
|
|
|
89
92
|
|
|
90
93
|
### Return type
|
|
@@ -93,7 +96,7 @@ const { status, data } = await apiInstance.receiveGet(
|
|
|
93
96
|
|
|
94
97
|
### Authorization
|
|
95
98
|
|
|
96
|
-
|
|
99
|
+
No authorization required
|
|
97
100
|
|
|
98
101
|
### HTTP request headers
|
|
99
102
|
|
|
@@ -106,7 +109,6 @@ const { status, data } = await apiInstance.receiveGet(
|
|
|
106
109
|
|-------------|-------------|------------------|
|
|
107
110
|
|**200** | OK | - |
|
|
108
111
|
|**404** | Not Found | - |
|
|
109
|
-
|**400** | Bad Request | - |
|
|
110
112
|
|
|
111
113
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
112
114
|
|
|
@@ -146,7 +148,7 @@ const { status, data } = await apiInstance.receiveIdDelete(
|
|
|
146
148
|
|
|
147
149
|
### Authorization
|
|
148
150
|
|
|
149
|
-
|
|
151
|
+
No authorization required
|
|
150
152
|
|
|
151
153
|
### HTTP request headers
|
|
152
154
|
|
|
@@ -158,9 +160,6 @@ const { status, data } = await apiInstance.receiveIdDelete(
|
|
|
158
160
|
| Status code | Description | Response headers |
|
|
159
161
|
|-------------|-------------|------------------|
|
|
160
162
|
|**200** | OK | - |
|
|
161
|
-
|**422** | Unprocessable Content | - |
|
|
162
|
-
|**400** | Bad Request | - |
|
|
163
|
-
|**409** | Conflict | - |
|
|
164
163
|
|**404** | Not Found | - |
|
|
165
164
|
|
|
166
165
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
@@ -204,7 +203,7 @@ const { status, data } = await apiInstance.receiveIdGet(
|
|
|
204
203
|
|
|
205
204
|
### Authorization
|
|
206
205
|
|
|
207
|
-
|
|
206
|
+
No authorization required
|
|
208
207
|
|
|
209
208
|
### HTTP request headers
|
|
210
209
|
|
|
@@ -256,7 +255,7 @@ void (empty response body)
|
|
|
256
255
|
|
|
257
256
|
### Authorization
|
|
258
257
|
|
|
259
|
-
|
|
258
|
+
No authorization required
|
|
260
259
|
|
|
261
260
|
### HTTP request headers
|
|
262
261
|
|
package/docs/Send.md
CHANGED
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**created** | **string** | Creation date. It is set automatically. | [optional] [default to undefined]
|
|
11
11
|
**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [default to undefined]
|
|
12
12
|
**user_id** | **number** | User id. | [optional] [default to undefined]
|
|
13
|
-
**company_id** | **number** | Company id. On send, this is the sender and must be set in advance. On receive, it will be
|
|
13
|
+
**company_id** | **number** | Company id. On send, this is the sender and must be set in advance. On receive, it will be automatically set based on the recipient\'s VAT number. If a matching company is not found, the invoice will be rejected until the company is created. | [optional] [default to undefined]
|
|
14
14
|
**committente** | **string** | VAT number of the Cessionario/Committente (customer). This is automatically set based on the recipient\'s VAT number. | [optional] [default to undefined]
|
|
15
15
|
**prestatore** | **string** | VAT number of the Cedente/Prestatore (vendor). This is automatically set based on the sender\'s VAT number. | [optional] [default to undefined]
|
|
16
16
|
**identifier** | **string** | SDI identifier. This is set by the SDI and is guaranteed to be unique within the SDI system. | [optional] [default to undefined]
|
|
@@ -21,6 +21,7 @@ Name | Type | Description | Notes
|
|
|
21
21
|
**date_sent** | **string** | When the invoice was sent to SDI. | [optional] [default to undefined]
|
|
22
22
|
**documents** | [**Array<DocumentData>**](DocumentData.md) | The invoices included in the payload. This is set by the system, based on the xml content. | [optional] [default to undefined]
|
|
23
23
|
**encoding** | **string** | Whether the payload is Base64 encoded or a plain XML (text). | [optional] [default to undefined]
|
|
24
|
+
**nome_committente** | **string** | Business name of the committente (client/buyer) extracted from the invoice XML. | [optional] [default to undefined]
|
|
24
25
|
**meta_data** | **{ [key: string]: string; }** | Optional metadata, as json. | [optional] [default to undefined]
|
|
25
26
|
**company** | [**Company**](Company.md) | | [optional] [default to undefined]
|
|
26
27
|
|
|
@@ -45,6 +46,7 @@ const instance: Send = {
|
|
|
45
46
|
date_sent,
|
|
46
47
|
documents,
|
|
47
48
|
encoding,
|
|
49
|
+
nome_committente,
|
|
48
50
|
meta_data,
|
|
49
51
|
company,
|
|
50
52
|
};
|
package/docs/SendApi.md
CHANGED
|
@@ -59,7 +59,7 @@ const { status, data } = await apiInstance.sendFilePost(
|
|
|
59
59
|
|
|
60
60
|
### Authorization
|
|
61
61
|
|
|
62
|
-
|
|
62
|
+
No authorization required
|
|
63
63
|
|
|
64
64
|
### HTTP request headers
|
|
65
65
|
|
|
@@ -71,7 +71,6 @@ const { status, data } = await apiInstance.sendFilePost(
|
|
|
71
71
|
| Status code | Description | Response headers |
|
|
72
72
|
|-------------|-------------|------------------|
|
|
73
73
|
|**201** | Created | - |
|
|
74
|
-
|**400** | Bad Request | - |
|
|
75
74
|
|**422** | Unprocessable Content | - |
|
|
76
75
|
|
|
77
76
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
@@ -79,7 +78,7 @@ const { status, data } = await apiInstance.sendFilePost(
|
|
|
79
78
|
# **sendGet**
|
|
80
79
|
> Array<Send> sendGet()
|
|
81
80
|
|
|
82
|
-
Retrieve a paginated list of send invoices. Results can be filtered by various criteria such as company, date ranges, and
|
|
81
|
+
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/).
|
|
83
82
|
|
|
84
83
|
### Example
|
|
85
84
|
|
|
@@ -108,6 +107,7 @@ let includePayload: boolean; //Include payload in the response. Defaults to fals
|
|
|
108
107
|
let page: number; //Page number. (optional) (default to 1)
|
|
109
108
|
let pageSize: number; //Items per page. Cannot be greater than 200. (optional) (default to 100)
|
|
110
109
|
let sort: string; //Sort by field. Prefix with \'-\' for descending order. (optional) (default to undefined)
|
|
110
|
+
let q: string; //Full-text search across committente, prestatore, identifier, and file name. (optional) (default to undefined)
|
|
111
111
|
|
|
112
112
|
const { status, data } = await apiInstance.sendGet(
|
|
113
113
|
companyId,
|
|
@@ -125,7 +125,8 @@ const { status, data } = await apiInstance.sendGet(
|
|
|
125
125
|
includePayload,
|
|
126
126
|
page,
|
|
127
127
|
pageSize,
|
|
128
|
-
sort
|
|
128
|
+
sort,
|
|
129
|
+
q
|
|
129
130
|
);
|
|
130
131
|
```
|
|
131
132
|
|
|
@@ -149,6 +150,7 @@ const { status, data } = await apiInstance.sendGet(
|
|
|
149
150
|
| **page** | [**number**] | Page number. | (optional) defaults to 1|
|
|
150
151
|
| **pageSize** | [**number**] | Items per page. Cannot be greater than 200. | (optional) defaults to 100|
|
|
151
152
|
| **sort** | [**string**] | Sort by field. Prefix with \'-\' for descending order. | (optional) defaults to undefined|
|
|
153
|
+
| **q** | [**string**] | Full-text search across committente, prestatore, identifier, and file name. | (optional) defaults to undefined|
|
|
152
154
|
|
|
153
155
|
|
|
154
156
|
### Return type
|
|
@@ -157,7 +159,7 @@ const { status, data } = await apiInstance.sendGet(
|
|
|
157
159
|
|
|
158
160
|
### Authorization
|
|
159
161
|
|
|
160
|
-
|
|
162
|
+
No authorization required
|
|
161
163
|
|
|
162
164
|
### HTTP request headers
|
|
163
165
|
|
|
@@ -170,7 +172,6 @@ const { status, data } = await apiInstance.sendGet(
|
|
|
170
172
|
|-------------|-------------|------------------|
|
|
171
173
|
|**200** | OK | - |
|
|
172
174
|
|**404** | Not Found | - |
|
|
173
|
-
|**400** | Bad Request | - |
|
|
174
175
|
|
|
175
176
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
176
177
|
|
|
@@ -213,7 +214,7 @@ const { status, data } = await apiInstance.sendIdGet(
|
|
|
213
214
|
|
|
214
215
|
### Authorization
|
|
215
216
|
|
|
216
|
-
|
|
217
|
+
No authorization required
|
|
217
218
|
|
|
218
219
|
### HTTP request headers
|
|
219
220
|
|
|
@@ -265,7 +266,7 @@ void (empty response body)
|
|
|
265
266
|
|
|
266
267
|
### Authorization
|
|
267
268
|
|
|
268
|
-
|
|
269
|
+
No authorization required
|
|
269
270
|
|
|
270
271
|
### HTTP request headers
|
|
271
272
|
|
|
@@ -320,7 +321,7 @@ const { status, data } = await apiInstance.sendIdentifierGet(
|
|
|
320
321
|
|
|
321
322
|
### Authorization
|
|
322
323
|
|
|
323
|
-
|
|
324
|
+
No authorization required
|
|
324
325
|
|
|
325
326
|
### HTTP request headers
|
|
326
327
|
|
|
@@ -333,12 +334,11 @@ const { status, data } = await apiInstance.sendIdentifierGet(
|
|
|
333
334
|
|-------------|-------------|------------------|
|
|
334
335
|
|**200** | OK | - |
|
|
335
336
|
|**404** | Not Found | - |
|
|
336
|
-
|**400** | Bad Request | - |
|
|
337
337
|
|
|
338
338
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
339
339
|
|
|
340
340
|
# **sendJsonPost**
|
|
341
|
-
> Send sendJsonPost(
|
|
341
|
+
> Send sendJsonPost(body)
|
|
342
342
|
|
|
343
343
|
Add a new invoice using a FatturaPA JSON representation. The invoice will be signed (if requested), validated (if requested), and queued for delivery to SDI. Status updates from SDI will be available in the `update` endpoint. **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/). You can also upload invoices via the [Dashboard](https://dashboard.invoicetronic.com).
|
|
344
344
|
|
|
@@ -347,19 +347,18 @@ Add a new invoice using a FatturaPA JSON representation. The invoice will be sig
|
|
|
347
347
|
```typescript
|
|
348
348
|
import {
|
|
349
349
|
SendApi,
|
|
350
|
-
Configuration
|
|
351
|
-
FatturaOrdinaria
|
|
350
|
+
Configuration
|
|
352
351
|
} from '@invoicetronic/ts-sdk';
|
|
353
352
|
|
|
354
353
|
const configuration = new Configuration();
|
|
355
354
|
const apiInstance = new SendApi(configuration);
|
|
356
355
|
|
|
357
|
-
let
|
|
356
|
+
let body: object; //
|
|
358
357
|
let validate: boolean; //Validate the document first, and reject it on failure. (optional) (default to false)
|
|
359
358
|
let signature: 'None' | 'Apply' | 'Force' | 'Auto'; //Whether to digitally sign the document. (optional) (default to 'Auto')
|
|
360
359
|
|
|
361
360
|
const { status, data } = await apiInstance.sendJsonPost(
|
|
362
|
-
|
|
361
|
+
body,
|
|
363
362
|
validate,
|
|
364
363
|
signature
|
|
365
364
|
);
|
|
@@ -369,7 +368,7 @@ const { status, data } = await apiInstance.sendJsonPost(
|
|
|
369
368
|
|
|
370
369
|
|Name | Type | Description | Notes|
|
|
371
370
|
|------------- | ------------- | ------------- | -------------|
|
|
372
|
-
| **
|
|
371
|
+
| **body** | **object**| | |
|
|
373
372
|
| **validate** | [**boolean**] | Validate the document first, and reject it on failure. | (optional) defaults to false|
|
|
374
373
|
| **signature** | [**'None' | 'Apply' | 'Force' | 'Auto'**]**Array<'None' | 'Apply' | 'Force' | 'Auto'>** | Whether to digitally sign the document. | (optional) defaults to 'Auto'|
|
|
375
374
|
|
|
@@ -380,7 +379,7 @@ const { status, data } = await apiInstance.sendJsonPost(
|
|
|
380
379
|
|
|
381
380
|
### Authorization
|
|
382
381
|
|
|
383
|
-
|
|
382
|
+
No authorization required
|
|
384
383
|
|
|
385
384
|
### HTTP request headers
|
|
386
385
|
|
|
@@ -392,7 +391,6 @@ const { status, data } = await apiInstance.sendJsonPost(
|
|
|
392
391
|
| Status code | Description | Response headers |
|
|
393
392
|
|-------------|-------------|------------------|
|
|
394
393
|
|**201** | Created | - |
|
|
395
|
-
|**400** | Bad Request | - |
|
|
396
394
|
|**422** | Unprocessable Content | - |
|
|
397
395
|
|
|
398
396
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
@@ -440,7 +438,7 @@ const { status, data } = await apiInstance.sendPost(
|
|
|
440
438
|
|
|
441
439
|
### Authorization
|
|
442
440
|
|
|
443
|
-
|
|
441
|
+
No authorization required
|
|
444
442
|
|
|
445
443
|
### HTTP request headers
|
|
446
444
|
|
|
@@ -452,7 +450,6 @@ const { status, data } = await apiInstance.sendPost(
|
|
|
452
450
|
| Status code | Description | Response headers |
|
|
453
451
|
|-------------|-------------|------------------|
|
|
454
452
|
|**201** | Created | - |
|
|
455
|
-
|**400** | Bad Request | - |
|
|
456
453
|
|**422** | Unprocessable Content | - |
|
|
457
454
|
|
|
458
455
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
@@ -493,7 +490,7 @@ void (empty response body)
|
|
|
493
490
|
|
|
494
491
|
### Authorization
|
|
495
492
|
|
|
496
|
-
|
|
493
|
+
No authorization required
|
|
497
494
|
|
|
498
495
|
### HTTP request headers
|
|
499
496
|
|
|
@@ -505,13 +502,12 @@ void (empty response body)
|
|
|
505
502
|
| Status code | Description | Response headers |
|
|
506
503
|
|-------------|-------------|------------------|
|
|
507
504
|
|**204** | No Content | - |
|
|
508
|
-
|**400** | Bad Request | - |
|
|
509
505
|
|**422** | Unprocessable Content | - |
|
|
510
506
|
|
|
511
507
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
512
508
|
|
|
513
509
|
# **sendValidateJsonPost**
|
|
514
|
-
> sendValidateJsonPost(
|
|
510
|
+
> sendValidateJsonPost(body)
|
|
515
511
|
|
|
516
512
|
Validate a JSON invoice without sending it to SDI. Use this to check for errors before actual submission. Returns validation results with any errors found. **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/).
|
|
517
513
|
|
|
@@ -520,17 +516,16 @@ Validate a JSON invoice without sending it to SDI. Use this to check for errors
|
|
|
520
516
|
```typescript
|
|
521
517
|
import {
|
|
522
518
|
SendApi,
|
|
523
|
-
Configuration
|
|
524
|
-
FatturaOrdinaria
|
|
519
|
+
Configuration
|
|
525
520
|
} from '@invoicetronic/ts-sdk';
|
|
526
521
|
|
|
527
522
|
const configuration = new Configuration();
|
|
528
523
|
const apiInstance = new SendApi(configuration);
|
|
529
524
|
|
|
530
|
-
let
|
|
525
|
+
let body: object; //
|
|
531
526
|
|
|
532
527
|
const { status, data } = await apiInstance.sendValidateJsonPost(
|
|
533
|
-
|
|
528
|
+
body
|
|
534
529
|
);
|
|
535
530
|
```
|
|
536
531
|
|
|
@@ -538,7 +533,7 @@ const { status, data } = await apiInstance.sendValidateJsonPost(
|
|
|
538
533
|
|
|
539
534
|
|Name | Type | Description | Notes|
|
|
540
535
|
|------------- | ------------- | ------------- | -------------|
|
|
541
|
-
| **
|
|
536
|
+
| **body** | **object**| | |
|
|
542
537
|
|
|
543
538
|
|
|
544
539
|
### Return type
|
|
@@ -547,7 +542,7 @@ void (empty response body)
|
|
|
547
542
|
|
|
548
543
|
### Authorization
|
|
549
544
|
|
|
550
|
-
|
|
545
|
+
No authorization required
|
|
551
546
|
|
|
552
547
|
### HTTP request headers
|
|
553
548
|
|
|
@@ -559,7 +554,6 @@ void (empty response body)
|
|
|
559
554
|
| Status code | Description | Response headers |
|
|
560
555
|
|-------------|-------------|------------------|
|
|
561
556
|
|**204** | No Content | - |
|
|
562
|
-
|**400** | Bad Request | - |
|
|
563
557
|
|**422** | Unprocessable Content | - |
|
|
564
558
|
|
|
565
559
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
@@ -601,7 +595,7 @@ void (empty response body)
|
|
|
601
595
|
|
|
602
596
|
### Authorization
|
|
603
597
|
|
|
604
|
-
|
|
598
|
+
No authorization required
|
|
605
599
|
|
|
606
600
|
### HTTP request headers
|
|
607
601
|
|
|
@@ -613,13 +607,12 @@ void (empty response body)
|
|
|
613
607
|
| Status code | Description | Response headers |
|
|
614
608
|
|-------------|-------------|------------------|
|
|
615
609
|
|**204** | No Content | - |
|
|
616
|
-
|**400** | Bad Request | - |
|
|
617
610
|
|**422** | Unprocessable Content | - |
|
|
618
611
|
|
|
619
612
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
620
613
|
|
|
621
614
|
# **sendValidateXmlPost**
|
|
622
|
-
> sendValidateXmlPost(
|
|
615
|
+
> sendValidateXmlPost(body)
|
|
623
616
|
|
|
624
617
|
Validate an XML invoice document without sending it to SDI. Use this to check for errors before actual submission. Returns validation results with any errors found. **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/).
|
|
625
618
|
|
|
@@ -628,17 +621,16 @@ Validate an XML invoice document without sending it to SDI. Use this to check fo
|
|
|
628
621
|
```typescript
|
|
629
622
|
import {
|
|
630
623
|
SendApi,
|
|
631
|
-
Configuration
|
|
632
|
-
FatturaOrdinaria
|
|
624
|
+
Configuration
|
|
633
625
|
} from '@invoicetronic/ts-sdk';
|
|
634
626
|
|
|
635
627
|
const configuration = new Configuration();
|
|
636
628
|
const apiInstance = new SendApi(configuration);
|
|
637
629
|
|
|
638
|
-
let
|
|
630
|
+
let body: object; //
|
|
639
631
|
|
|
640
632
|
const { status, data } = await apiInstance.sendValidateXmlPost(
|
|
641
|
-
|
|
633
|
+
body
|
|
642
634
|
);
|
|
643
635
|
```
|
|
644
636
|
|
|
@@ -646,7 +638,7 @@ const { status, data } = await apiInstance.sendValidateXmlPost(
|
|
|
646
638
|
|
|
647
639
|
|Name | Type | Description | Notes|
|
|
648
640
|
|------------- | ------------- | ------------- | -------------|
|
|
649
|
-
| **
|
|
641
|
+
| **body** | **object**| | |
|
|
650
642
|
|
|
651
643
|
|
|
652
644
|
### Return type
|
|
@@ -655,7 +647,7 @@ void (empty response body)
|
|
|
655
647
|
|
|
656
648
|
### Authorization
|
|
657
649
|
|
|
658
|
-
|
|
650
|
+
No authorization required
|
|
659
651
|
|
|
660
652
|
### HTTP request headers
|
|
661
653
|
|
|
@@ -667,13 +659,12 @@ void (empty response body)
|
|
|
667
659
|
| Status code | Description | Response headers |
|
|
668
660
|
|-------------|-------------|------------------|
|
|
669
661
|
|**204** | No Content | - |
|
|
670
|
-
|**400** | Bad Request | - |
|
|
671
662
|
|**422** | Unprocessable Content | - |
|
|
672
663
|
|
|
673
664
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
674
665
|
|
|
675
666
|
# **sendXmlPost**
|
|
676
|
-
> Send sendXmlPost(
|
|
667
|
+
> Send sendXmlPost(body)
|
|
677
668
|
|
|
678
669
|
Add a new invoice using a raw XML document in FatturaPA format. The invoice will be signed (if requested), validated (if requested), and queued for delivery to SDI. Status updates from SDI will be available in the `update` endpoint. **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/). You can also upload invoices via the [Dashboard](https://dashboard.invoicetronic.com).
|
|
679
670
|
|
|
@@ -682,19 +673,18 @@ Add a new invoice using a raw XML document in FatturaPA format. The invoice will
|
|
|
682
673
|
```typescript
|
|
683
674
|
import {
|
|
684
675
|
SendApi,
|
|
685
|
-
Configuration
|
|
686
|
-
FatturaOrdinaria
|
|
676
|
+
Configuration
|
|
687
677
|
} from '@invoicetronic/ts-sdk';
|
|
688
678
|
|
|
689
679
|
const configuration = new Configuration();
|
|
690
680
|
const apiInstance = new SendApi(configuration);
|
|
691
681
|
|
|
692
|
-
let
|
|
682
|
+
let body: object; //
|
|
693
683
|
let validate: boolean; //Validate the document first, and reject it on failure. (optional) (default to false)
|
|
694
684
|
let signature: 'None' | 'Apply' | 'Force' | 'Auto'; //Whether to digitally sign the document. (optional) (default to 'Auto')
|
|
695
685
|
|
|
696
686
|
const { status, data } = await apiInstance.sendXmlPost(
|
|
697
|
-
|
|
687
|
+
body,
|
|
698
688
|
validate,
|
|
699
689
|
signature
|
|
700
690
|
);
|
|
@@ -704,7 +694,7 @@ const { status, data } = await apiInstance.sendXmlPost(
|
|
|
704
694
|
|
|
705
695
|
|Name | Type | Description | Notes|
|
|
706
696
|
|------------- | ------------- | ------------- | -------------|
|
|
707
|
-
| **
|
|
697
|
+
| **body** | **object**| | |
|
|
708
698
|
| **validate** | [**boolean**] | Validate the document first, and reject it on failure. | (optional) defaults to false|
|
|
709
699
|
| **signature** | [**'None' | 'Apply' | 'Force' | 'Auto'**]**Array<'None' | 'Apply' | 'Force' | 'Auto'>** | Whether to digitally sign the document. | (optional) defaults to 'Auto'|
|
|
710
700
|
|
|
@@ -715,7 +705,7 @@ const { status, data } = await apiInstance.sendXmlPost(
|
|
|
715
705
|
|
|
716
706
|
### Authorization
|
|
717
707
|
|
|
718
|
-
|
|
708
|
+
No authorization required
|
|
719
709
|
|
|
720
710
|
### HTTP request headers
|
|
721
711
|
|
|
@@ -727,7 +717,6 @@ const { status, data } = await apiInstance.sendXmlPost(
|
|
|
727
717
|
| Status code | Description | Response headers |
|
|
728
718
|
|-------------|-------------|------------------|
|
|
729
719
|
|**201** | Created | - |
|
|
730
|
-
|**400** | Bad Request | - |
|
|
731
720
|
|**422** | Unprocessable Content | - |
|
|
732
721
|
|
|
733
722
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# SendReduced
|
|
2
|
+
|
|
3
|
+
Reduced Send data for Update responses, containing only the essential fields.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**identifier** | **string** | SDI identifier. | [optional] [default to undefined]
|
|
10
|
+
**prestatore** | **string** | VAT number of the Cedente/Prestatore (vendor). | [optional] [default to undefined]
|
|
11
|
+
**meta_data** | **{ [key: string]: string; }** | Optional metadata, as json. | [optional] [default to undefined]
|
|
12
|
+
**documents** | [**Array<DocumentData>**](DocumentData.md) | The invoices included in the payload. | [optional] [default to undefined]
|
|
13
|
+
**date_sent** | **string** | When the invoice was sent to SDI. | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { SendReduced } from '@invoicetronic/ts-sdk';
|
|
19
|
+
|
|
20
|
+
const instance: SendReduced = {
|
|
21
|
+
identifier,
|
|
22
|
+
prestatore,
|
|
23
|
+
meta_data,
|
|
24
|
+
documents,
|
|
25
|
+
date_sent,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/StatusApi.md
CHANGED
package/docs/UpdateApi.md
CHANGED
|
@@ -10,7 +10,7 @@ All URIs are relative to *http://localhost*
|
|
|
10
10
|
# **updateGet**
|
|
11
11
|
> Array<Update> updateGet()
|
|
12
12
|
|
|
13
|
-
Retrieve a paginated list of updates. Results can be filtered by various criteria such as company, send item, SDI state, and date ranges. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
|
|
13
|
+
Retrieve a paginated list of updates. Results can be filtered by various criteria such as company, send item, SDI state, and date ranges. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Cost:** Querying this endpoint is free and does not count as an operation against your plan limits. **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -79,7 +79,7 @@ const { status, data } = await apiInstance.updateGet(
|
|
|
79
79
|
|
|
80
80
|
### Authorization
|
|
81
81
|
|
|
82
|
-
|
|
82
|
+
No authorization required
|
|
83
83
|
|
|
84
84
|
### HTTP request headers
|
|
85
85
|
|
|
@@ -92,14 +92,13 @@ const { status, data } = await apiInstance.updateGet(
|
|
|
92
92
|
|-------------|-------------|------------------|
|
|
93
93
|
|**200** | OK | - |
|
|
94
94
|
|**404** | Not Found | - |
|
|
95
|
-
|**400** | Bad Request | - |
|
|
96
95
|
|
|
97
96
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
98
97
|
|
|
99
98
|
# **updateIdGet**
|
|
100
99
|
> Update updateIdGet()
|
|
101
100
|
|
|
102
|
-
Retrieve an update by its internal id. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
|
|
101
|
+
Retrieve an update by its internal id. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Cost:** Querying this endpoint is free and does not count as an operation against your plan limits. **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
|
|
103
102
|
|
|
104
103
|
### Example
|
|
105
104
|
|
|
@@ -132,7 +131,7 @@ const { status, data } = await apiInstance.updateIdGet(
|
|
|
132
131
|
|
|
133
132
|
### Authorization
|
|
134
133
|
|
|
135
|
-
|
|
134
|
+
No authorization required
|
|
136
135
|
|
|
137
136
|
### HTTP request headers
|
|
138
137
|
|
package/docs/WebHook.md
CHANGED
|
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**enabled** | **boolean** | Whether the webhook is enabled. On creation, this is set to `true`. | [optional] [default to undefined]
|
|
16
16
|
**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] [default to undefined]
|
|
17
17
|
**description** | **string** | An optional description. | [optional] [default to undefined]
|
|
18
|
-
**events** | **Array<string>** | List of events that trigger the webhook.
|
|
18
|
+
**events** | **Array<string>** | List of events that trigger the webhook. See Invoicetronic.SupportedEvents.Available for a list of valid event names. | [optional] [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|