@invoicetronic/ts-sdk 1.1.7 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. package/CHANGELOG.md +1 -1
  2. package/README.md +2 -2
  3. package/api.ts +1 -0
  4. package/common.ts +15 -2
  5. package/configuration.ts +1 -1
  6. package/dist/api.d.ts +1 -0
  7. package/dist/api.js +1 -0
  8. package/dist/common.d.ts +6 -0
  9. package/dist/common.js +17 -3
  10. package/dist/configuration.js +1 -1
  11. package/dist/esm/api.d.ts +1 -0
  12. package/dist/esm/api.js +1 -0
  13. package/dist/esm/common.d.ts +6 -0
  14. package/dist/esm/common.js +15 -2
  15. package/dist/esm/configuration.js +1 -1
  16. package/dist/esm/src/api/company-api.d.ts +35 -30
  17. package/dist/esm/src/api/company-api.js +34 -27
  18. package/dist/esm/src/api/export-api.d.ts +115 -0
  19. package/dist/esm/src/api/export-api.js +179 -0
  20. package/dist/esm/src/api/log-api.d.ts +10 -10
  21. package/dist/esm/src/api/log-api.js +8 -8
  22. package/dist/esm/src/api/receive-api.d.ts +15 -15
  23. package/dist/esm/src/api/receive-api.js +12 -12
  24. package/dist/esm/src/api/send-api.d.ts +55 -55
  25. package/dist/esm/src/api/send-api.js +44 -44
  26. package/dist/esm/src/api/status-api.d.ts +5 -5
  27. package/dist/esm/src/api/status-api.js +4 -4
  28. package/dist/esm/src/api/update-api.d.ts +10 -10
  29. package/dist/esm/src/api/update-api.js +8 -8
  30. package/dist/esm/src/api/webhook-api.d.ts +25 -25
  31. package/dist/esm/src/api/webhook-api.js +20 -20
  32. package/dist/esm/src/models/event.d.ts +2 -2
  33. package/dist/esm/src/models/receive.d.ts +3 -3
  34. package/dist/esm/src/models/send.d.ts +2 -2
  35. package/dist/esm/src/models/update.d.ts +2 -2
  36. package/dist/esm/src/models/web-hook-history.d.ts +1 -1
  37. package/dist/esm/src/models/web-hook.d.ts +2 -2
  38. package/dist/src/api/company-api.d.ts +35 -30
  39. package/dist/src/api/company-api.js +34 -27
  40. package/dist/src/api/export-api.d.ts +115 -0
  41. package/dist/src/api/export-api.js +186 -0
  42. package/dist/src/api/log-api.d.ts +10 -10
  43. package/dist/src/api/log-api.js +8 -8
  44. package/dist/src/api/receive-api.d.ts +15 -15
  45. package/dist/src/api/receive-api.js +12 -12
  46. package/dist/src/api/send-api.d.ts +55 -55
  47. package/dist/src/api/send-api.js +44 -44
  48. package/dist/src/api/status-api.d.ts +5 -5
  49. package/dist/src/api/status-api.js +4 -4
  50. package/dist/src/api/update-api.d.ts +10 -10
  51. package/dist/src/api/update-api.js +8 -8
  52. package/dist/src/api/webhook-api.d.ts +25 -25
  53. package/dist/src/api/webhook-api.js +20 -20
  54. package/dist/src/models/event.d.ts +2 -2
  55. package/dist/src/models/receive.d.ts +3 -3
  56. package/dist/src/models/send.d.ts +2 -2
  57. package/dist/src/models/update.d.ts +2 -2
  58. package/dist/src/models/web-hook-history.d.ts +1 -1
  59. package/dist/src/models/web-hook.d.ts +2 -2
  60. package/docs/CompanyApi.md +10 -6
  61. package/docs/Event.md +2 -2
  62. package/docs/ExportApi.md +79 -0
  63. package/docs/LogApi.md +2 -2
  64. package/docs/Receive.md +3 -3
  65. package/docs/ReceiveApi.md +4 -3
  66. package/docs/Send.md +2 -2
  67. package/docs/SendApi.md +11 -11
  68. package/docs/StatusApi.md +1 -1
  69. package/docs/Update.md +2 -2
  70. package/docs/UpdateApi.md +2 -2
  71. package/docs/WebHook.md +2 -2
  72. package/docs/WebHookHistory.md +1 -1
  73. package/docs/WebhookApi.md +6 -5
  74. package/package.json +1 -1
  75. package/src/api/company-api.ts +43 -34
  76. package/src/api/export-api.ts +211 -0
  77. package/src/api/log-api.ts +11 -11
  78. package/src/api/receive-api.ts +16 -16
  79. package/src/api/send-api.ts +56 -56
  80. package/src/api/status-api.ts +6 -6
  81. package/src/api/update-api.ts +11 -11
  82. package/src/api/webhook-api.ts +26 -26
  83. package/src/models/event.ts +2 -2
  84. package/src/models/receive.ts +3 -3
  85. package/src/models/send.ts +2 -2
  86. package/src/models/update.ts +2 -2
  87. package/src/models/web-hook-history.ts +1 -1
  88. package/src/models/web-hook.ts +2 -2
@@ -18,7 +18,7 @@ import type { Event } from '../../src/models';
18
18
  */
19
19
  export declare const LogApiAxiosParamCreator: (configuration?: Configuration) => {
20
20
  /**
21
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
21
+ * 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).
22
22
  * @summary List events
23
23
  * @param {number} [companyId] Company id
24
24
  * @param {string} [endpoint]
@@ -39,7 +39,7 @@ export declare const LogApiAxiosParamCreator: (configuration?: Configuration) =>
39
39
  */
40
40
  logGet: (companyId?: number, endpoint?: string, method?: string, apiVerion?: number, statusCode?: number, dateCreatedFrom?: string, dateCreatedTo?: string, page?: number, pageSize?: number, sort?: string, query?: string, success?: boolean, dateTimeFrom?: string, dateTimeTo?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
41
41
  /**
42
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
42
+ * 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).
43
43
  * @summary Get an event by id
44
44
  * @param {number} id Item id
45
45
  * @param {*} [options] Override http request option.
@@ -52,7 +52,7 @@ export declare const LogApiAxiosParamCreator: (configuration?: Configuration) =>
52
52
  */
53
53
  export declare const LogApiFp: (configuration?: Configuration) => {
54
54
  /**
55
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
55
+ * 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).
56
56
  * @summary List events
57
57
  * @param {number} [companyId] Company id
58
58
  * @param {string} [endpoint]
@@ -73,7 +73,7 @@ export declare const LogApiFp: (configuration?: Configuration) => {
73
73
  */
74
74
  logGet(companyId?: number, endpoint?: string, method?: string, apiVerion?: number, statusCode?: number, dateCreatedFrom?: string, dateCreatedTo?: string, page?: number, pageSize?: number, sort?: string, query?: string, success?: boolean, dateTimeFrom?: string, dateTimeTo?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Event>>>;
75
75
  /**
76
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
76
+ * 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).
77
77
  * @summary Get an event by id
78
78
  * @param {number} id Item id
79
79
  * @param {*} [options] Override http request option.
@@ -86,7 +86,7 @@ export declare const LogApiFp: (configuration?: Configuration) => {
86
86
  */
87
87
  export declare const LogApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
88
88
  /**
89
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
89
+ * 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).
90
90
  * @summary List events
91
91
  * @param {number} [companyId] Company id
92
92
  * @param {string} [endpoint]
@@ -107,7 +107,7 @@ export declare const LogApiFactory: (configuration?: Configuration, basePath?: s
107
107
  */
108
108
  logGet(companyId?: number, endpoint?: string, method?: string, apiVerion?: number, statusCode?: number, dateCreatedFrom?: string, dateCreatedTo?: string, page?: number, pageSize?: number, sort?: string, query?: string, success?: boolean, dateTimeFrom?: string, dateTimeTo?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Event>>;
109
109
  /**
110
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
110
+ * 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).
111
111
  * @summary Get an event by id
112
112
  * @param {number} id Item id
113
113
  * @param {*} [options] Override http request option.
@@ -120,7 +120,7 @@ export declare const LogApiFactory: (configuration?: Configuration, basePath?: s
120
120
  */
121
121
  export interface LogApiInterface {
122
122
  /**
123
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
123
+ * 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).
124
124
  * @summary List events
125
125
  * @param {number} [companyId] Company id
126
126
  * @param {string} [endpoint]
@@ -141,7 +141,7 @@ export interface LogApiInterface {
141
141
  */
142
142
  logGet(companyId?: number, endpoint?: string, method?: string, apiVerion?: number, statusCode?: number, dateCreatedFrom?: string, dateCreatedTo?: string, page?: number, pageSize?: number, sort?: string, query?: string, success?: boolean, dateTimeFrom?: string, dateTimeTo?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Event>>;
143
143
  /**
144
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
144
+ * 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).
145
145
  * @summary Get an event by id
146
146
  * @param {number} id Item id
147
147
  * @param {*} [options] Override http request option.
@@ -154,7 +154,7 @@ export interface LogApiInterface {
154
154
  */
155
155
  export declare class LogApi extends BaseAPI implements LogApiInterface {
156
156
  /**
157
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
157
+ * 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).
158
158
  * @summary List events
159
159
  * @param {number} [companyId] Company id
160
160
  * @param {string} [endpoint]
@@ -175,7 +175,7 @@ export declare class LogApi extends BaseAPI implements LogApiInterface {
175
175
  */
176
176
  logGet(companyId?: number, endpoint?: string, method?: string, apiVerion?: number, statusCode?: number, dateCreatedFrom?: string, dateCreatedTo?: string, page?: number, pageSize?: number, sort?: string, query?: string, success?: boolean, dateTimeFrom?: string, dateTimeTo?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Event[], any, {}>>;
177
177
  /**
178
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
178
+ * 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).
179
179
  * @summary Get an event by id
180
180
  * @param {number} id Item id
181
181
  * @param {*} [options] Override http request option.
@@ -38,7 +38,7 @@ const base_1 = require("../../base");
38
38
  const LogApiAxiosParamCreator = function (configuration) {
39
39
  return {
40
40
  /**
41
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
41
+ * 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).
42
42
  * @summary List events
43
43
  * @param {number} [companyId] Company id
44
44
  * @param {string} [endpoint]
@@ -131,7 +131,7 @@ const LogApiAxiosParamCreator = function (configuration) {
131
131
  };
132
132
  }),
133
133
  /**
134
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
134
+ * 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).
135
135
  * @summary Get an event by id
136
136
  * @param {number} id Item id
137
137
  * @param {*} [options] Override http request option.
@@ -173,7 +173,7 @@ const LogApiFp = function (configuration) {
173
173
  const localVarAxiosParamCreator = (0, exports.LogApiAxiosParamCreator)(configuration);
174
174
  return {
175
175
  /**
176
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
176
+ * 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).
177
177
  * @summary List events
178
178
  * @param {number} [companyId] Company id
179
179
  * @param {string} [endpoint]
@@ -202,7 +202,7 @@ const LogApiFp = function (configuration) {
202
202
  });
203
203
  },
204
204
  /**
205
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
205
+ * 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).
206
206
  * @summary Get an event by id
207
207
  * @param {number} id Item id
208
208
  * @param {*} [options] Override http request option.
@@ -227,7 +227,7 @@ const LogApiFactory = function (configuration, basePath, axios) {
227
227
  const localVarFp = (0, exports.LogApiFp)(configuration);
228
228
  return {
229
229
  /**
230
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
230
+ * 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).
231
231
  * @summary List events
232
232
  * @param {number} [companyId] Company id
233
233
  * @param {string} [endpoint]
@@ -250,7 +250,7 @@ const LogApiFactory = function (configuration, basePath, axios) {
250
250
  return localVarFp.logGet(companyId, endpoint, method, apiVerion, statusCode, dateCreatedFrom, dateCreatedTo, page, pageSize, sort, query, success, dateTimeFrom, dateTimeTo, options).then((request) => request(axios, basePath));
251
251
  },
252
252
  /**
253
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
253
+ * 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).
254
254
  * @summary Get an event by id
255
255
  * @param {number} id Item id
256
256
  * @param {*} [options] Override http request option.
@@ -267,7 +267,7 @@ exports.LogApiFactory = LogApiFactory;
267
267
  */
268
268
  class LogApi extends base_1.BaseAPI {
269
269
  /**
270
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
270
+ * 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).
271
271
  * @summary List events
272
272
  * @param {number} [companyId] Company id
273
273
  * @param {string} [endpoint]
@@ -290,7 +290,7 @@ class LogApi extends base_1.BaseAPI {
290
290
  return (0, exports.LogApiFp)(this.configuration).logGet(companyId, endpoint, method, apiVerion, statusCode, dateCreatedFrom, dateCreatedTo, page, pageSize, sort, query, success, dateTimeFrom, dateTimeTo, options).then((request) => request(this.axios, this.basePath));
291
291
  }
292
292
  /**
293
- * Every API operation is logged and can be retrieved here. Log records are preserved for 15 days.
293
+ * 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).
294
294
  * @summary Get an event by id
295
295
  * @param {number} id Item id
296
296
  * @param {*} [options] Override http request option.
@@ -18,7 +18,7 @@ import type { Receive } from '../../src/models';
18
18
  */
19
19
  export declare const ReceiveApiAxiosParamCreator: (configuration?: Configuration) => {
20
20
  /**
21
- * 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.
21
+ * 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/).
22
22
  * @summary List incoming invoices
23
23
  * @param {number} [companyId] Company id
24
24
  * @param {string} [identifier] SDI identifier.
@@ -42,7 +42,7 @@ export declare const ReceiveApiAxiosParamCreator: (configuration?: Configuration
42
42
  */
43
43
  receiveGet: (companyId?: number, identifier?: string, unread?: boolean, committente?: string, prestatore?: string, fileName?: string, lastUpdateFrom?: string, lastUpdateTo?: string, dateSentFrom?: string, dateSentTo?: string, documentDateFrom?: string, documentDateTo?: string, documentNumber?: string, includePayload?: boolean, page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
44
44
  /**
45
- * 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.
45
+ * 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/).
46
46
  * @summary Delete an incoming invoice by id
47
47
  * @param {number} id Item id
48
48
  * @param {*} [options] Override http request option.
@@ -50,7 +50,7 @@ export declare const ReceiveApiAxiosParamCreator: (configuration?: Configuration
50
50
  */
51
51
  receiveIdDelete: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
52
52
  /**
53
- * 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.
53
+ * 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/).
54
54
  * @summary Get an incoming invoice by id
55
55
  * @param {number} id Item id
56
56
  * @param {boolean} [includePayload] Include payload in the response. Defaults to false.
@@ -64,7 +64,7 @@ export declare const ReceiveApiAxiosParamCreator: (configuration?: Configuration
64
64
  */
65
65
  export declare const ReceiveApiFp: (configuration?: Configuration) => {
66
66
  /**
67
- * 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.
67
+ * 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/).
68
68
  * @summary List incoming invoices
69
69
  * @param {number} [companyId] Company id
70
70
  * @param {string} [identifier] SDI identifier.
@@ -88,7 +88,7 @@ export declare const ReceiveApiFp: (configuration?: Configuration) => {
88
88
  */
89
89
  receiveGet(companyId?: number, identifier?: string, unread?: boolean, committente?: string, prestatore?: string, fileName?: string, lastUpdateFrom?: string, lastUpdateTo?: string, dateSentFrom?: string, dateSentTo?: string, documentDateFrom?: string, documentDateTo?: string, documentNumber?: string, includePayload?: boolean, page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Receive>>>;
90
90
  /**
91
- * 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.
91
+ * 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/).
92
92
  * @summary Delete an incoming invoice by id
93
93
  * @param {number} id Item id
94
94
  * @param {*} [options] Override http request option.
@@ -96,7 +96,7 @@ export declare const ReceiveApiFp: (configuration?: Configuration) => {
96
96
  */
97
97
  receiveIdDelete(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Receive>>;
98
98
  /**
99
- * 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.
99
+ * 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/).
100
100
  * @summary Get an incoming invoice by id
101
101
  * @param {number} id Item id
102
102
  * @param {boolean} [includePayload] Include payload in the response. Defaults to false.
@@ -110,7 +110,7 @@ export declare const ReceiveApiFp: (configuration?: Configuration) => {
110
110
  */
111
111
  export declare const ReceiveApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
112
112
  /**
113
- * 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.
113
+ * 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/).
114
114
  * @summary List incoming invoices
115
115
  * @param {number} [companyId] Company id
116
116
  * @param {string} [identifier] SDI identifier.
@@ -134,7 +134,7 @@ export declare const ReceiveApiFactory: (configuration?: Configuration, basePath
134
134
  */
135
135
  receiveGet(companyId?: number, identifier?: string, unread?: boolean, committente?: string, prestatore?: string, fileName?: string, lastUpdateFrom?: string, lastUpdateTo?: string, dateSentFrom?: string, dateSentTo?: string, documentDateFrom?: string, documentDateTo?: string, documentNumber?: string, includePayload?: boolean, page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Receive>>;
136
136
  /**
137
- * 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.
137
+ * 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/).
138
138
  * @summary Delete an incoming invoice by id
139
139
  * @param {number} id Item id
140
140
  * @param {*} [options] Override http request option.
@@ -142,7 +142,7 @@ export declare const ReceiveApiFactory: (configuration?: Configuration, basePath
142
142
  */
143
143
  receiveIdDelete(id: number, options?: RawAxiosRequestConfig): AxiosPromise<Receive>;
144
144
  /**
145
- * 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.
145
+ * 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/).
146
146
  * @summary Get an incoming invoice by id
147
147
  * @param {number} id Item id
148
148
  * @param {boolean} [includePayload] Include payload in the response. Defaults to false.
@@ -156,7 +156,7 @@ export declare const ReceiveApiFactory: (configuration?: Configuration, basePath
156
156
  */
157
157
  export interface ReceiveApiInterface {
158
158
  /**
159
- * 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.
159
+ * 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/).
160
160
  * @summary List incoming invoices
161
161
  * @param {number} [companyId] Company id
162
162
  * @param {string} [identifier] SDI identifier.
@@ -180,7 +180,7 @@ export interface ReceiveApiInterface {
180
180
  */
181
181
  receiveGet(companyId?: number, identifier?: string, unread?: boolean, committente?: string, prestatore?: string, fileName?: string, lastUpdateFrom?: string, lastUpdateTo?: string, dateSentFrom?: string, dateSentTo?: string, documentDateFrom?: string, documentDateTo?: string, documentNumber?: string, includePayload?: boolean, page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Receive>>;
182
182
  /**
183
- * 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.
183
+ * 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/).
184
184
  * @summary Delete an incoming invoice by id
185
185
  * @param {number} id Item id
186
186
  * @param {*} [options] Override http request option.
@@ -188,7 +188,7 @@ export interface ReceiveApiInterface {
188
188
  */
189
189
  receiveIdDelete(id: number, options?: RawAxiosRequestConfig): AxiosPromise<Receive>;
190
190
  /**
191
- * 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.
191
+ * 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/).
192
192
  * @summary Get an incoming invoice by id
193
193
  * @param {number} id Item id
194
194
  * @param {boolean} [includePayload] Include payload in the response. Defaults to false.
@@ -202,7 +202,7 @@ export interface ReceiveApiInterface {
202
202
  */
203
203
  export declare class ReceiveApi extends BaseAPI implements ReceiveApiInterface {
204
204
  /**
205
- * 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.
205
+ * 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/).
206
206
  * @summary List incoming invoices
207
207
  * @param {number} [companyId] Company id
208
208
  * @param {string} [identifier] SDI identifier.
@@ -226,7 +226,7 @@ export declare class ReceiveApi extends BaseAPI implements ReceiveApiInterface {
226
226
  */
227
227
  receiveGet(companyId?: number, identifier?: string, unread?: boolean, committente?: string, prestatore?: string, fileName?: string, lastUpdateFrom?: string, lastUpdateTo?: string, dateSentFrom?: string, dateSentTo?: string, documentDateFrom?: string, documentDateTo?: string, documentNumber?: string, includePayload?: boolean, page?: number, pageSize?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Receive[], any, {}>>;
228
228
  /**
229
- * 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.
229
+ * 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/).
230
230
  * @summary Delete an incoming invoice by id
231
231
  * @param {number} id Item id
232
232
  * @param {*} [options] Override http request option.
@@ -234,7 +234,7 @@ export declare class ReceiveApi extends BaseAPI implements ReceiveApiInterface {
234
234
  */
235
235
  receiveIdDelete(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Receive, any, {}>>;
236
236
  /**
237
- * 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.
237
+ * 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/).
238
238
  * @summary Get an incoming invoice by id
239
239
  * @param {number} id Item id
240
240
  * @param {boolean} [includePayload] Include payload in the response. Defaults to false.
@@ -38,7 +38,7 @@ const base_1 = require("../../base");
38
38
  const ReceiveApiAxiosParamCreator = function (configuration) {
39
39
  return {
40
40
  /**
41
- * 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.
41
+ * 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/).
42
42
  * @summary List incoming invoices
43
43
  * @param {number} [companyId] Company id
44
44
  * @param {string} [identifier] SDI identifier.
@@ -147,7 +147,7 @@ const ReceiveApiAxiosParamCreator = function (configuration) {
147
147
  };
148
148
  }),
149
149
  /**
150
- * 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.
150
+ * 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/).
151
151
  * @summary Delete an incoming invoice by id
152
152
  * @param {number} id Item id
153
153
  * @param {*} [options] Override http request option.
@@ -180,7 +180,7 @@ const ReceiveApiAxiosParamCreator = function (configuration) {
180
180
  };
181
181
  }),
182
182
  /**
183
- * 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.
183
+ * 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/).
184
184
  * @summary Get an incoming invoice by id
185
185
  * @param {number} id Item id
186
186
  * @param {boolean} [includePayload] Include payload in the response. Defaults to false.
@@ -226,7 +226,7 @@ const ReceiveApiFp = function (configuration) {
226
226
  const localVarAxiosParamCreator = (0, exports.ReceiveApiAxiosParamCreator)(configuration);
227
227
  return {
228
228
  /**
229
- * 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.
229
+ * 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/).
230
230
  * @summary List incoming invoices
231
231
  * @param {number} [companyId] Company id
232
232
  * @param {string} [identifier] SDI identifier.
@@ -258,7 +258,7 @@ const ReceiveApiFp = function (configuration) {
258
258
  });
259
259
  },
260
260
  /**
261
- * 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.
261
+ * 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/).
262
262
  * @summary Delete an incoming invoice by id
263
263
  * @param {number} id Item id
264
264
  * @param {*} [options] Override http request option.
@@ -274,7 +274,7 @@ const ReceiveApiFp = function (configuration) {
274
274
  });
275
275
  },
276
276
  /**
277
- * 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.
277
+ * 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/).
278
278
  * @summary Get an incoming invoice by id
279
279
  * @param {number} id Item id
280
280
  * @param {boolean} [includePayload] Include payload in the response. Defaults to false.
@@ -300,7 +300,7 @@ const ReceiveApiFactory = function (configuration, basePath, axios) {
300
300
  const localVarFp = (0, exports.ReceiveApiFp)(configuration);
301
301
  return {
302
302
  /**
303
- * 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.
303
+ * 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/).
304
304
  * @summary List incoming invoices
305
305
  * @param {number} [companyId] Company id
306
306
  * @param {string} [identifier] SDI identifier.
@@ -326,7 +326,7 @@ const ReceiveApiFactory = function (configuration, basePath, axios) {
326
326
  return localVarFp.receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, options).then((request) => request(axios, basePath));
327
327
  },
328
328
  /**
329
- * 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.
329
+ * 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/).
330
330
  * @summary Delete an incoming invoice by id
331
331
  * @param {number} id Item id
332
332
  * @param {*} [options] Override http request option.
@@ -336,7 +336,7 @@ const ReceiveApiFactory = function (configuration, basePath, axios) {
336
336
  return localVarFp.receiveIdDelete(id, options).then((request) => request(axios, basePath));
337
337
  },
338
338
  /**
339
- * 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.
339
+ * 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/).
340
340
  * @summary Get an incoming invoice by id
341
341
  * @param {number} id Item id
342
342
  * @param {boolean} [includePayload] Include payload in the response. Defaults to false.
@@ -354,7 +354,7 @@ exports.ReceiveApiFactory = ReceiveApiFactory;
354
354
  */
355
355
  class ReceiveApi extends base_1.BaseAPI {
356
356
  /**
357
- * 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.
357
+ * 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/).
358
358
  * @summary List incoming invoices
359
359
  * @param {number} [companyId] Company id
360
360
  * @param {string} [identifier] SDI identifier.
@@ -380,7 +380,7 @@ class ReceiveApi extends base_1.BaseAPI {
380
380
  return (0, exports.ReceiveApiFp)(this.configuration).receiveGet(companyId, identifier, unread, committente, prestatore, fileName, lastUpdateFrom, lastUpdateTo, dateSentFrom, dateSentTo, documentDateFrom, documentDateTo, documentNumber, includePayload, page, pageSize, sort, options).then((request) => request(this.axios, this.basePath));
381
381
  }
382
382
  /**
383
- * 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.
383
+ * 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/).
384
384
  * @summary Delete an incoming invoice by id
385
385
  * @param {number} id Item id
386
386
  * @param {*} [options] Override http request option.
@@ -390,7 +390,7 @@ class ReceiveApi extends base_1.BaseAPI {
390
390
  return (0, exports.ReceiveApiFp)(this.configuration).receiveIdDelete(id, options).then((request) => request(this.axios, this.basePath));
391
391
  }
392
392
  /**
393
- * 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.
393
+ * 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/).
394
394
  * @summary Get an incoming invoice by id
395
395
  * @param {number} id Item id
396
396
  * @param {boolean} [includePayload] Include payload in the response. Defaults to false.