@invoicetronic/ts-sdk 1.7.0 → 1.9.0

package/dist/src/models/web-hook-history.js

@@ -3,9 +3,9 @@
 /* eslint-disable */
 /**
  * Invoicetronic API
- * 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/
+ * 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]  ## Before you start  For the full integration guide, tutorials, SDKs and quickstarts, see the **[Documentation](https://invoicetronic.com/en/docs/)**. A few cross-cutting topics worth knowing before integrating:  - **[Prerequisites](https://invoicetronic.com/en/docs/prerequisites/)** — what you need to start in Sandbox and what\'s required to move to production. - **[API Keys](https://invoicetronic.com/en/docs/apikeys/)** — how `ik_live_` and `ik_test_` keys select the environment. - **[Sandbox](https://invoicetronic.com/en/docs/sandbox/)** — free test environment that mirrors the live workflow, with no credits consumed. - **[Rate Limiting](https://invoicetronic.com/en/docs/ratelimiting/)** — per-second, per-minute and per-day limits; how to handle `429 Too Many Requests`. - **[Pagination](https://invoicetronic.com/en/docs/pagination/)** — `page` and `page_size` parameters and the `Invoicetronic-Total-Count` response header. - **[CORS](https://invoicetronic.com/en/docs/cors/)** — calling the API from the browser; allowed origins are configured per key. - **[Webhooks](https://invoicetronic.com/en/docs/webhooks/)** — real-time event notifications with HMAC-SHA256 signature validation. - **[Localization](https://invoicetronic.com/en/docs/accept-language/)** — use the `Accept-Language` header to receive error messages in Italian, English or German.  [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
  *
- * The version of the OpenAPI document: 1.6.4
+ * The version of the OpenAPI document: 1.14.0
  * Contact: info@invoicetronic.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -1,8 +1,8 @@
 /**
  * Invoicetronic API
- * 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/
+ * 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]  ## Before you start  For the full integration guide, tutorials, SDKs and quickstarts, see the **[Documentation](https://invoicetronic.com/en/docs/)**. A few cross-cutting topics worth knowing before integrating:  - **[Prerequisites](https://invoicetronic.com/en/docs/prerequisites/)** — what you need to start in Sandbox and what\'s required to move to production. - **[API Keys](https://invoicetronic.com/en/docs/apikeys/)** — how `ik_live_` and `ik_test_` keys select the environment. - **[Sandbox](https://invoicetronic.com/en/docs/sandbox/)** — free test environment that mirrors the live workflow, with no credits consumed. - **[Rate Limiting](https://invoicetronic.com/en/docs/ratelimiting/)** — per-second, per-minute and per-day limits; how to handle `429 Too Many Requests`. - **[Pagination](https://invoicetronic.com/en/docs/pagination/)** — `page` and `page_size` parameters and the `Invoicetronic-Total-Count` response header. - **[CORS](https://invoicetronic.com/en/docs/cors/)** — calling the API from the browser; allowed origins are configured per key. - **[Webhooks](https://invoicetronic.com/en/docs/webhooks/)** — real-time event notifications with HMAC-SHA256 signature validation. - **[Localization](https://invoicetronic.com/en/docs/accept-language/)** — use the `Accept-Language` header to receive error messages in Italian, English or German.  [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
  *
- * The version of the OpenAPI document: 1.6.4
+ * The version of the OpenAPI document: 1.14.0
  * Contact: info@invoicetronic.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -14,7 +14,7 @@
  */
 export interface WebHook {
     /**
-     * Unique identifier. Leave it at 0 for new records as it will be set automatically.
+     * Unique identifier. For POST requests, leave it at `0` — the server will assign one automatically. For PUT requests, set it to the id of the record you want to update.
      */
     'id'?: number;
     /**
@@ -26,11 +26,11 @@ export interface WebHook {
      */
     'version'?: number;
     /**
-     * User id.
+     * User id. It is set automatically based on the authenticated user.
      */
     'user_id'?: number;
     /**
-     * Company id.
+     * Optional company id. If set, the webhook is restricted to events for that company; if omitted, it fires for all companies on the account.
      */
     'company_id'?: number | null;
     /**
@@ -53,4 +53,8 @@ export interface WebHook {
      * List of events that trigger the webhook. See Invoicetronic.SupportedEvents.Available for a list of valid event names.
      */
     'events'?: Array<string> | null;
+    /**
+     * Timestamp of the last failure notification email sent for this webhook. Set by the notifier service; reset to null on successful delivery.
+     */
+    'failure_notified_at'?: string | null;
 }

package/dist/src/models/web-hook.js

@@ -3,9 +3,9 @@
 /* eslint-disable */
 /**
  * Invoicetronic API
- * 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/
+ * 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]  ## Before you start  For the full integration guide, tutorials, SDKs and quickstarts, see the **[Documentation](https://invoicetronic.com/en/docs/)**. A few cross-cutting topics worth knowing before integrating:  - **[Prerequisites](https://invoicetronic.com/en/docs/prerequisites/)** — what you need to start in Sandbox and what\'s required to move to production. - **[API Keys](https://invoicetronic.com/en/docs/apikeys/)** — how `ik_live_` and `ik_test_` keys select the environment. - **[Sandbox](https://invoicetronic.com/en/docs/sandbox/)** — free test environment that mirrors the live workflow, with no credits consumed. - **[Rate Limiting](https://invoicetronic.com/en/docs/ratelimiting/)** — per-second, per-minute and per-day limits; how to handle `429 Too Many Requests`. - **[Pagination](https://invoicetronic.com/en/docs/pagination/)** — `page` and `page_size` parameters and the `Invoicetronic-Total-Count` response header. - **[CORS](https://invoicetronic.com/en/docs/cors/)** — calling the API from the browser; allowed origins are configured per key. - **[Webhooks](https://invoicetronic.com/en/docs/webhooks/)** — real-time event notifications with HMAC-SHA256 signature validation. - **[Localization](https://invoicetronic.com/en/docs/accept-language/)** — use the `Accept-Language` header to receive error messages in Italian, English or German.  [1]: https://www.fatturapa.gov.it/it/sistemainterscambio/cose-il-sdi/ [2]: https://invoicetronic.com/
  *
- * The version of the OpenAPI document: 1.6.4
+ * The version of the OpenAPI document: 1.14.0
  * Contact: info@invoicetronic.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/Company.md

@@ -6,10 +6,10 @@ A company model.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | Unique identifier. Leave it at 0 for new records as it will be set automatically. | [optional] [default to undefined]
-**created** | **string** | Creation date. It is set automatically. | [optional] [default to undefined]
-**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [default to undefined]
-**user_id** | **number** | User id. | [optional] [default to undefined]
+**id** | **number** | Unique identifier. For POST requests, leave it at `0` — the server will assign one automatically. For PUT requests, set it to the id of the record you want to update. | [optional] [default to undefined]
+**created** | **string** | Creation date. It is set automatically. | [optional] [readonly] [default to undefined]
+**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [readonly] [default to undefined]
+**user_id** | **number** | User id. It is set automatically based on the authenticated user. | [optional] [readonly] [default to undefined]
 **vat** | **string** | Vat number. Must include the country code. | [default to undefined]
 **fiscal_code** | **string** | Fiscal code. In most cases it\'s the same as the vat number. | [default to undefined]
 **name** | **string** | Name | [default to undefined]

package/docs/Event.md

@@ -6,9 +6,9 @@ An API request log entry.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | Unique identifier. Leave it at 0 for new records as it will be set automatically. | [optional] [default to undefined]
-**created** | **string** | Creation date. It is set automatically. | [optional] [default to undefined]
-**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [default to undefined]
+**id** | **number** | Unique identifier. For POST requests, leave it at `0` — the server will assign one automatically. For PUT requests, set it to the id of the record you want to update. | [optional] [default to undefined]
+**created** | **string** | Creation date. It is set automatically. | [optional] [readonly] [default to undefined]
+**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [readonly] [default to undefined]
 **user_id** | **number** | User id. | [optional] [default to undefined]
 **api_key_id** | **number** | Api key id. | [optional] [default to undefined]
 **company_id** | **number** | Company id. | [optional] [default to undefined]

package/docs/Receive.md

@@ -6,20 +6,20 @@ A received invoice.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | Unique identifier. Leave it at 0 for new records as it will be set automatically. | [optional] [default to undefined]
-**created** | **string** | Creation date. It is set automatically. | [optional] [default to undefined]
-**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [default to undefined]
-**user_id** | **number** | User id. | [optional] [default to undefined]
-**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 guaranteed to be unique within the SDI system. | [optional] [default to undefined]
-**file_name** | **string** | Xml file name. | [optional] [default to undefined]
+**id** | **number** | Unique identifier. For POST requests, leave it at `0` — the server will assign one automatically. For PUT requests, set it to the id of the record you want to update. | [optional] [default to undefined]
+**created** | **string** | Creation date. It is set automatically. | [optional] [readonly] [default to undefined]
+**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [readonly] [default to undefined]
+**user_id** | **number** | User id. It is set automatically based on the authenticated user. | [optional] [readonly] [default to undefined]
+**company_id** | **number** | Company id. It is set automatically based on the VAT number extracted from the invoice payload (the sender for `send`, the recipient for `receive`). | [optional] [readonly] [default to undefined]
+**committente** | **string** | VAT number of the Cessionario/Committente (customer). This is automatically set based on the recipient\'s VAT number. | [optional] [readonly] [default to undefined]
+**prestatore** | **string** | VAT number of the Cedente/Prestatore (vendor). This is automatically set based on the sender\'s VAT number. | [optional] [readonly] [default to undefined]
+**identifier** | **string** | SDI identifier. This is set by the SDI and is guaranteed to be unique within the SDI system. | [optional] [readonly] [default to undefined]
+**file_name** | **string** | Xml file name. If not provided on send, it will be auto-generated. | [optional] [default to undefined]
 **format** | **string** | SDI format (FPA12, FPR12, FSM10, ...) | [optional] [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]
+**last_update** | **string** | Last update from SDI. | [optional] [readonly] [default to undefined]
+**date_sent** | **string** | When the invoice was sent to SDI. | [optional] [readonly] [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] [readonly] [default to undefined]
 **encoding** | **string** | Whether the payload is Base64 encoded or a plain XML (text). | [optional] [default to undefined]
 **nome_prestatore** | **string** | Business name of the prestatore (supplier/seller) extracted from the invoice XML. | [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]

package/docs/ReceiveApi.md

@@ -12,7 +12,7 @@ All URIs are relative to *http://localhost*
 # **receiveGet**
 > Array<Receive> receiveGet()
 
-Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content. Invoices are marked as read (`is_read` = true) only when `include_payload` is true.  **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
+Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content. Invoices are marked as read (`is_read` = true) only when `include_payload` is true.  **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).  Inbound invoices are routed to your account via the recipient VAT number, so the recipient company must exist in Invoicetronic for the invoice to be matched. If an invoice arrives before its company has been registered, it is held by our SDI infrastructure and automatically re-processed once the company is created—no invoice is lost. See [Prerequisites](https://invoicetronic.com/en/docs/prerequisites/) for the recommended setup order.
 
 ### Example
 
@@ -115,7 +115,7 @@ const { status, data } = await apiInstance.receiveGet(
 # **receiveIdDelete**
 > Receive receiveIdDelete()
 
-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/).
+Permanently delete a receive invoice by its internal id. This action cannot be undone.  **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).  Inbound invoices are routed to your account via the recipient VAT number, so the recipient company must exist in Invoicetronic for the invoice to be matched. If an invoice arrives before its company has been registered, it is held by our SDI infrastructure and automatically re-processed once the company is created—no invoice is lost. See [Prerequisites](https://invoicetronic.com/en/docs/prerequisites/) for the recommended setup order.
 
 ### Example
 
@@ -167,7 +167,7 @@ const { status, data } = await apiInstance.receiveIdDelete(
 # **receiveIdGet**
 > Receive receiveIdGet()
 
-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/).
+Retrieve an incoming invoice by its internal id. The `id` is unique and assigned by the system when the invoice is received. Returns invoice metadata; set `include_payload` to true to include the full invoice content. The invoice is marked as read (`is_read` = true) only when `include_payload` is true.  **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).  Inbound invoices are routed to your account via the recipient VAT number, so the recipient company must exist in Invoicetronic for the invoice to be matched. If an invoice arrives before its company has been registered, it is held by our SDI infrastructure and automatically re-processed once the company is created—no invoice is lost. See [Prerequisites](https://invoicetronic.com/en/docs/prerequisites/) for the recommended setup order.
 
 ### Example
 

package/docs/Send.md

@@ -6,23 +6,24 @@ A sent invoice.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | Unique identifier. Leave it at 0 for new records as it will be set automatically. | [optional] [default to undefined]
-**created** | **string** | Creation date. It is set automatically. | [optional] [default to undefined]
-**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [default to undefined]
-**user_id** | **number** | User id. | [optional] [default to undefined]
-**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 guaranteed to be unique within the SDI system. | [optional] [default to undefined]
-**file_name** | **string** | Xml file name. | [optional] [default to undefined]
+**id** | **number** | Unique identifier. For POST requests, leave it at `0` — the server will assign one automatically. For PUT requests, set it to the id of the record you want to update. | [optional] [default to undefined]
+**created** | **string** | Creation date. It is set automatically. | [optional] [readonly] [default to undefined]
+**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [readonly] [default to undefined]
+**user_id** | **number** | User id. It is set automatically based on the authenticated user. | [optional] [readonly] [default to undefined]
+**company_id** | **number** | Company id. It is set automatically based on the VAT number extracted from the invoice payload (the sender for `send`, the recipient for `receive`). | [optional] [readonly] [default to undefined]
+**committente** | **string** | VAT number of the Cessionario/Committente (customer). This is automatically set based on the recipient\'s VAT number. | [optional] [readonly] [default to undefined]
+**prestatore** | **string** | VAT number of the Cedente/Prestatore (vendor). This is automatically set based on the sender\'s VAT number. | [optional] [readonly] [default to undefined]
+**identifier** | **string** | SDI identifier. This is set by the SDI and is guaranteed to be unique within the SDI system. | [optional] [readonly] [default to undefined]
+**file_name** | **string** | Xml file name. If not provided on send, it will be auto-generated. | [optional] [default to undefined]
 **format** | **string** | SDI format (FPA12, FPR12, FSM10, ...) | [optional] [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]
+**last_update** | **string** | Last update from SDI. | [optional] [readonly] [default to undefined]
+**date_sent** | **string** | When the invoice was sent to SDI. | [optional] [readonly] [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] [readonly] [default to undefined]
 **encoding** | **string** | Whether the payload is Base64 encoded or a plain XML (text). | [optional] [default to undefined]
-**nome_committente** | **string** | Business name of the committente (client/buyer) extracted from the invoice XML. | [optional] [default to undefined]
+**nome_committente** | **string** | Business name of the committente (client/buyer) extracted from the invoice XML. | [optional] [readonly] [default to undefined]
 **meta_data** | **{ [key: string]: string; }** | Optional metadata, as json. | [optional] [default to undefined]
+**latest_state** | **string** | Current SDI state of the invoice. Reflects the most recent update received from SDI. Null when no update has been received yet. | [optional] [readonly] [default to undefined]
 **company** | [**Company**](Company.md) |  | [optional] [default to undefined]
 
 ## Example
@@ -48,6 +49,7 @@ const instance: Send = {
     encoding,
     nome_committente,
     meta_data,
+    latest_state,
     company,
 };
 ```

package/docs/SendApi.md

@@ -20,7 +20,7 @@ All URIs are relative to *http://localhost*
 # **sendFilePost**
 > Send sendFilePost()
 
-Add a new invoice by uploading a file. Supported formats are XML (FatturaPA) and P7M (signed). The invoice will be signed (if requested), validated (if requested), and queued for delivery to SDI. Status updates from SDI will be available in the `update` endpoint.  **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).  You can also upload invoices via the [Dashboard](https://dashboard.invoicetronic.com).
+Add a new invoice by uploading a file. Supported formats are XML (FatturaPA) and P7M (signed). The invoice will be signed (if requested), validated (if requested), and queued for delivery to SDI. Status updates from SDI will be available in the `update` endpoint.  **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).  You can also upload invoices via the [Dashboard](https://dashboard.invoicetronic.com).  ### Idempotency  To protect against duplicate submissions caused by network retries, you can send an optional `Idempotency-Key` header with any unique, client-generated value (up to 255 characters).  - The first request with a given key is processed normally, and its response (status, body and `Location`) is stored for 24 hours. - Any subsequent request that reuses the same key within that window replays the original response instead of sending a second invoice to SDI. - If a request with the same key is still being processed, the retry receives `409 Conflict`. - If the same key is reused with a **different** invoice payload, the request is rejected with `422 Unprocessable Entity`: a given key must always map to the same request.  Keys are scoped per account, so different accounts can use the same key value without interfering. If the idempotency store is temporarily unavailable, the request is processed normally without idempotency protection.
 
 ### Example
 
@@ -36,11 +36,13 @@ const apiInstance = new SendApi(configuration);
 let file: File; // (default to undefined)
 let validate: boolean; //Validate the document first, and reject it on failure. (optional) (default to false)
 let signature: 'None' | 'Apply' | 'Force' | 'Auto'; //Whether to digitally sign the document. (optional) (default to 'Auto')
+let idempotencyKey: string; //Optional client-generated key that makes the submission idempotent. Retrying the same request with the same key within 24 hours returns the original response instead of creating a duplicate invoice. (optional) (default to undefined)
 
 const { status, data } = await apiInstance.sendFilePost(
     file,
     validate,
-    signature
+    signature,
+    idempotencyKey
 );
 ```
 
@@ -51,6 +53,7 @@ const { status, data } = await apiInstance.sendFilePost(
 | **file** | [**File**] |  | defaults to undefined|
 | **validate** | [**boolean**] | Validate the document first, and reject it on failure. | (optional) defaults to false|
 | **signature** | [**&#39;None&#39; | &#39;Apply&#39; | &#39;Force&#39; | &#39;Auto&#39;**]**Array<&#39;None&#39; &#124; &#39;Apply&#39; &#124; &#39;Force&#39; &#124; &#39;Auto&#39;>** | Whether to digitally sign the document. | (optional) defaults to 'Auto'|
+| **idempotencyKey** | [**string**] | Optional client-generated key that makes the submission idempotent. Retrying the same request with the same key within 24 hours returns the original response instead of creating a duplicate invoice. | (optional) defaults to undefined|
 
 
 ### Return type
@@ -78,7 +81,7 @@ const { status, data } = await apiInstance.sendFilePost(
 # **sendGet**
 > Array<Send> sendGet()
 
-Retrieve a paginated list of send invoices. Results can be filtered by various criteria such as company, date ranges, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content.  **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
+Retrieve a paginated list of send invoices. Results can be filtered by various criteria such as company, date ranges, document number, current SDI state (`latest_state`), and free-text search (`q`). Use `ids` to fetch specific Send records in a single call (comma-separated, up to 100). Returns invoice metadata; set `include_payload` to true to include the full invoice content.  **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
 
 ### Example
 
@@ -103,7 +106,9 @@ let dateSentTo: string; //UTC ISO 8601 (2024-11-29T12:34:56Z) (optional) (defaul
 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)
 let documentNumber: string; //Document number. (optional) (default to undefined)
+let latestState: 'Inviato' | 'Consegnato' | 'NonConsegnato' | 'Scartato' | 'AccettatoDalDestinatario' | 'RifiutatoDalDestinatario' | 'ImpossibilitaDiRecapito' | 'DecorrenzaTermini' | 'AttestazioneTrasmissioneFattura'; //Filter by the most recent SDI state for the invoice. Matches the `latest_state` field exposed inline on each Send. (optional) (default to undefined)
 let includePayload: boolean; //Include payload in the response. Defaults to false. (optional) (default to undefined)
+let ids: string; //Comma-separated list of Send ids (max 100). Filters the collection to the matching rows; unknown or unauthorized ids are silently skipped. (optional) (default to undefined)
 let page: number; //Page number. (optional) (default to 1)
 let pageSize: number; //Items per page. Cannot be greater than 200. (optional) (default to 100)
 let sort: string; //Sort by field. Prefix with \'-\' for descending order. (optional) (default to undefined)
@@ -122,7 +127,9 @@ const { status, data } = await apiInstance.sendGet(
     documentDateFrom,
     documentDateTo,
     documentNumber,
+    latestState,
     includePayload,
+    ids,
     page,
     pageSize,
     sort,
@@ -146,7 +153,9 @@ const { status, data } = await apiInstance.sendGet(
 | **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|
 | **documentNumber** | [**string**] | Document number. | (optional) defaults to undefined|
+| **latestState** | [**&#39;Inviato&#39; | &#39;Consegnato&#39; | &#39;NonConsegnato&#39; | &#39;Scartato&#39; | &#39;AccettatoDalDestinatario&#39; | &#39;RifiutatoDalDestinatario&#39; | &#39;ImpossibilitaDiRecapito&#39; | &#39;DecorrenzaTermini&#39; | &#39;AttestazioneTrasmissioneFattura&#39;**]**Array<&#39;Inviato&#39; &#124; &#39;Consegnato&#39; &#124; &#39;NonConsegnato&#39; &#124; &#39;Scartato&#39; &#124; &#39;AccettatoDalDestinatario&#39; &#124; &#39;RifiutatoDalDestinatario&#39; &#124; &#39;ImpossibilitaDiRecapito&#39; &#124; &#39;DecorrenzaTermini&#39; &#124; &#39;AttestazioneTrasmissioneFattura&#39;>** | Filter by the most recent SDI state for the invoice. Matches the &#x60;latest_state&#x60; field exposed inline on each Send. | (optional) defaults to undefined|
 | **includePayload** | [**boolean**] | Include payload in the response. Defaults to false. | (optional) defaults to undefined|
+| **ids** | [**string**] | Comma-separated list of Send ids (max 100). Filters the collection to the matching rows; unknown or unauthorized ids are silently skipped. | (optional) defaults to undefined|
 | **page** | [**number**] | Page number. | (optional) defaults to 1|
 | **pageSize** | [**number**] | Items per page. Cannot be greater than 200. | (optional) defaults to 100|
 | **sort** | [**string**] | Sort by field. Prefix with \&#39;-\&#39; for descending order. | (optional) defaults to undefined|
@@ -340,7 +349,7 @@ const { status, data } = await apiInstance.sendIdentifierGet(
 # **sendJsonPost**
 > Send sendJsonPost(body)
 
-Add a new invoice using a FatturaPA JSON representation. The invoice will be signed (if requested), validated (if requested), and queued for delivery to SDI. Status updates from SDI will be available in the `update` endpoint.  **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).  You can also upload invoices via the [Dashboard](https://dashboard.invoicetronic.com).
+Add a new invoice using a FatturaPA JSON representation. Property names mirror the FatturaPA XML schema (PascalCase, e.g. `FatturaElettronicaHeader`). The invoice will be signed (if requested), validated (if requested), and queued for delivery to SDI. Status updates from SDI will be available in the `update` endpoint.  **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).  You can also upload invoices via the [Dashboard](https://dashboard.invoicetronic.com).  ### Idempotency  To protect against duplicate submissions caused by network retries, you can send an optional `Idempotency-Key` header with any unique, client-generated value (up to 255 characters).  - The first request with a given key is processed normally, and its response (status, body and `Location`) is stored for 24 hours. - Any subsequent request that reuses the same key within that window replays the original response instead of sending a second invoice to SDI. - If a request with the same key is still being processed, the retry receives `409 Conflict`. - If the same key is reused with a **different** invoice payload, the request is rejected with `422 Unprocessable Entity`: a given key must always map to the same request.  Keys are scoped per account, so different accounts can use the same key value without interfering. If the idempotency store is temporarily unavailable, the request is processed normally without idempotency protection.
 
 ### Example
 
@@ -356,11 +365,13 @@ const apiInstance = new SendApi(configuration);
 let body: object; //
 let validate: boolean; //Validate the document first, and reject it on failure. (optional) (default to false)
 let signature: 'None' | 'Apply' | 'Force' | 'Auto'; //Whether to digitally sign the document. (optional) (default to 'Auto')
+let idempotencyKey: string; //Optional client-generated key that makes the submission idempotent. Retrying the same request with the same key within 24 hours returns the original response instead of creating a duplicate invoice. (optional) (default to undefined)
 
 const { status, data } = await apiInstance.sendJsonPost(
     body,
     validate,
-    signature
+    signature,
+    idempotencyKey
 );
 ```
 
@@ -371,6 +382,7 @@ const { status, data } = await apiInstance.sendJsonPost(
 | **body** | **object**|  | |
 | **validate** | [**boolean**] | Validate the document first, and reject it on failure. | (optional) defaults to false|
 | **signature** | [**&#39;None&#39; | &#39;Apply&#39; | &#39;Force&#39; | &#39;Auto&#39;**]**Array<&#39;None&#39; &#124; &#39;Apply&#39; &#124; &#39;Force&#39; &#124; &#39;Auto&#39;>** | Whether to digitally sign the document. | (optional) defaults to 'Auto'|
+| **idempotencyKey** | [**string**] | Optional client-generated key that makes the submission idempotent. Retrying the same request with the same key within 24 hours returns the original response instead of creating a duplicate invoice. | (optional) defaults to undefined|
 
 
 ### Return type
@@ -398,7 +410,7 @@ const { status, data } = await apiInstance.sendJsonPost(
 # **sendPost**
 > Send sendPost(send)
 
-Add a new invoice using a structured Send object. The invoice will be signed (if requested), validated (if requested), and queued for delivery to SDI. Status updates from SDI will be available in the `update` endpoint.  **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).  You can also upload invoices via the [Dashboard](https://dashboard.invoicetronic.com).
+Add a new invoice using a structured Send object. The invoice will be signed (if requested), validated (if requested), and queued for delivery to SDI. Status updates from SDI will be available in the `update` endpoint.  **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).  You can also upload invoices via the [Dashboard](https://dashboard.invoicetronic.com).  ### Idempotency  To protect against duplicate submissions caused by network retries, you can send an optional `Idempotency-Key` header with any unique, client-generated value (up to 255 characters).  - The first request with a given key is processed normally, and its response (status, body and `Location`) is stored for 24 hours. - Any subsequent request that reuses the same key within that window replays the original response instead of sending a second invoice to SDI. - If a request with the same key is still being processed, the retry receives `409 Conflict`. - If the same key is reused with a **different** invoice payload, the request is rejected with `422 Unprocessable Entity`: a given key must always map to the same request.  Keys are scoped per account, so different accounts can use the same key value without interfering. If the idempotency store is temporarily unavailable, the request is processed normally without idempotency protection.
 
 ### Example
 
@@ -415,11 +427,13 @@ const apiInstance = new SendApi(configuration);
 let send: Send; //
 let validate: boolean; //Validate the document first, and reject it on failure. (optional) (default to false)
 let signature: 'None' | 'Apply' | 'Force' | 'Auto'; //Whether to digitally sign the document. (optional) (default to 'Auto')
+let idempotencyKey: string; //Optional client-generated key that makes the submission idempotent. Retrying the same request with the same key within 24 hours returns the original response instead of creating a duplicate invoice. (optional) (default to undefined)
 
 const { status, data } = await apiInstance.sendPost(
     send,
     validate,
-    signature
+    signature,
+    idempotencyKey
 );
 ```
 
@@ -430,6 +444,7 @@ const { status, data } = await apiInstance.sendPost(
 | **send** | **Send**|  | |
 | **validate** | [**boolean**] | Validate the document first, and reject it on failure. | (optional) defaults to false|
 | **signature** | [**&#39;None&#39; | &#39;Apply&#39; | &#39;Force&#39; | &#39;Auto&#39;**]**Array<&#39;None&#39; &#124; &#39;Apply&#39; &#124; &#39;Force&#39; &#124; &#39;Auto&#39;>** | Whether to digitally sign the document. | (optional) defaults to 'Auto'|
+| **idempotencyKey** | [**string**] | Optional client-generated key that makes the submission idempotent. Retrying the same request with the same key within 24 hours returns the original response instead of creating a duplicate invoice. | (optional) defaults to undefined|
 
 
 ### Return type
@@ -509,7 +524,7 @@ void (empty response body)
 # **sendValidateJsonPost**
 > sendValidateJsonPost(body)
 
-Validate a JSON invoice without sending it to SDI. Use this to check for errors before actual submission. Returns validation results with any errors found.  **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
+Validate a FatturaPA JSON invoice without sending it to SDI. Property names mirror the FatturaPA XML schema (PascalCase, e.g. `FatturaElettronicaHeader`). Use this to check for errors before actual submission. Returns validation results with any errors found.  **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
 
 ### Example
 
@@ -666,7 +681,7 @@ void (empty response body)
 # **sendXmlPost**
 > Send sendXmlPost(body)
 
-Add a new invoice using a raw XML document in FatturaPA format. The invoice will be signed (if requested), validated (if requested), and queued for delivery to SDI. Status updates from SDI will be available in the `update` endpoint.  **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).  You can also upload invoices via the [Dashboard](https://dashboard.invoicetronic.com).
+Add a new invoice using a raw XML document in FatturaPA format. The invoice will be signed (if requested), validated (if requested), and queued for delivery to SDI. Status updates from SDI will be available in the `update` endpoint.  **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).  You can also upload invoices via the [Dashboard](https://dashboard.invoicetronic.com).  ### Idempotency  To protect against duplicate submissions caused by network retries, you can send an optional `Idempotency-Key` header with any unique, client-generated value (up to 255 characters).  - The first request with a given key is processed normally, and its response (status, body and `Location`) is stored for 24 hours. - Any subsequent request that reuses the same key within that window replays the original response instead of sending a second invoice to SDI. - If a request with the same key is still being processed, the retry receives `409 Conflict`. - If the same key is reused with a **different** invoice payload, the request is rejected with `422 Unprocessable Entity`: a given key must always map to the same request.  Keys are scoped per account, so different accounts can use the same key value without interfering. If the idempotency store is temporarily unavailable, the request is processed normally without idempotency protection.
 
 ### Example
 
@@ -682,11 +697,13 @@ const apiInstance = new SendApi(configuration);
 let body: object; //
 let validate: boolean; //Validate the document first, and reject it on failure. (optional) (default to false)
 let signature: 'None' | 'Apply' | 'Force' | 'Auto'; //Whether to digitally sign the document. (optional) (default to 'Auto')
+let idempotencyKey: string; //Optional client-generated key that makes the submission idempotent. Retrying the same request with the same key within 24 hours returns the original response instead of creating a duplicate invoice. (optional) (default to undefined)
 
 const { status, data } = await apiInstance.sendXmlPost(
     body,
     validate,
-    signature
+    signature,
+    idempotencyKey
 );
 ```
 
@@ -697,6 +714,7 @@ const { status, data } = await apiInstance.sendXmlPost(
 | **body** | **object**|  | |
 | **validate** | [**boolean**] | Validate the document first, and reject it on failure. | (optional) defaults to false|
 | **signature** | [**&#39;None&#39; | &#39;Apply&#39; | &#39;Force&#39; | &#39;Auto&#39;**]**Array<&#39;None&#39; &#124; &#39;Apply&#39; &#124; &#39;Force&#39; &#124; &#39;Auto&#39;>** | Whether to digitally sign the document. | (optional) defaults to 'Auto'|
+| **idempotencyKey** | [**string**] | Optional client-generated key that makes the submission idempotent. Retrying the same request with the same key within 24 hours returns the original response instead of creating a duplicate invoice. | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/SendReduced.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **meta_data** | **{ [key: string]: string; }** | Optional metadata, as json. | [optional] [default to undefined]
 **documents** | [**Array<DocumentData>**](DocumentData.md) | The invoices included in the payload. | [optional] [default to undefined]
 **date_sent** | **string** | When the invoice was sent to SDI. | [optional] [default to undefined]
+**latest_state** | **string** | Current SDI state of the invoice. Reflects the most recent update received from SDI. | [optional] [default to undefined]
 
 ## Example
 
@@ -23,6 +24,7 @@ const instance: SendReduced = {
     meta_data,
     documents,
     date_sent,
+    latest_state,
 };
 ```
 

package/docs/Status.md

@@ -8,6 +8,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **operation_left** | **number** | Operations (invoices and validations) left. | [optional] [default to undefined]
 **signature_left** | **number** | Signatures left. | [optional] [default to undefined]
+**has_active_seat** | **boolean** | Whether the current API key has an active Desk seat. | [optional] [default to undefined]
+**is_sub_key** | **boolean** | Whether the current API key is a sub-key (restricted key). | [optional] [default to undefined]
 
 ## Example
 
@@ -17,6 +19,8 @@ import { Status } from '@invoicetronic/ts-sdk';
 const instance: Status = {
     operation_left,
     signature_left,
+    has_active_seat,
+    is_sub_key,
 };
 ```
 

package/docs/Update.md

@@ -6,9 +6,9 @@ An SDI status update for a sent invoice.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | Unique identifier. Leave it at 0 for new records as it will be set automatically. | [optional] [default to undefined]
-**created** | **string** | Creation date. It is set automatically. | [optional] [default to undefined]
-**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [default to undefined]
+**id** | **number** | Unique identifier. For POST requests, leave it at `0` — the server will assign one automatically. For PUT requests, set it to the id of the record you want to update. | [optional] [default to undefined]
+**created** | **string** | Creation date. It is set automatically. | [optional] [readonly] [default to undefined]
+**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [readonly] [default to undefined]
 **user_id** | **number** | User id. | [optional] [default to undefined]
 **company_id** | **number** | Company id. | [optional] [default to undefined]
 **send_id** | **number** | Send id. This is the id of the sent invoice to which this update refers to. | [optional] [default to undefined]

package/docs/WebHook.md

@@ -6,16 +6,17 @@ A webhook subscription.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | Unique identifier. Leave it at 0 for new records as it will be set automatically. | [optional] [default to undefined]
-**created** | **string** | Creation date. It is set automatically. | [optional] [default to undefined]
-**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [default to undefined]
-**user_id** | **number** | User id. | [optional] [default to undefined]
-**company_id** | **number** | Company id. | [optional] [default to undefined]
+**id** | **number** | Unique identifier. For POST requests, leave it at `0` — the server will assign one automatically. For PUT requests, set it to the id of the record you want to update. | [optional] [default to undefined]
+**created** | **string** | Creation date. It is set automatically. | [optional] [readonly] [default to undefined]
+**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [readonly] [default to undefined]
+**user_id** | **number** | User id. It is set automatically based on the authenticated user. | [optional] [readonly] [default to undefined]
+**company_id** | **number** | Optional company id. If set, the webhook is restricted to events for that company; if omitted, it fires for all companies on the account. | [optional] [default to undefined]
 **url** | **string** | The url of your application\'s endpoint that will receive a POST request when the webhook is fired. | [default to undefined]
 **enabled** | **boolean** | Whether the webhook is enabled. On creation, this is set to `true`. | [optional] [default to undefined]
 **secret** | **string** | The secret used to generate webhook signatures, only returned on creation. You should store this value securely and validate it on every call, to ensure that the caller is InvoicetronicApi. | [optional] [default to undefined]
 **description** | **string** | An optional description. | [optional] [default to undefined]
 **events** | **Array<string>** | List of events that trigger the webhook. See Invoicetronic.SupportedEvents.Available for a list of valid event names. | [optional] [default to undefined]
+**failure_notified_at** | **string** | Timestamp of the last failure notification email sent for this webhook. Set by the notifier service; reset to null on successful delivery. | [optional] [readonly] [default to undefined]
 
 ## Example
 
@@ -33,6 +34,7 @@ const instance: WebHook = {
     secret,
     description,
     events,
+    failure_notified_at,
 };
 ```
 

package/docs/WebHookHistory.md

@@ -6,13 +6,14 @@ Webhook history.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | Unique identifier. Leave it at 0 for new records as it will be set automatically. | [optional] [default to undefined]
-**created** | **string** | Creation date. It is set automatically. | [optional] [default to undefined]
-**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [default to undefined]
+**id** | **number** | Unique identifier. For POST requests, leave it at `0` — the server will assign one automatically. For PUT requests, set it to the id of the record you want to update. | [optional] [default to undefined]
+**created** | **string** | Creation date. It is set automatically. | [optional] [readonly] [default to undefined]
+**version** | **number** | Row version, for optimistic concurrency. It is set automatically. | [optional] [readonly] [default to undefined]
 **web_hook_id** | **number** | Webhook id. | [optional] [default to undefined]
 **user_id** | **number** | User id. | [optional] [default to undefined]
 **event** | **string** | Event name. | [optional] [default to undefined]
-**status_code** | **number** | Status code. | [optional] [default to undefined]
+**status_code** | **number** | HTTP status code returned by the webhook endpoint. A value of 0 means the request could not be completed due to a network error (e.g., DNS resolution failure, connection refused, or timeout). This typically indicates that the endpoint URL is misconfigured or no longer exists. | [optional] [default to undefined]
+**error** | **string** | Error description, if any. Null when the delivery is successful (2xx). Contains the exception message for network errors (status code 0) or the response body for non-2xx HTTP responses. | [optional] [default to undefined]
 **date_time** | **string** | Date and time of the request. | [optional] [default to undefined]
 **success** | **boolean** | Whether the request was successful. | [optional] [readonly] [default to undefined]
 
@@ -29,6 +30,7 @@ const instance: WebHookHistory = {
     user_id,
     event,
     status_code,
+    error,
     date_time,
     success,
 };

package/docs/WebhookApi.md

@@ -15,7 +15,7 @@ All URIs are relative to *http://localhost*
 # **webhookGet**
 > Array<WebHook> webhookGet()
 
-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/)**.
+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).  A webhook that fails continuously for 7 days (no successful delivery in between) is automatically disabled (`enabled` set to `false`) and the account owner is notified by email. To resume deliveries, set `enabled` back to `true` from the Dashboard or via `PATCH /webhook/{id}`.  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
 
 ### Example
 
@@ -88,7 +88,7 @@ const { status, data } = await apiInstance.webhookGet(
 # **webhookIdDelete**
 > WebHook webhookIdDelete()
 
-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/)**.
+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).  A webhook that fails continuously for 7 days (no successful delivery in between) is automatically disabled (`enabled` set to `false`) and the account owner is notified by email. To resume deliveries, set `enabled` back to `true` from the Dashboard or via `PATCH /webhook/{id}`.  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
 
 ### Example
 
@@ -140,7 +140,7 @@ const { status, data } = await apiInstance.webhookIdDelete(
 # **webhookIdGet**
 > WebHook webhookIdGet()
 
-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/)**.
+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).  A webhook that fails continuously for 7 days (no successful delivery in between) is automatically disabled (`enabled` set to `false`) and the account owner is notified by email. To resume deliveries, set `enabled` back to `true` from the Dashboard or via `PATCH /webhook/{id}`.  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
 
 ### Example
 
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.webhookIdGet(
 # **webhookPost**
 > WebHook webhookPost(webHook)
 
-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/)**.
+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).  A webhook that fails continuously for 7 days (no successful delivery in between) is automatically disabled (`enabled` set to `false`) and the account owner is notified by email. To resume deliveries, set `enabled` back to `true` from the Dashboard or via `PATCH /webhook/{id}`.  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
 
 ### Example
 
@@ -245,7 +245,7 @@ const { status, data } = await apiInstance.webhookPost(
 # **webhookPut**
 > WebHook webhookPut(webHook)
 
-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/)**.
+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).  A webhook that fails continuously for 7 days (no successful delivery in between) is automatically disabled (`enabled` set to `false`) and the account owner is notified by email. To resume deliveries, set `enabled` back to `true` from the Dashboard or via `PATCH /webhook/{id}`.  For more information, see the **[Webhooks documentation page](https://invoicetronic.com/en/docs/webhooks/)**.
 
 ### Example