@invoicetronic/ts-sdk 1.1.7 → 1.3.0

package/dist/src/api/webhook-api.js

@@ -38,7 +38,7 @@ const base_1 = require("../../base");
 const WebhookApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+         * Retrieve a paginated list of webhooks. Results can be filtered by company, description, enabled status, events, and URL.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
          * @summary List webhooks
          * @param {number} [companyId] Company id
          * @param {number} [page] Page number.
@@ -99,7 +99,7 @@ const WebhookApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+         * Delete a webhook subscription by its internal id.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
          * @summary Delete a webhook by id
          * @param {number} id Item id
          * @param {*} [options] Override http request option.
@@ -132,7 +132,7 @@ const WebhookApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+         * Retrieve a webhook by its internal id.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
          * @summary Get a webhook by id
          * @param {number} id Item id
          * @param {*} [options] Override http request option.
@@ -165,7 +165,7 @@ const WebhookApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+         * Create a new webhook subscription.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
          * @summary Add a webhook
          * @param {WebHook} webHook
          * @param {*} [options] Override http request option.
@@ -199,7 +199,7 @@ const WebhookApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+         * Update an existing webhook subscription.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
          * @summary Update a webhook
          * @param {WebHook} webHook
          * @param {*} [options] Override http request option.
@@ -320,7 +320,7 @@ const WebhookApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.WebhookApiAxiosParamCreator)(configuration);
     return {
         /**
-         * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+         * Retrieve a paginated list of webhooks. Results can be filtered by company, description, enabled status, events, and URL.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
          * @summary List webhooks
          * @param {number} [companyId] Company id
          * @param {number} [page] Page number.
@@ -343,7 +343,7 @@ const WebhookApiFp = function (configuration) {
             });
         },
         /**
-         * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+         * Delete a webhook subscription by its internal id.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
          * @summary Delete a webhook by id
          * @param {number} id Item id
          * @param {*} [options] Override http request option.
@@ -359,7 +359,7 @@ const WebhookApiFp = function (configuration) {
             });
         },
         /**
-         * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+         * Retrieve a webhook by its internal id.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
          * @summary Get a webhook by id
          * @param {number} id Item id
          * @param {*} [options] Override http request option.
@@ -375,7 +375,7 @@ const WebhookApiFp = function (configuration) {
             });
         },
         /**
-         * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+         * Create a new webhook subscription.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
          * @summary Add a webhook
          * @param {WebHook} webHook
          * @param {*} [options] Override http request option.
@@ -391,7 +391,7 @@ const WebhookApiFp = function (configuration) {
             });
         },
         /**
-         * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+         * Update an existing webhook subscription.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
          * @summary Update a webhook
          * @param {WebHook} webHook
          * @param {*} [options] Override http request option.
@@ -451,7 +451,7 @@ const WebhookApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.WebhookApiFp)(configuration);
     return {
         /**
-         * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+         * Retrieve a paginated list of webhooks. Results can be filtered by company, description, enabled status, events, and URL.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
          * @summary List webhooks
          * @param {number} [companyId] Company id
          * @param {number} [page] Page number.
@@ -468,7 +468,7 @@ const WebhookApiFactory = function (configuration, basePath, axios) {
             return localVarFp.webhookGet(companyId, page, pageSize, sort, description, enabled, events, url, options).then((request) => request(axios, basePath));
         },
         /**
-         * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+         * Delete a webhook subscription by its internal id.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
          * @summary Delete a webhook by id
          * @param {number} id Item id
          * @param {*} [options] Override http request option.
@@ -478,7 +478,7 @@ const WebhookApiFactory = function (configuration, basePath, axios) {
             return localVarFp.webhookIdDelete(id, options).then((request) => request(axios, basePath));
         },
         /**
-         * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+         * Retrieve a webhook by its internal id.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
          * @summary Get a webhook by id
          * @param {number} id Item id
          * @param {*} [options] Override http request option.
@@ -488,7 +488,7 @@ const WebhookApiFactory = function (configuration, basePath, axios) {
             return localVarFp.webhookIdGet(id, options).then((request) => request(axios, basePath));
         },
         /**
-         * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+         * Create a new webhook subscription.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
          * @summary Add a webhook
          * @param {WebHook} webHook
          * @param {*} [options] Override http request option.
@@ -498,7 +498,7 @@ const WebhookApiFactory = function (configuration, basePath, axios) {
             return localVarFp.webhookPost(webHook, options).then((request) => request(axios, basePath));
         },
         /**
-         * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+         * Update an existing webhook subscription.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
          * @summary Update a webhook
          * @param {WebHook} webHook
          * @param {*} [options] Override http request option.
@@ -538,7 +538,7 @@ exports.WebhookApiFactory = WebhookApiFactory;
  */
 class WebhookApi extends base_1.BaseAPI {
     /**
-     * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+     * Retrieve a paginated list of webhooks. Results can be filtered by company, description, enabled status, events, and URL.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
      * @summary List webhooks
      * @param {number} [companyId] Company id
      * @param {number} [page] Page number.
@@ -555,7 +555,7 @@ class WebhookApi extends base_1.BaseAPI {
         return (0, exports.WebhookApiFp)(this.configuration).webhookGet(companyId, page, pageSize, sort, description, enabled, events, url, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+     * Delete a webhook subscription by its internal id.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
      * @summary Delete a webhook by id
      * @param {number} id Item id
      * @param {*} [options] Override http request option.
@@ -565,7 +565,7 @@ class WebhookApi extends base_1.BaseAPI {
         return (0, exports.WebhookApiFp)(this.configuration).webhookIdDelete(id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+     * Retrieve a webhook by its internal id.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
      * @summary Get a webhook by id
      * @param {number} id Item id
      * @param {*} [options] Override http request option.
@@ -575,7 +575,7 @@ class WebhookApi extends base_1.BaseAPI {
         return (0, exports.WebhookApiFp)(this.configuration).webhookIdGet(id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+     * Create a new webhook subscription.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
      * @summary Add a webhook
      * @param {WebHook} webHook
      * @param {*} [options] Override http request option.
@@ -585,7 +585,7 @@ class WebhookApi extends base_1.BaseAPI {
         return (0, exports.WebhookApiFp)(this.configuration).webhookPost(webHook, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Webhooks are used to notify external services about write events that occur in the API. You can subscribe to specific events and receive a notification when they occur.
+     * Update an existing webhook subscription.  **Webhooks** allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur.  You can also manage webhooks via the [Dashboard](https://dashboard.invoicetronic.com).  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
      * @summary Update a webhook
      * @param {WebHook} webHook
      * @param {*} [options] Override http request option.

package/dist/src/models/event.d.ts

@@ -63,7 +63,7 @@ export interface Event {
      */
     'resource_id'?: number | null;
     /**
-     * Wether the request was successful.
+     * Whether the request was successful.
      */
     'success'?: boolean;
     /**
@@ -71,7 +71,7 @@ export interface Event {
      */
     'query'?: string | null;
     /**
-     * Response payload. It is guaranteed to be cyphered at rest.
+     * Response payload. It is guaranteed to be encrypted at rest.
      */
     'response_body'?: string | null;
 }

package/dist/src/models/receive.d.ts

@@ -40,7 +40,7 @@ export interface Receive {
      */
     'prestatore'?: string | null;
     /**
-     * SDI identifier. This is set by the SDI and is guaranted to be unique within the SDI system.
+     * SDI identifier. This is set by the SDI and is guaranteed to be unique within the SDI system.
      */
     'identifier'?: string | null;
     /**
@@ -52,7 +52,7 @@ export interface Receive {
      */
     'format'?: string | null;
     /**
-     * Xml payloaad. This is the actual xml content, as string. On send, it can be base64 encoded. If it\'s not, it will be encoded before sending. It is guaranteed to be cyphered at rest.
+     * Xml payload. This is the actual xml content, as string. On send, it can be base64 encoded. If it\'s not, it will be encoded before sending. It is guaranteed to be encrypted at rest.
      */
     'payload': string;
     /**
@@ -72,7 +72,7 @@ export interface Receive {
      */
     'encoding'?: ReceiveEncodingEnum;
     /**
-     * Wether the invoice has been read at least once.
+     * Whether the invoice has been read at least once. Set to true only when the invoice is requested with include_payload=true.
      */
     'is_read'?: boolean;
     /**

package/dist/src/models/send.d.ts

@@ -41,7 +41,7 @@ export interface Send {
      */
     'prestatore'?: string | null;
     /**
-     * SDI identifier. This is set by the SDI and is guaranted to be unique within the SDI system.
+     * SDI identifier. This is set by the SDI and is guaranteed to be unique within the SDI system.
      */
     'identifier'?: string | null;
     /**
@@ -53,7 +53,7 @@ export interface Send {
      */
     'format'?: string | null;
     /**
-     * Xml payloaad. This is the actual xml content, as string. On send, it can be base64 encoded. If it\'s not, it will be encoded before sending. It is guaranteed to be cyphered at rest.
+     * Xml payload. This is the actual xml content, as string. On send, it can be base64 encoded. If it\'s not, it will be encoded before sending. It is guaranteed to be encrypted at rest.
      */
     'payload': string;
     /**

package/dist/src/models/update.d.ts

@@ -40,7 +40,7 @@ export interface Update {
      */
     'last_update'?: string;
     /**
-     * State of the document. Theses are the possible values, as per the SDI documentation:
+     * State of the document. These are the possible values, as per the SDI documentation:
      */
     'state'?: UpdateStateEnum;
     /**
@@ -56,7 +56,7 @@ export interface Update {
      */
     'errors'?: Array<Error> | null;
     /**
-     * Wether the item has been read at least once.
+     * Whether the item has been read at least once.
      */
     'is_read'?: boolean;
     'send'?: SendReduced;

package/dist/src/models/web-hook-history.d.ts

@@ -46,7 +46,7 @@ export interface WebHookHistory {
      */
     'date_time'?: string;
     /**
-     * Wether the request was successful.
+     * Whether the request was successful.
      */
     'success'?: boolean;
 }

package/dist/src/models/web-hook.d.ts

@@ -35,7 +35,7 @@ export interface WebHook {
      */
     'url': string;
     /**
-     * Wether the webhook is enabled. On creation, this is set to `true`.
+     * Whether the webhook is enabled. On creation, this is set to `true`.
      */
     'enabled'?: boolean;
     /**
@@ -47,7 +47,7 @@ export interface WebHook {
      */
     'description'?: string | null;
     /**
-     * List of events to that trigger the webhook.  See Invoicetronic.SupportedEvents.Available for a list of valid event names.
+     * List of events that trigger the webhook.  See Invoicetronic.SupportedEvents.Available for a list of valid event names.
      */
     'events'?: Array<string> | null;
 }

package/docs/CompanyApi.md

@@ -13,7 +13,7 @@ All URIs are relative to *http://localhost*
 # **companyGet**
 > Array<Company> companyGet()
 
-Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+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.
 
 ### Example
 
@@ -72,7 +72,7 @@ const { status, data } = await apiInstance.companyGet(
 # **companyIdDelete**
 > Company companyIdDelete()
 
-Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+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.
 
 ### Example
 
@@ -86,9 +86,11 @@ const configuration = new Configuration();
 const apiInstance = new CompanyApi(configuration);
 
 let id: number; //Item id (default to undefined)
+let force: boolean; //Force delete including all related data. (optional) (default to false)
 
 const { status, data } = await apiInstance.companyIdDelete(
-    id
+    id,
+    force
 );
 ```
 
@@ -97,6 +99,7 @@ const { status, data } = await apiInstance.companyIdDelete(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **id** | [**number**] | Item id | defaults to undefined|
+| **force** | [**boolean**] | Force delete including all related data. | (optional) defaults to false|
 
 
 ### Return type
@@ -119,6 +122,7 @@ const { status, data } = await apiInstance.companyIdDelete(
 |**200** | OK |  -  |
 |**422** | Unprocessable Content |  -  |
 |**400** | Bad Request |  -  |
+|**409** | Conflict |  -  |
 |**404** | Not Found |  -  |
 
 [[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)
@@ -126,7 +130,7 @@ const { status, data } = await apiInstance.companyIdDelete(
 # **companyIdGet**
 > Company companyIdGet()
 
-Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+Retrieve 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.
 
 ### Example
 
@@ -178,7 +182,7 @@ const { status, data } = await apiInstance.companyIdGet(
 # **companyPost**
 > Company companyPost(company)
 
-Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+Add a new company.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
 
 ### Example
 
@@ -232,7 +236,7 @@ const { status, data } = await apiInstance.companyPost(
 # **companyPut**
 > Company companyPut(company)
 
-Companies are the entities that send and receive invoices. As you send invoices, companies are added as needed (company details are extrapolated). **You can only receive invoices for existing companies, so ensure they exist**.
+Update an existing company.  **Companies** are the entities that send and receive invoices. They are automatically created from invoice data when invoices are sent or received.
 
 ### Example
 

package/docs/Event.md

@@ -18,9 +18,9 @@ Name | Type | Description | Notes
 **date_time** | **string** | Date and time of the request. | [optional] [default to undefined]
 **error** | **string** | Response error. | [optional] [default to undefined]
 **resource_id** | **number** | ID of the resource created or modified by this request. | [optional] [default to undefined]
-**success** | **boolean** | Wether the request was successful. | [optional] [readonly] [default to undefined]
+**success** | **boolean** | Whether the request was successful. | [optional] [readonly] [default to undefined]
 **query** | **string** | Request query. Only used for internal logging, not sent to webhooks. | [optional] [default to undefined]
-**response_body** | **string** | Response payload. It is guaranteed to be cyphered at rest. | [optional] [default to undefined]
+**response_body** | **string** | Response payload. It is guaranteed to be encrypted at rest. | [optional] [default to undefined]
 
 ## Example
 

package/docs/ExportApi.md

@@ -0,0 +1,79 @@
+# ExportApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**exportGet**](#exportget) | **GET** /export | Export invoices as a ZIP archive|
+
+# **exportGet**
+> exportGet()
+
+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.
+
+### Example
+
+```typescript
+import {
+    ExportApi,
+    Configuration
+} from '@invoicetronic/ts-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ExportApi(configuration);
+
+let type: 'Send' | 'Receive' | 'Both'; // (optional) (default to 'Both')
+let companyId: number; //Company id (optional) (default to undefined)
+let year: number; // (optional) (default to undefined)
+let month: number; // (optional) (default to undefined)
+let quarter: number; // (optional) (default to undefined)
+let documentDateFrom: string; //UTC ISO 8601 (2024-11-29T12:34:56Z) (optional) (default to undefined)
+let documentDateTo: string; //UTC ISO 8601 (2024-11-29T12:34:56Z) (optional) (default to undefined)
+
+const { status, data } = await apiInstance.exportGet(
+    type,
+    companyId,
+    year,
+    month,
+    quarter,
+    documentDateFrom,
+    documentDateTo
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **type** | [**&#39;Send&#39; | &#39;Receive&#39; | &#39;Both&#39;**]**Array<&#39;Send&#39; &#124; &#39;Receive&#39; &#124; &#39;Both&#39;>** |  | (optional) defaults to 'Both'|
+| **companyId** | [**number**] | Company id | (optional) defaults to undefined|
+| **year** | [**number**] |  | (optional) defaults to undefined|
+| **month** | [**number**] |  | (optional) defaults to undefined|
+| **quarter** | [**number**] |  | (optional) defaults to undefined|
+| **documentDateFrom** | [**string**] | UTC ISO 8601 (2024-11-29T12:34:56Z) | (optional) defaults to undefined|
+| **documentDateTo** | [**string**] | UTC ISO 8601 (2024-11-29T12:34:56Z) | (optional) defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/problem+json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**204** | No Content |  -  |
+|**400** | Bad Request |  -  |
+
+[[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)
+

package/docs/LogApi.md

@@ -10,7 +10,7 @@ All URIs are relative to *http://localhost*
 # **logGet**
 > Array<Event> logGet()
 
-Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
+Retrieve a paginated list of log events. Results can be filtered by various criteria such as endpoint, method, status code, and date ranges.  **Logs** record every API request. They are preserved for 15 days.  You can also view logs in the Events section of the [Dashboard](https://dashboard.invoicetronic.com).
 
 ### Example
 
@@ -102,7 +102,7 @@ const { status, data } = await apiInstance.logGet(
 # **logIdGet**
 > Event logIdGet()
 
-Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
+Retrieve a log event by its internal id.  **Logs** record every API request. They are preserved for 15 days.  You can also view logs in the Events section of the [Dashboard](https://dashboard.invoicetronic.com).
 
 ### Example
 

package/docs/Receive.md

@@ -12,15 +12,15 @@ Name | Type | Description | Notes
 **company_id** | **number** | Company id. On send, this is the sender and must be set in advance. On receive, it will be  automatically set based on the recipient\'s VAT number. If a matching company is not found, the invoice will be rejected until the company is created. | [optional] [default to undefined]
 **committente** | **string** | VAT number of the Cessionario/Committente (customer). This is automatically set based on the recipient\'s VAT number. | [optional] [default to undefined]
 **prestatore** | **string** | VAT number of the Cedente/Prestatore (vendor). This is automatically set based on the sender\'s VAT number. | [optional] [default to undefined]
-**identifier** | **string** | SDI identifier. This is set by the SDI and is guaranted to be unique within the SDI system. | [optional] [default to undefined]
+**identifier** | **string** | SDI identifier. This is set by the SDI and is guaranteed to be unique within the SDI system. | [optional] [default to undefined]
 **file_name** | **string** | Xml file name. | [optional] [default to undefined]
 **format** | **string** | SDI format (FPA12, FPR12, FSM10, ...) | [optional] [default to undefined]
-**payload** | **string** | Xml payloaad. This is the actual xml content, as string. On send, it can be base64 encoded. If it\'s not, it will be encoded before sending. It is guaranteed to be cyphered at rest. | [default to undefined]
+**payload** | **string** | Xml payload. This is the actual xml content, as string. On send, it can be base64 encoded. If it\'s not, it will be encoded before sending. It is guaranteed to be encrypted at rest. | [default to undefined]
 **last_update** | **string** | Last update from SDI. | [optional] [default to undefined]
 **date_sent** | **string** | When the invoice was sent to SDI. | [optional] [default to undefined]
 **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]
 **encoding** | **string** | Whether the payload is Base64 encoded or a plain XML (text). | [optional] [default to undefined]
-**is_read** | **boolean** | Wether the invoice has been read at least once. | [optional] [default to undefined]
+**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]
 **message_id** | **string** | SDI message id. | [optional] [default to undefined]
 
 ## Example

package/docs/ReceiveApi.md

@@ -11,7 +11,7 @@ All URIs are relative to *http://localhost*
 # **receiveGet**
 > Array<Receive> receiveGet()
 
-Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, and document number. 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/).
 
 ### Example
 
@@ -112,7 +112,7 @@ const { status, data } = await apiInstance.receiveGet(
 # **receiveIdDelete**
 > Receive receiveIdDelete()
 
-Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+Permanently delete a receive invoice by its internal id. This action cannot be undone.  **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
 
 ### Example
 
@@ -159,6 +159,7 @@ const { status, data } = await apiInstance.receiveIdDelete(
 |**200** | OK |  -  |
 |**422** | Unprocessable Content |  -  |
 |**400** | Bad Request |  -  |
+|**409** | Conflict |  -  |
 |**404** | Not Found |  -  |
 
 [[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)
@@ -166,7 +167,7 @@ const { status, data } = await apiInstance.receiveIdDelete(
 # **receiveIdGet**
 > Receive receiveIdGet()
 
-Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+Retrieve an incoming invoice by its internal id. The `id` is unique and assigned by the system when the invoice is received. Returns invoice metadata; set `include_payload` to true to include the full invoice content. The invoice is marked as read (`is_read` = true) only when `include_payload` is true.  **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
 
 ### Example
 

package/docs/Send.md

@@ -12,10 +12,10 @@ Name | Type | Description | Notes
 **company_id** | **number** | Company id. On send, this is the sender and must be set in advance. On receive, it will be  automatically set based on the recipient\'s VAT number. If a matching company is not found, the invoice will be rejected until the company is created. | [optional] [default to undefined]
 **committente** | **string** | VAT number of the Cessionario/Committente (customer). This is automatically set based on the recipient\'s VAT number. | [optional] [default to undefined]
 **prestatore** | **string** | VAT number of the Cedente/Prestatore (vendor). This is automatically set based on the sender\'s VAT number. | [optional] [default to undefined]
-**identifier** | **string** | SDI identifier. This is set by the SDI and is guaranted to be unique within the SDI system. | [optional] [default to undefined]
+**identifier** | **string** | SDI identifier. This is set by the SDI and is guaranteed to be unique within the SDI system. | [optional] [default to undefined]
 **file_name** | **string** | Xml file name. | [optional] [default to undefined]
 **format** | **string** | SDI format (FPA12, FPR12, FSM10, ...) | [optional] [default to undefined]
-**payload** | **string** | Xml payloaad. This is the actual xml content, as string. On send, it can be base64 encoded. If it\'s not, it will be encoded before sending. It is guaranteed to be cyphered at rest. | [default to undefined]
+**payload** | **string** | Xml payload. This is the actual xml content, as string. On send, it can be base64 encoded. If it\'s not, it will be encoded before sending. It is guaranteed to be encrypted at rest. | [default to undefined]
 **last_update** | **string** | Last update from SDI. | [optional] [default to undefined]
 **date_sent** | **string** | When the invoice was sent to SDI. | [optional] [default to undefined]
 **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]