@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
|
@@ -38,7 +38,7 @@ const base_1 = require("../../base");
|
|
|
38
38
|
const UpdateApiAxiosParamCreator = function (configuration) {
|
|
39
39
|
return {
|
|
40
40
|
/**
|
|
41
|
-
* 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.
|
|
41
|
+
* 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.
|
|
42
42
|
* @summary List updates
|
|
43
43
|
* @param {number} [companyId] Company id
|
|
44
44
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -127,7 +127,7 @@ const UpdateApiAxiosParamCreator = function (configuration) {
|
|
|
127
127
|
};
|
|
128
128
|
}),
|
|
129
129
|
/**
|
|
130
|
-
* 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.
|
|
130
|
+
* 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.
|
|
131
131
|
* @summary Get an update by id
|
|
132
132
|
* @param {number} id Item id
|
|
133
133
|
* @param {*} [options] Override http request option.
|
|
@@ -169,7 +169,7 @@ const UpdateApiFp = function (configuration) {
|
|
|
169
169
|
const localVarAxiosParamCreator = (0, exports.UpdateApiAxiosParamCreator)(configuration);
|
|
170
170
|
return {
|
|
171
171
|
/**
|
|
172
|
-
* 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.
|
|
172
|
+
* 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.
|
|
173
173
|
* @summary List updates
|
|
174
174
|
* @param {number} [companyId] Company id
|
|
175
175
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -197,7 +197,7 @@ const UpdateApiFp = function (configuration) {
|
|
|
197
197
|
});
|
|
198
198
|
},
|
|
199
199
|
/**
|
|
200
|
-
* 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.
|
|
200
|
+
* 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.
|
|
201
201
|
* @summary Get an update by id
|
|
202
202
|
* @param {number} id Item id
|
|
203
203
|
* @param {*} [options] Override http request option.
|
|
@@ -222,7 +222,7 @@ const UpdateApiFactory = function (configuration, basePath, axios) {
|
|
|
222
222
|
const localVarFp = (0, exports.UpdateApiFp)(configuration);
|
|
223
223
|
return {
|
|
224
224
|
/**
|
|
225
|
-
* 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.
|
|
225
|
+
* 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.
|
|
226
226
|
* @summary List updates
|
|
227
227
|
* @param {number} [companyId] Company id
|
|
228
228
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -244,7 +244,7 @@ const UpdateApiFactory = function (configuration, basePath, axios) {
|
|
|
244
244
|
return localVarFp.updateGet(companyId, identifier, prestatore, unread, sendId, state, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, page, pageSize, sort, options).then((request) => request(axios, basePath));
|
|
245
245
|
},
|
|
246
246
|
/**
|
|
247
|
-
* 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.
|
|
247
|
+
* 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.
|
|
248
248
|
* @summary Get an update by id
|
|
249
249
|
* @param {number} id Item id
|
|
250
250
|
* @param {*} [options] Override http request option.
|
|
@@ -261,7 +261,7 @@ exports.UpdateApiFactory = UpdateApiFactory;
|
|
|
261
261
|
*/
|
|
262
262
|
class UpdateApi extends base_1.BaseAPI {
|
|
263
263
|
/**
|
|
264
|
-
* 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.
|
|
264
|
+
* 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.
|
|
265
265
|
* @summary List updates
|
|
266
266
|
* @param {number} [companyId] Company id
|
|
267
267
|
* @param {string} [identifier] SDI identifier.
|
|
@@ -283,7 +283,7 @@ class UpdateApi extends base_1.BaseAPI {
|
|
|
283
283
|
return (0, exports.UpdateApiFp)(this.configuration).updateGet(companyId, identifier, prestatore, unread, sendId, state, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, page, pageSize, sort, options).then((request) => request(this.axios, this.basePath));
|
|
284
284
|
}
|
|
285
285
|
/**
|
|
286
|
-
* 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.
|
|
286
|
+
* 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.
|
|
287
287
|
* @summary Get an update by id
|
|
288
288
|
* @param {number} id Item id
|
|
289
289
|
* @param {*} [options] Override http request option.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Invoicetronic API
|
|
3
|
+
* The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools. For more information, see [Invoicetronic website][2] [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1
|
|
6
|
+
* Contact: info@invoicetronic.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export interface DocumentData {
|
|
13
|
+
'number'?: string | null;
|
|
14
|
+
'date'?: string;
|
|
15
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Invoicetronic API
|
|
6
|
+
* The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools. For more information, see [Invoicetronic website][2] [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1
|
|
9
|
+
* Contact: info@invoicetronic.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -1,7 +1,12 @@
|
|
|
1
1
|
export * from './company';
|
|
2
|
+
export * from './document-data';
|
|
2
3
|
export * from './event';
|
|
4
|
+
export * from './model-error';
|
|
5
|
+
export * from './problem-details';
|
|
6
|
+
export * from './problem-http-result';
|
|
3
7
|
export * from './receive';
|
|
4
8
|
export * from './send';
|
|
9
|
+
export * from './send-reduced';
|
|
5
10
|
export * from './status';
|
|
6
11
|
export * from './update';
|
|
7
12
|
export * from './web-hook';
|
package/dist/src/models/index.js
CHANGED
|
@@ -15,9 +15,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./company"), exports);
|
|
18
|
+
__exportStar(require("./document-data"), exports);
|
|
18
19
|
__exportStar(require("./event"), exports);
|
|
20
|
+
__exportStar(require("./model-error"), exports);
|
|
21
|
+
__exportStar(require("./problem-details"), exports);
|
|
22
|
+
__exportStar(require("./problem-http-result"), exports);
|
|
19
23
|
__exportStar(require("./receive"), exports);
|
|
20
24
|
__exportStar(require("./send"), exports);
|
|
25
|
+
__exportStar(require("./send-reduced"), exports);
|
|
21
26
|
__exportStar(require("./status"), exports);
|
|
22
27
|
__exportStar(require("./update"), exports);
|
|
23
28
|
__exportStar(require("./web-hook"), exports);
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Invoicetronic API
|
|
3
|
+
* The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools. For more information, see [Invoicetronic website][2] [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1
|
|
6
|
+
* Contact: info@invoicetronic.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Validation error from the SDI.
|
|
14
|
+
*/
|
|
15
|
+
export interface ModelError {
|
|
16
|
+
/**
|
|
17
|
+
* Error code.
|
|
18
|
+
*/
|
|
19
|
+
'code'?: string | null;
|
|
20
|
+
/**
|
|
21
|
+
* Error description.
|
|
22
|
+
*/
|
|
23
|
+
'description'?: string | null;
|
|
24
|
+
/**
|
|
25
|
+
* Hint on how to solve the issue.
|
|
26
|
+
*/
|
|
27
|
+
'hint'?: string | null;
|
|
28
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Invoicetronic API
|
|
6
|
+
* The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools. For more information, see [Invoicetronic website][2] [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1
|
|
9
|
+
* Contact: info@invoicetronic.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Invoicetronic API
|
|
3
|
+
* The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools. For more information, see [Invoicetronic website][2] [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1
|
|
6
|
+
* Contact: info@invoicetronic.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export interface ProblemDetails {
|
|
13
|
+
[key: string]: any;
|
|
14
|
+
'type'?: string | null;
|
|
15
|
+
'title'?: string | null;
|
|
16
|
+
'status'?: number | null;
|
|
17
|
+
'detail'?: string | null;
|
|
18
|
+
'instance'?: string | null;
|
|
19
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Invoicetronic API
|
|
6
|
+
* The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools. For more information, see [Invoicetronic website][2] [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1
|
|
9
|
+
* Contact: info@invoicetronic.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Invoicetronic API
|
|
3
|
+
* The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools. For more information, see [Invoicetronic website][2] [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1
|
|
6
|
+
* Contact: info@invoicetronic.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { ProblemDetails } from './problem-details';
|
|
13
|
+
export interface ProblemHttpResult {
|
|
14
|
+
'problem_details'?: ProblemDetails;
|
|
15
|
+
'content_type'?: string | null;
|
|
16
|
+
'status_code'?: number;
|
|
17
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Invoicetronic API
|
|
6
|
+
* The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools. For more information, see [Invoicetronic website][2] [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1
|
|
9
|
+
* Contact: info@invoicetronic.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -74,6 +74,10 @@ export interface Receive {
|
|
|
74
74
|
* Whether the payload is Base64 encoded or a plain XML (text).
|
|
75
75
|
*/
|
|
76
76
|
'encoding'?: ReceiveEncodingEnum;
|
|
77
|
+
/**
|
|
78
|
+
* Business name of the prestatore (supplier/seller) extracted from the invoice XML.
|
|
79
|
+
*/
|
|
80
|
+
'nome_prestatore'?: string | null;
|
|
77
81
|
/**
|
|
78
82
|
* Whether the invoice has been read at least once. Set to true only when the invoice is requested with include_payload=true.
|
|
79
83
|
*/
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Invoicetronic API
|
|
3
|
+
* The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools. For more information, see [Invoicetronic website][2] [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1
|
|
6
|
+
* Contact: info@invoicetronic.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { DocumentData } from './document-data';
|
|
13
|
+
/**
|
|
14
|
+
* Reduced Send data for Update responses, containing only the essential fields.
|
|
15
|
+
*/
|
|
16
|
+
export interface SendReduced {
|
|
17
|
+
/**
|
|
18
|
+
* SDI identifier.
|
|
19
|
+
*/
|
|
20
|
+
'identifier'?: string | null;
|
|
21
|
+
/**
|
|
22
|
+
* VAT number of the Cedente/Prestatore (vendor).
|
|
23
|
+
*/
|
|
24
|
+
'prestatore'?: string | null;
|
|
25
|
+
/**
|
|
26
|
+
* Optional metadata, as json.
|
|
27
|
+
*/
|
|
28
|
+
'meta_data'?: {
|
|
29
|
+
[key: string]: string;
|
|
30
|
+
} | null;
|
|
31
|
+
/**
|
|
32
|
+
* The invoices included in the payload.
|
|
33
|
+
*/
|
|
34
|
+
'documents'?: Array<DocumentData> | null;
|
|
35
|
+
/**
|
|
36
|
+
* When the invoice was sent to SDI.
|
|
37
|
+
*/
|
|
38
|
+
'date_sent'?: string | null;
|
|
39
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Invoicetronic API
|
|
6
|
+
* The [Invoicetronic API][2] is a RESTful service that allows you to send and receive invoices through the Italian [Servizio di Interscambio (SDI)][1], or Interchange Service. The API is designed to be simple and easy to use, abstracting away SDI complexity while providing complete control over the invoice send/receive process. It provides advanced features as encryption at rest, multi-language pre-flight invoice validation, multiple upload formats, webhooks, event logging, client SDKs, and CLI tools. For more information, see [Invoicetronic website][2] [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1
|
|
9
|
+
* Contact: info@invoicetronic.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -75,6 +75,10 @@ export interface Send {
|
|
|
75
75
|
* Whether the payload is Base64 encoded or a plain XML (text).
|
|
76
76
|
*/
|
|
77
77
|
'encoding'?: SendEncodingEnum;
|
|
78
|
+
/**
|
|
79
|
+
* Business name of the committente (client/buyer) extracted from the invoice XML.
|
|
80
|
+
*/
|
|
81
|
+
'nome_committente'?: string | null;
|
|
78
82
|
/**
|
|
79
83
|
* Optional metadata, as json.
|
|
80
84
|
*/
|
package/docs/CompanyApi.md
CHANGED
|
@@ -14,7 +14,7 @@ All URIs are relative to *http://localhost*
|
|
|
14
14
|
# **companyGet**
|
|
15
15
|
> Array<Company> companyGet()
|
|
16
16
|
|
|
17
|
-
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.
|
|
17
|
+
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.
|
|
18
18
|
|
|
19
19
|
### Example
|
|
20
20
|
|
|
@@ -30,11 +30,13 @@ const apiInstance = new CompanyApi(configuration);
|
|
|
30
30
|
let page: number; //Page number. (optional) (default to 1)
|
|
31
31
|
let pageSize: number; //Items per page. Cannot be greater than 200. (optional) (default to 100)
|
|
32
32
|
let sort: string; //Sort by field. Prefix with \'-\' for descending order. (optional) (default to undefined)
|
|
33
|
+
let q: string; //Full-text search across committente, prestatore, identifier, and file name. (optional) (default to undefined)
|
|
33
34
|
|
|
34
35
|
const { status, data } = await apiInstance.companyGet(
|
|
35
36
|
page,
|
|
36
37
|
pageSize,
|
|
37
|
-
sort
|
|
38
|
+
sort,
|
|
39
|
+
q
|
|
38
40
|
);
|
|
39
41
|
```
|
|
40
42
|
|
|
@@ -45,6 +47,7 @@ const { status, data } = await apiInstance.companyGet(
|
|
|
45
47
|
| **page** | [**number**] | Page number. | (optional) defaults to 1|
|
|
46
48
|
| **pageSize** | [**number**] | Items per page. Cannot be greater than 200. | (optional) defaults to 100|
|
|
47
49
|
| **sort** | [**string**] | Sort by field. Prefix with \'-\' for descending order. | (optional) defaults to undefined|
|
|
50
|
+
| **q** | [**string**] | Full-text search across committente, prestatore, identifier, and file name. | (optional) defaults to undefined|
|
|
48
51
|
|
|
49
52
|
|
|
50
53
|
### Return type
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# DocumentData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**number** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**date** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { DocumentData } from '@invoicetronic/ts-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: DocumentData = {
|
|
17
|
+
number,
|
|
18
|
+
date,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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/Error.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# ModelError
|
|
2
|
+
|
|
3
|
+
Validation error from the SDI.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**code** | **string** | Error code. | [optional] [default to undefined]
|
|
10
|
+
**description** | **string** | Error description. | [optional] [default to undefined]
|
|
11
|
+
**hint** | **string** | Hint on how to solve the issue. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ModelError } from '@invoicetronic/ts-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: ModelError = {
|
|
19
|
+
code,
|
|
20
|
+
description,
|
|
21
|
+
hint,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[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/ExportApi.md
CHANGED
|
@@ -22,7 +22,7 @@ import {
|
|
|
22
22
|
const configuration = new Configuration();
|
|
23
23
|
const apiInstance = new ExportApi(configuration);
|
|
24
24
|
|
|
25
|
-
let type:
|
|
25
|
+
let type: string; // (optional) (default to undefined)
|
|
26
26
|
let companyId: number; //Company id (optional) (default to undefined)
|
|
27
27
|
let year: number; // (optional) (default to undefined)
|
|
28
28
|
let month: number; // (optional) (default to undefined)
|
|
@@ -45,7 +45,7 @@ const { status, data } = await apiInstance.exportGet(
|
|
|
45
45
|
|
|
46
46
|
|Name | Type | Description | Notes|
|
|
47
47
|
|------------- | ------------- | ------------- | -------------|
|
|
48
|
-
| **type** | [
|
|
48
|
+
| **type** | [**string**] | | (optional) defaults to undefined|
|
|
49
49
|
| **companyId** | [**number**] | Company id | (optional) defaults to undefined|
|
|
50
50
|
| **year** | [**number**] | | (optional) defaults to undefined|
|
|
51
51
|
| **month** | [**number**] | | (optional) defaults to undefined|
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# HealthApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**healthGet**](#healthget) | **GET** /health | Health check|
|
|
8
|
+
|
|
9
|
+
# **healthGet**
|
|
10
|
+
> healthGet()
|
|
11
|
+
|
|
12
|
+
Returns the health status of the API and its dependencies. No authentication required. Rate limited to 12 requests per minute.
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
HealthApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from '@invoicetronic/ts-sdk';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new HealthApi(configuration);
|
|
24
|
+
|
|
25
|
+
const { status, data } = await apiInstance.healthGet();
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Parameters
|
|
29
|
+
This endpoint does not have any parameters.
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### Return type
|
|
33
|
+
|
|
34
|
+
void (empty response body)
|
|
35
|
+
|
|
36
|
+
### Authorization
|
|
37
|
+
|
|
38
|
+
[Basic](../README.md#Basic)
|
|
39
|
+
|
|
40
|
+
### HTTP request headers
|
|
41
|
+
|
|
42
|
+
- **Content-Type**: Not defined
|
|
43
|
+
- **Accept**: Not defined
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### HTTP response details
|
|
47
|
+
| Status code | Description | Response headers |
|
|
48
|
+
|-------------|-------------|------------------|
|
|
49
|
+
|**200** | OK | - |
|
|
50
|
+
|**429** | Too Many Requests | - |
|
|
51
|
+
|**503** | Service Unavailable | - |
|
|
52
|
+
|
|
53
|
+
[[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)
|
|
54
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# ProblemDetails
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**type** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**title** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**status** | **number** | | [optional] [default to undefined]
|
|
11
|
+
**detail** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**instance** | **string** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { ProblemDetails } from '@invoicetronic/ts-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: ProblemDetails = {
|
|
20
|
+
type,
|
|
21
|
+
title,
|
|
22
|
+
status,
|
|
23
|
+
detail,
|
|
24
|
+
instance,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ProblemHttpResult
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**problem_details** | [**ProblemDetails**](ProblemDetails.md) | | [optional] [default to undefined]
|
|
9
|
+
**content_type** | **string** | | [optional] [readonly] [default to undefined]
|
|
10
|
+
**status_code** | **number** | | [optional] [readonly] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ProblemHttpResult } from '@invoicetronic/ts-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: ProblemHttpResult = {
|
|
18
|
+
problem_details,
|
|
19
|
+
content_type,
|
|
20
|
+
status_code,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[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/Receive.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_prestatore** | **string** | Business name of the prestatore (supplier/seller) extracted from the invoice XML. | [optional] [default to undefined]
|
|
24
25
|
**is_read** | **boolean** | Whether the invoice has been read at least once. Set to true only when the invoice is requested with include_payload=true. | [optional] [default to undefined]
|
|
25
26
|
**message_id** | **string** | SDI message id. | [optional] [default to undefined]
|
|
26
27
|
|
|
@@ -45,6 +46,7 @@ const instance: Receive = {
|
|
|
45
46
|
date_sent,
|
|
46
47
|
documents,
|
|
47
48
|
encoding,
|
|
49
|
+
nome_prestatore,
|
|
48
50
|
is_read,
|
|
49
51
|
message_id,
|
|
50
52
|
};
|