@invoicetronic/ts-sdk 1.4.0 → 1.5.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 +1 -0
- package/configuration.ts +1 -1
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +1 -0
- package/dist/esm/api.js +1 -0
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/src/api/company-api.d.ts +15 -10
- package/dist/esm/src/api/company-api.js +18 -11
- package/dist/esm/src/api/export-api.d.ts +10 -16
- package/dist/esm/src/api/export-api.js +4 -9
- package/dist/esm/src/api/health-api.d.ts +74 -0
- package/dist/esm/src/api/health-api.js +120 -0
- package/dist/esm/src/api/receive-api.d.ts +15 -10
- package/dist/esm/src/api/receive-api.js +18 -11
- package/dist/esm/src/api/send-api.d.ts +55 -51
- package/dist/esm/src/api/send-api.js +74 -67
- package/dist/esm/src/api/update-api.d.ts +10 -10
- package/dist/esm/src/api/update-api.js +8 -8
- 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/index.d.ts +5 -0
- package/dist/esm/src/models/index.js +5 -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/problem-http-result.d.ts +17 -0
- package/dist/esm/src/models/problem-http-result.js +14 -0
- package/dist/esm/src/models/receive.d.ts +4 -0
- 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 +4 -0
- package/dist/src/api/company-api.d.ts +15 -10
- package/dist/src/api/company-api.js +18 -11
- package/dist/src/api/export-api.d.ts +10 -16
- package/dist/src/api/export-api.js +5 -10
- package/dist/src/api/health-api.d.ts +74 -0
- package/dist/src/api/health-api.js +127 -0
- package/dist/src/api/receive-api.d.ts +15 -10
- package/dist/src/api/receive-api.js +18 -11
- package/dist/src/api/send-api.d.ts +55 -51
- package/dist/src/api/send-api.js +74 -67
- package/dist/src/api/update-api.d.ts +10 -10
- package/dist/src/api/update-api.js +8 -8
- package/dist/src/models/document-data.d.ts +15 -0
- package/dist/src/models/document-data.js +15 -0
- package/dist/src/models/index.d.ts +5 -0
- package/dist/src/models/index.js +5 -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/problem-http-result.d.ts +17 -0
- package/dist/src/models/problem-http-result.js +15 -0
- package/dist/src/models/receive.d.ts +4 -0
- 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 +4 -0
- package/docs/CompanyApi.md +5 -2
- package/docs/DocumentData.md +22 -0
- package/docs/Error.md +25 -0
- package/docs/ExportApi.md +2 -2
- package/docs/HealthApi.md +54 -0
- package/docs/ProblemDetails.md +28 -0
- package/docs/ProblemHttpResult.md +24 -0
- package/docs/Receive.md +2 -0
- package/docs/ReceiveApi.md +5 -2
- package/docs/Send.md +2 -0
- package/docs/SendApi.md +25 -26
- package/docs/SendReduced.md +29 -0
- package/docs/UpdateApi.md +2 -2
- package/package.json +1 -1
- package/src/api/company-api.ts +22 -13
- package/src/api/export-api.ts +10 -16
- package/src/api/health-api.ts +135 -0
- package/src/api/receive-api.ts +22 -13
- package/src/api/send-api.ts +86 -79
- package/src/api/update-api.ts +10 -10
- package/src/models/document-data.ts +21 -0
- package/src/models/index.ts +5 -0
- package/src/models/model-error.ts +34 -0
- package/src/models/problem-details.ts +26 -0
- package/src/models/problem-http-result.ts +25 -0
- package/src/models/receive.ts +4 -0
- package/src/models/send-reduced.ts +45 -0
- package/src/models/send.ts +4 -0
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
|
package/docs/Send.md
CHANGED
|
@@ -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
|
@@ -79,7 +79,7 @@ const { status, data } = await apiInstance.sendFilePost(
|
|
|
79
79
|
# **sendGet**
|
|
80
80
|
> Array<Send> sendGet()
|
|
81
81
|
|
|
82
|
-
Retrieve a paginated list of send invoices. Results can be filtered by various criteria such as company, date ranges, and
|
|
82
|
+
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
83
|
|
|
84
84
|
### Example
|
|
85
85
|
|
|
@@ -108,6 +108,7 @@ let includePayload: boolean; //Include payload in the response. Defaults to fals
|
|
|
108
108
|
let page: number; //Page number. (optional) (default to 1)
|
|
109
109
|
let pageSize: number; //Items per page. Cannot be greater than 200. (optional) (default to 100)
|
|
110
110
|
let sort: string; //Sort by field. Prefix with \'-\' for descending order. (optional) (default to undefined)
|
|
111
|
+
let q: string; //Full-text search across committente, prestatore, identifier, and file name. (optional) (default to undefined)
|
|
111
112
|
|
|
112
113
|
const { status, data } = await apiInstance.sendGet(
|
|
113
114
|
companyId,
|
|
@@ -125,7 +126,8 @@ const { status, data } = await apiInstance.sendGet(
|
|
|
125
126
|
includePayload,
|
|
126
127
|
page,
|
|
127
128
|
pageSize,
|
|
128
|
-
sort
|
|
129
|
+
sort,
|
|
130
|
+
q
|
|
129
131
|
);
|
|
130
132
|
```
|
|
131
133
|
|
|
@@ -149,6 +151,7 @@ const { status, data } = await apiInstance.sendGet(
|
|
|
149
151
|
| **page** | [**number**] | Page number. | (optional) defaults to 1|
|
|
150
152
|
| **pageSize** | [**number**] | Items per page. Cannot be greater than 200. | (optional) defaults to 100|
|
|
151
153
|
| **sort** | [**string**] | Sort by field. Prefix with \'-\' for descending order. | (optional) defaults to undefined|
|
|
154
|
+
| **q** | [**string**] | Full-text search across committente, prestatore, identifier, and file name. | (optional) defaults to undefined|
|
|
152
155
|
|
|
153
156
|
|
|
154
157
|
### Return type
|
|
@@ -338,7 +341,7 @@ const { status, data } = await apiInstance.sendIdentifierGet(
|
|
|
338
341
|
[[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
342
|
|
|
340
343
|
# **sendJsonPost**
|
|
341
|
-
> Send sendJsonPost(
|
|
344
|
+
> Send sendJsonPost(body)
|
|
342
345
|
|
|
343
346
|
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
347
|
|
|
@@ -347,19 +350,18 @@ Add a new invoice using a FatturaPA JSON representation. The invoice will be sig
|
|
|
347
350
|
```typescript
|
|
348
351
|
import {
|
|
349
352
|
SendApi,
|
|
350
|
-
Configuration
|
|
351
|
-
FatturaOrdinaria
|
|
353
|
+
Configuration
|
|
352
354
|
} from '@invoicetronic/ts-sdk';
|
|
353
355
|
|
|
354
356
|
const configuration = new Configuration();
|
|
355
357
|
const apiInstance = new SendApi(configuration);
|
|
356
358
|
|
|
357
|
-
let
|
|
359
|
+
let body: object; //
|
|
358
360
|
let validate: boolean; //Validate the document first, and reject it on failure. (optional) (default to false)
|
|
359
361
|
let signature: 'None' | 'Apply' | 'Force' | 'Auto'; //Whether to digitally sign the document. (optional) (default to 'Auto')
|
|
360
362
|
|
|
361
363
|
const { status, data } = await apiInstance.sendJsonPost(
|
|
362
|
-
|
|
364
|
+
body,
|
|
363
365
|
validate,
|
|
364
366
|
signature
|
|
365
367
|
);
|
|
@@ -369,7 +371,7 @@ const { status, data } = await apiInstance.sendJsonPost(
|
|
|
369
371
|
|
|
370
372
|
|Name | Type | Description | Notes|
|
|
371
373
|
|------------- | ------------- | ------------- | -------------|
|
|
372
|
-
| **
|
|
374
|
+
| **body** | **object**| | |
|
|
373
375
|
| **validate** | [**boolean**] | Validate the document first, and reject it on failure. | (optional) defaults to false|
|
|
374
376
|
| **signature** | [**'None' | 'Apply' | 'Force' | 'Auto'**]**Array<'None' | 'Apply' | 'Force' | 'Auto'>** | Whether to digitally sign the document. | (optional) defaults to 'Auto'|
|
|
375
377
|
|
|
@@ -511,7 +513,7 @@ void (empty response body)
|
|
|
511
513
|
[[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
514
|
|
|
513
515
|
# **sendValidateJsonPost**
|
|
514
|
-
> sendValidateJsonPost(
|
|
516
|
+
> sendValidateJsonPost(body)
|
|
515
517
|
|
|
516
518
|
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
519
|
|
|
@@ -520,17 +522,16 @@ Validate a JSON invoice without sending it to SDI. Use this to check for errors
|
|
|
520
522
|
```typescript
|
|
521
523
|
import {
|
|
522
524
|
SendApi,
|
|
523
|
-
Configuration
|
|
524
|
-
FatturaOrdinaria
|
|
525
|
+
Configuration
|
|
525
526
|
} from '@invoicetronic/ts-sdk';
|
|
526
527
|
|
|
527
528
|
const configuration = new Configuration();
|
|
528
529
|
const apiInstance = new SendApi(configuration);
|
|
529
530
|
|
|
530
|
-
let
|
|
531
|
+
let body: object; //
|
|
531
532
|
|
|
532
533
|
const { status, data } = await apiInstance.sendValidateJsonPost(
|
|
533
|
-
|
|
534
|
+
body
|
|
534
535
|
);
|
|
535
536
|
```
|
|
536
537
|
|
|
@@ -538,7 +539,7 @@ const { status, data } = await apiInstance.sendValidateJsonPost(
|
|
|
538
539
|
|
|
539
540
|
|Name | Type | Description | Notes|
|
|
540
541
|
|------------- | ------------- | ------------- | -------------|
|
|
541
|
-
| **
|
|
542
|
+
| **body** | **object**| | |
|
|
542
543
|
|
|
543
544
|
|
|
544
545
|
### Return type
|
|
@@ -619,7 +620,7 @@ void (empty response body)
|
|
|
619
620
|
[[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
621
|
|
|
621
622
|
# **sendValidateXmlPost**
|
|
622
|
-
> sendValidateXmlPost(
|
|
623
|
+
> sendValidateXmlPost(body)
|
|
623
624
|
|
|
624
625
|
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
626
|
|
|
@@ -628,17 +629,16 @@ Validate an XML invoice document without sending it to SDI. Use this to check fo
|
|
|
628
629
|
```typescript
|
|
629
630
|
import {
|
|
630
631
|
SendApi,
|
|
631
|
-
Configuration
|
|
632
|
-
FatturaOrdinaria
|
|
632
|
+
Configuration
|
|
633
633
|
} from '@invoicetronic/ts-sdk';
|
|
634
634
|
|
|
635
635
|
const configuration = new Configuration();
|
|
636
636
|
const apiInstance = new SendApi(configuration);
|
|
637
637
|
|
|
638
|
-
let
|
|
638
|
+
let body: object; //
|
|
639
639
|
|
|
640
640
|
const { status, data } = await apiInstance.sendValidateXmlPost(
|
|
641
|
-
|
|
641
|
+
body
|
|
642
642
|
);
|
|
643
643
|
```
|
|
644
644
|
|
|
@@ -646,7 +646,7 @@ const { status, data } = await apiInstance.sendValidateXmlPost(
|
|
|
646
646
|
|
|
647
647
|
|Name | Type | Description | Notes|
|
|
648
648
|
|------------- | ------------- | ------------- | -------------|
|
|
649
|
-
| **
|
|
649
|
+
| **body** | **object**| | |
|
|
650
650
|
|
|
651
651
|
|
|
652
652
|
### Return type
|
|
@@ -673,7 +673,7 @@ void (empty response body)
|
|
|
673
673
|
[[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
674
|
|
|
675
675
|
# **sendXmlPost**
|
|
676
|
-
> Send sendXmlPost(
|
|
676
|
+
> Send sendXmlPost(body)
|
|
677
677
|
|
|
678
678
|
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
679
|
|
|
@@ -682,19 +682,18 @@ Add a new invoice using a raw XML document in FatturaPA format. The invoice will
|
|
|
682
682
|
```typescript
|
|
683
683
|
import {
|
|
684
684
|
SendApi,
|
|
685
|
-
Configuration
|
|
686
|
-
FatturaOrdinaria
|
|
685
|
+
Configuration
|
|
687
686
|
} from '@invoicetronic/ts-sdk';
|
|
688
687
|
|
|
689
688
|
const configuration = new Configuration();
|
|
690
689
|
const apiInstance = new SendApi(configuration);
|
|
691
690
|
|
|
692
|
-
let
|
|
691
|
+
let body: object; //
|
|
693
692
|
let validate: boolean; //Validate the document first, and reject it on failure. (optional) (default to false)
|
|
694
693
|
let signature: 'None' | 'Apply' | 'Force' | 'Auto'; //Whether to digitally sign the document. (optional) (default to 'Auto')
|
|
695
694
|
|
|
696
695
|
const { status, data } = await apiInstance.sendXmlPost(
|
|
697
|
-
|
|
696
|
+
body,
|
|
698
697
|
validate,
|
|
699
698
|
signature
|
|
700
699
|
);
|
|
@@ -704,7 +703,7 @@ const { status, data } = await apiInstance.sendXmlPost(
|
|
|
704
703
|
|
|
705
704
|
|Name | Type | Description | Notes|
|
|
706
705
|
|------------- | ------------- | ------------- | -------------|
|
|
707
|
-
| **
|
|
706
|
+
| **body** | **object**| | |
|
|
708
707
|
| **validate** | [**boolean**] | Validate the document first, and reject it on failure. | (optional) defaults to false|
|
|
709
708
|
| **signature** | [**'None' | 'Apply' | 'Force' | 'Auto'**]**Array<'None' | 'Apply' | 'Force' | 'Auto'>** | Whether to digitally sign the document. | (optional) defaults to 'Auto'|
|
|
710
709
|
|
|
@@ -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/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
|
|
|
@@ -99,7 +99,7 @@ const { status, data } = await apiInstance.updateGet(
|
|
|
99
99
|
# **updateIdGet**
|
|
100
100
|
> Update updateIdGet()
|
|
101
101
|
|
|
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.
|
|
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. | **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
103
|
|
|
104
104
|
### Example
|
|
105
105
|
|
package/package.json
CHANGED
package/src/api/company-api.ts
CHANGED
|
@@ -36,15 +36,16 @@ import type { ProblemHttpResult } from '../../src/models';
|
|
|
36
36
|
export const CompanyApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
37
37
|
return {
|
|
38
38
|
/**
|
|
39
|
-
* Retrieve a paginated list of companies. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
|
|
39
|
+
* Retrieve a paginated list of companies. Results can be filtered by free-text search (`q`) across name, VAT number, and fiscal code. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
|
|
40
40
|
* @summary List companies
|
|
41
41
|
* @param {number} [page] Page number.
|
|
42
42
|
* @param {number} [pageSize] Items per page. Cannot be greater than 200.
|
|
43
43
|
* @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
|
|
44
|
+
* @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
|
|
44
45
|
* @param {*} [options] Override http request option.
|
|
45
46
|
* @throws {RequiredError}
|
|
46
47
|
*/
|
|
47
|
-
companyGet: async (page?: number, pageSize?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48
|
+
companyGet: async (page?: number, pageSize?: number, sort?: string, q?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48
49
|
const localVarPath = `/company`;
|
|
49
50
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
50
51
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -73,6 +74,10 @@ export const CompanyApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
73
74
|
localVarQueryParameter['sort'] = sort;
|
|
74
75
|
}
|
|
75
76
|
|
|
77
|
+
if (q !== undefined) {
|
|
78
|
+
localVarQueryParameter['q'] = q;
|
|
79
|
+
}
|
|
80
|
+
|
|
76
81
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
77
82
|
|
|
78
83
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -291,16 +296,17 @@ export const CompanyApiFp = function(configuration?: Configuration) {
|
|
|
291
296
|
const localVarAxiosParamCreator = CompanyApiAxiosParamCreator(configuration)
|
|
292
297
|
return {
|
|
293
298
|
/**
|
|
294
|
-
* Retrieve a paginated list of companies. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
|
|
299
|
+
* Retrieve a paginated list of companies. Results can be filtered by free-text search (`q`) across name, VAT number, and fiscal code. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
|
|
295
300
|
* @summary List companies
|
|
296
301
|
* @param {number} [page] Page number.
|
|
297
302
|
* @param {number} [pageSize] Items per page. Cannot be greater than 200.
|
|
298
303
|
* @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
|
|
304
|
+
* @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
|
|
299
305
|
* @param {*} [options] Override http request option.
|
|
300
306
|
* @throws {RequiredError}
|
|
301
307
|
*/
|
|
302
|
-
async companyGet(page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Company>>> {
|
|
303
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.companyGet(page, pageSize, sort, options);
|
|
308
|
+
async companyGet(page?: number, pageSize?: number, sort?: string, q?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Company>>> {
|
|
309
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.companyGet(page, pageSize, sort, q, options);
|
|
304
310
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
305
311
|
const localVarOperationServerBasePath = operationServerMap['CompanyApi.companyGet']?.[localVarOperationServerIndex]?.url;
|
|
306
312
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -381,16 +387,17 @@ export const CompanyApiFactory = function (configuration?: Configuration, basePa
|
|
|
381
387
|
const localVarFp = CompanyApiFp(configuration)
|
|
382
388
|
return {
|
|
383
389
|
/**
|
|
384
|
-
* Retrieve a paginated list of companies. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
|
|
390
|
+
* Retrieve a paginated list of companies. Results can be filtered by free-text search (`q`) across name, VAT number, and fiscal code. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
|
|
385
391
|
* @summary List companies
|
|
386
392
|
* @param {number} [page] Page number.
|
|
387
393
|
* @param {number} [pageSize] Items per page. Cannot be greater than 200.
|
|
388
394
|
* @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
|
|
395
|
+
* @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
|
|
389
396
|
* @param {*} [options] Override http request option.
|
|
390
397
|
* @throws {RequiredError}
|
|
391
398
|
*/
|
|
392
|
-
companyGet(page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Company>> {
|
|
393
|
-
return localVarFp.companyGet(page, pageSize, sort, options).then((request) => request(axios, basePath));
|
|
399
|
+
companyGet(page?: number, pageSize?: number, sort?: string, q?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Company>> {
|
|
400
|
+
return localVarFp.companyGet(page, pageSize, sort, q, options).then((request) => request(axios, basePath));
|
|
394
401
|
},
|
|
395
402
|
/**
|
|
396
403
|
* Delete a company by its internal id. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received. **Warning:** Deleting a company will permanently remove all associated data, including sent invoices, received invoices, invoice updates from SDI, logs, and webhooks. If the company has any linked invoices, you must explicitly confirm deletion by adding `?force=true` to the request. Without this parameter, the API will return `409 Conflict` with details about the linked data.
|
|
@@ -451,15 +458,16 @@ export const CompanyApiFactory = function (configuration?: Configuration, basePa
|
|
|
451
458
|
*/
|
|
452
459
|
export interface CompanyApiInterface {
|
|
453
460
|
/**
|
|
454
|
-
* Retrieve a paginated list of companies. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
|
|
461
|
+
* Retrieve a paginated list of companies. Results can be filtered by free-text search (`q`) across name, VAT number, and fiscal code. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
|
|
455
462
|
* @summary List companies
|
|
456
463
|
* @param {number} [page] Page number.
|
|
457
464
|
* @param {number} [pageSize] Items per page. Cannot be greater than 200.
|
|
458
465
|
* @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
|
|
466
|
+
* @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
|
|
459
467
|
* @param {*} [options] Override http request option.
|
|
460
468
|
* @throws {RequiredError}
|
|
461
469
|
*/
|
|
462
|
-
companyGet(page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Company>>;
|
|
470
|
+
companyGet(page?: number, pageSize?: number, sort?: string, q?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Company>>;
|
|
463
471
|
|
|
464
472
|
/**
|
|
465
473
|
* Delete a company by its internal id. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received. **Warning:** Deleting a company will permanently remove all associated data, including sent invoices, received invoices, invoice updates from SDI, logs, and webhooks. If the company has any linked invoices, you must explicitly confirm deletion by adding `?force=true` to the request. Without this parameter, the API will return `409 Conflict` with details about the linked data.
|
|
@@ -514,16 +522,17 @@ export interface CompanyApiInterface {
|
|
|
514
522
|
*/
|
|
515
523
|
export class CompanyApi extends BaseAPI implements CompanyApiInterface {
|
|
516
524
|
/**
|
|
517
|
-
* Retrieve a paginated list of companies. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
|
|
525
|
+
* Retrieve a paginated list of companies. Results can be filtered by free-text search (`q`) across name, VAT number, and fiscal code. **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
|
|
518
526
|
* @summary List companies
|
|
519
527
|
* @param {number} [page] Page number.
|
|
520
528
|
* @param {number} [pageSize] Items per page. Cannot be greater than 200.
|
|
521
529
|
* @param {string} [sort] Sort by field. Prefix with \'-\' for descending order.
|
|
530
|
+
* @param {string} [q] Full-text search across committente, prestatore, identifier, and file name.
|
|
522
531
|
* @param {*} [options] Override http request option.
|
|
523
532
|
* @throws {RequiredError}
|
|
524
533
|
*/
|
|
525
|
-
public companyGet(page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig) {
|
|
526
|
-
return CompanyApiFp(this.configuration).companyGet(page, pageSize, sort, options).then((request) => request(this.axios, this.basePath));
|
|
534
|
+
public companyGet(page?: number, pageSize?: number, sort?: string, q?: string, options?: RawAxiosRequestConfig) {
|
|
535
|
+
return CompanyApiFp(this.configuration).companyGet(page, pageSize, sort, q, options).then((request) => request(this.axios, this.basePath));
|
|
527
536
|
}
|
|
528
537
|
|
|
529
538
|
/**
|
package/src/api/export-api.ts
CHANGED
|
@@ -34,7 +34,7 @@ export const ExportApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
34
34
|
/**
|
|
35
35
|
* Export invoices as a ZIP archive of FatturaPA XML files, suitable for import into accounting software (TeamSystem, Zucchetti, etc.). **Sent invoices** are only included when they have reached a definitive state (e.g., `Consegnato` for private recipients, `AccettatoDalDestinatario`, `DecorrenzaTermini`, etc.). Invoices still being processed by SDI are excluded. **Received invoices** are always included. Unread invoices are automatically marked as read and counted as operations. ### Period filters You can filter by period using either: - `year` + `month` (e.g., `year=2026&month=3` for March 2026) - `year` + `quarter` (e.g., `year=2026&quarter=1` for Q1 Jan-Mar) - `document_date_from` / `document_date_to` for a custom date range These options are mutually exclusive. The `year` parameter alone is not valid and requires either `month` or `quarter`. ### Response Returns `200` with a ZIP archive, or `204 No Content` if no invoices match the given filters. Files in the archive are organized by company VAT number (`{vat}/send/`, `{vat}/receive/`). ### Rate limiting This endpoint has a dedicated rate limit: only one export request per user can be processed at a time. Concurrent requests will receive a `429 Too Many Requests` response.
|
|
36
36
|
* @summary Export invoices as a ZIP archive
|
|
37
|
-
* @param {
|
|
37
|
+
* @param {string} [type]
|
|
38
38
|
* @param {number} [companyId] Company id
|
|
39
39
|
* @param {number} [year]
|
|
40
40
|
* @param {number} [month]
|
|
@@ -44,7 +44,7 @@ export const ExportApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
44
44
|
* @param {*} [options] Override http request option.
|
|
45
45
|
* @throws {RequiredError}
|
|
46
46
|
*/
|
|
47
|
-
exportGet: async (type?:
|
|
47
|
+
exportGet: async (type?: string, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48
48
|
const localVarPath = `/export`;
|
|
49
49
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
50
50
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -116,7 +116,7 @@ export const ExportApiFp = function(configuration?: Configuration) {
|
|
|
116
116
|
/**
|
|
117
117
|
* Export invoices as a ZIP archive of FatturaPA XML files, suitable for import into accounting software (TeamSystem, Zucchetti, etc.). **Sent invoices** are only included when they have reached a definitive state (e.g., `Consegnato` for private recipients, `AccettatoDalDestinatario`, `DecorrenzaTermini`, etc.). Invoices still being processed by SDI are excluded. **Received invoices** are always included. Unread invoices are automatically marked as read and counted as operations. ### Period filters You can filter by period using either: - `year` + `month` (e.g., `year=2026&month=3` for March 2026) - `year` + `quarter` (e.g., `year=2026&quarter=1` for Q1 Jan-Mar) - `document_date_from` / `document_date_to` for a custom date range These options are mutually exclusive. The `year` parameter alone is not valid and requires either `month` or `quarter`. ### Response Returns `200` with a ZIP archive, or `204 No Content` if no invoices match the given filters. Files in the archive are organized by company VAT number (`{vat}/send/`, `{vat}/receive/`). ### Rate limiting This endpoint has a dedicated rate limit: only one export request per user can be processed at a time. Concurrent requests will receive a `429 Too Many Requests` response.
|
|
118
118
|
* @summary Export invoices as a ZIP archive
|
|
119
|
-
* @param {
|
|
119
|
+
* @param {string} [type]
|
|
120
120
|
* @param {number} [companyId] Company id
|
|
121
121
|
* @param {number} [year]
|
|
122
122
|
* @param {number} [month]
|
|
@@ -126,7 +126,7 @@ export const ExportApiFp = function(configuration?: Configuration) {
|
|
|
126
126
|
* @param {*} [options] Override http request option.
|
|
127
127
|
* @throws {RequiredError}
|
|
128
128
|
*/
|
|
129
|
-
async exportGet(type?:
|
|
129
|
+
async exportGet(type?: string, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
130
130
|
const localVarAxiosArgs = await localVarAxiosParamCreator.exportGet(type, companyId, year, month, quarter, documentDateFrom, documentDateTo, options);
|
|
131
131
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
132
132
|
const localVarOperationServerBasePath = operationServerMap['ExportApi.exportGet']?.[localVarOperationServerIndex]?.url;
|
|
@@ -144,7 +144,7 @@ export const ExportApiFactory = function (configuration?: Configuration, basePat
|
|
|
144
144
|
/**
|
|
145
145
|
* Export invoices as a ZIP archive of FatturaPA XML files, suitable for import into accounting software (TeamSystem, Zucchetti, etc.). **Sent invoices** are only included when they have reached a definitive state (e.g., `Consegnato` for private recipients, `AccettatoDalDestinatario`, `DecorrenzaTermini`, etc.). Invoices still being processed by SDI are excluded. **Received invoices** are always included. Unread invoices are automatically marked as read and counted as operations. ### Period filters You can filter by period using either: - `year` + `month` (e.g., `year=2026&month=3` for March 2026) - `year` + `quarter` (e.g., `year=2026&quarter=1` for Q1 Jan-Mar) - `document_date_from` / `document_date_to` for a custom date range These options are mutually exclusive. The `year` parameter alone is not valid and requires either `month` or `quarter`. ### Response Returns `200` with a ZIP archive, or `204 No Content` if no invoices match the given filters. Files in the archive are organized by company VAT number (`{vat}/send/`, `{vat}/receive/`). ### Rate limiting This endpoint has a dedicated rate limit: only one export request per user can be processed at a time. Concurrent requests will receive a `429 Too Many Requests` response.
|
|
146
146
|
* @summary Export invoices as a ZIP archive
|
|
147
|
-
* @param {
|
|
147
|
+
* @param {string} [type]
|
|
148
148
|
* @param {number} [companyId] Company id
|
|
149
149
|
* @param {number} [year]
|
|
150
150
|
* @param {number} [month]
|
|
@@ -154,7 +154,7 @@ export const ExportApiFactory = function (configuration?: Configuration, basePat
|
|
|
154
154
|
* @param {*} [options] Override http request option.
|
|
155
155
|
* @throws {RequiredError}
|
|
156
156
|
*/
|
|
157
|
-
exportGet(type?:
|
|
157
|
+
exportGet(type?: string, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
158
158
|
return localVarFp.exportGet(type, companyId, year, month, quarter, documentDateFrom, documentDateTo, options).then((request) => request(axios, basePath));
|
|
159
159
|
},
|
|
160
160
|
};
|
|
@@ -167,7 +167,7 @@ export interface ExportApiInterface {
|
|
|
167
167
|
/**
|
|
168
168
|
* Export invoices as a ZIP archive of FatturaPA XML files, suitable for import into accounting software (TeamSystem, Zucchetti, etc.). **Sent invoices** are only included when they have reached a definitive state (e.g., `Consegnato` for private recipients, `AccettatoDalDestinatario`, `DecorrenzaTermini`, etc.). Invoices still being processed by SDI are excluded. **Received invoices** are always included. Unread invoices are automatically marked as read and counted as operations. ### Period filters You can filter by period using either: - `year` + `month` (e.g., `year=2026&month=3` for March 2026) - `year` + `quarter` (e.g., `year=2026&quarter=1` for Q1 Jan-Mar) - `document_date_from` / `document_date_to` for a custom date range These options are mutually exclusive. The `year` parameter alone is not valid and requires either `month` or `quarter`. ### Response Returns `200` with a ZIP archive, or `204 No Content` if no invoices match the given filters. Files in the archive are organized by company VAT number (`{vat}/send/`, `{vat}/receive/`). ### Rate limiting This endpoint has a dedicated rate limit: only one export request per user can be processed at a time. Concurrent requests will receive a `429 Too Many Requests` response.
|
|
169
169
|
* @summary Export invoices as a ZIP archive
|
|
170
|
-
* @param {
|
|
170
|
+
* @param {string} [type]
|
|
171
171
|
* @param {number} [companyId] Company id
|
|
172
172
|
* @param {number} [year]
|
|
173
173
|
* @param {number} [month]
|
|
@@ -177,7 +177,7 @@ export interface ExportApiInterface {
|
|
|
177
177
|
* @param {*} [options] Override http request option.
|
|
178
178
|
* @throws {RequiredError}
|
|
179
179
|
*/
|
|
180
|
-
exportGet(type?:
|
|
180
|
+
exportGet(type?: string, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
181
181
|
|
|
182
182
|
}
|
|
183
183
|
|
|
@@ -188,7 +188,7 @@ export class ExportApi extends BaseAPI implements ExportApiInterface {
|
|
|
188
188
|
/**
|
|
189
189
|
* Export invoices as a ZIP archive of FatturaPA XML files, suitable for import into accounting software (TeamSystem, Zucchetti, etc.). **Sent invoices** are only included when they have reached a definitive state (e.g., `Consegnato` for private recipients, `AccettatoDalDestinatario`, `DecorrenzaTermini`, etc.). Invoices still being processed by SDI are excluded. **Received invoices** are always included. Unread invoices are automatically marked as read and counted as operations. ### Period filters You can filter by period using either: - `year` + `month` (e.g., `year=2026&month=3` for March 2026) - `year` + `quarter` (e.g., `year=2026&quarter=1` for Q1 Jan-Mar) - `document_date_from` / `document_date_to` for a custom date range These options are mutually exclusive. The `year` parameter alone is not valid and requires either `month` or `quarter`. ### Response Returns `200` with a ZIP archive, or `204 No Content` if no invoices match the given filters. Files in the archive are organized by company VAT number (`{vat}/send/`, `{vat}/receive/`). ### Rate limiting This endpoint has a dedicated rate limit: only one export request per user can be processed at a time. Concurrent requests will receive a `429 Too Many Requests` response.
|
|
190
190
|
* @summary Export invoices as a ZIP archive
|
|
191
|
-
* @param {
|
|
191
|
+
* @param {string} [type]
|
|
192
192
|
* @param {number} [companyId] Company id
|
|
193
193
|
* @param {number} [year]
|
|
194
194
|
* @param {number} [month]
|
|
@@ -198,14 +198,8 @@ export class ExportApi extends BaseAPI implements ExportApiInterface {
|
|
|
198
198
|
* @param {*} [options] Override http request option.
|
|
199
199
|
* @throws {RequiredError}
|
|
200
200
|
*/
|
|
201
|
-
public exportGet(type?:
|
|
201
|
+
public exportGet(type?: string, companyId?: number, year?: number, month?: number, quarter?: number, documentDateFrom?: string, documentDateTo?: string, options?: RawAxiosRequestConfig) {
|
|
202
202
|
return ExportApiFp(this.configuration).exportGet(type, companyId, year, month, quarter, documentDateFrom, documentDateTo, options).then((request) => request(this.axios, this.basePath));
|
|
203
203
|
}
|
|
204
204
|
}
|
|
205
205
|
|
|
206
|
-
export const ExportGetTypeEnum = {
|
|
207
|
-
Send: 'Send',
|
|
208
|
-
Receive: 'Receive',
|
|
209
|
-
Both: 'Both'
|
|
210
|
-
} as const;
|
|
211
|
-
export type ExportGetTypeEnum = typeof ExportGetTypeEnum[keyof typeof ExportGetTypeEnum];
|