@invoicetronic/ts-sdk 1.0.0

package/docs/ReceiveApi.md

@@ -0,0 +1,220 @@
+# ReceiveApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**receiveGet**](#receiveget) | **GET** /receive | List incoming invoices|
+|[**receiveIdDelete**](#receiveiddelete) | **DELETE** /receive/{id} | Delete an incoming invoice by id|
+|[**receiveIdGet**](#receiveidget) | **GET** /receive/{id} | Get an incoming invoice by id|
+
+# **receiveGet**
+> Array<Receive> receiveGet()
+
+Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+
+### Example
+
+```typescript
+import {
+    ReceiveApi,
+    Configuration
+} from '@invoicetronic/ts-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReceiveApi(configuration);
+
+let companyId: number; //Company id (optional) (default to undefined)
+let identifier: string; //SDI identifier. (optional) (default to undefined)
+let unread: boolean; //Unread items only. (optional) (default to undefined)
+let committente: string; //Vat number or fiscal code. (optional) (default to undefined)
+let prestatore: string; //Vat number or fiscal code. (optional) (default to undefined)
+let fileName: string; //File name. (optional) (default to undefined)
+let lastUpdateFrom: string; //UTC ISO 8601 (2024-11-29T12:34:56Z) (optional) (default to undefined)
+let lastUpdateTo: string; //UTC ISO 8601 (2024-11-29T12:34:56Z) (optional) (default to undefined)
+let dateSentFrom: string; //UTC ISO 8601 (2024-11-29T12:34:56Z) (optional) (default to undefined)
+let dateSentTo: string; //UTC ISO 8601 (2024-11-29T12:34:56Z) (optional) (default to undefined)
+let documentDateFrom: string; //UTC ISO 8601 (2024-11-29T12:34:56Z) (optional) (default to undefined)
+let documentDateTo: string; //UTC ISO 8601 (2024-11-29T12:34:56Z) (optional) (default to undefined)
+let documentNumber: string; //Document number. (optional) (default to undefined)
+let includePayload: boolean; //Include payload in the response. Defaults to false. (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)
+
+const { status, data } = await apiInstance.receiveGet(
+    companyId,
+    identifier,
+    unread,
+    committente,
+    prestatore,
+    fileName,
+    lastUpdateFrom,
+    lastUpdateTo,
+    dateSentFrom,
+    dateSentTo,
+    documentDateFrom,
+    documentDateTo,
+    documentNumber,
+    includePayload,
+    page,
+    pageSize,
+    sort
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **companyId** | [**number**] | Company id | (optional) defaults to undefined|
+| **identifier** | [**string**] | SDI identifier. | (optional) defaults to undefined|
+| **unread** | [**boolean**] | Unread items only. | (optional) defaults to undefined|
+| **committente** | [**string**] | Vat number or fiscal code. | (optional) defaults to undefined|
+| **prestatore** | [**string**] | Vat number or fiscal code. | (optional) defaults to undefined|
+| **fileName** | [**string**] | File name. | (optional) defaults to undefined|
+| **lastUpdateFrom** | [**string**] | UTC ISO 8601 (2024-11-29T12:34:56Z) | (optional) defaults to undefined|
+| **lastUpdateTo** | [**string**] | UTC ISO 8601 (2024-11-29T12:34:56Z) | (optional) defaults to undefined|
+| **dateSentFrom** | [**string**] | UTC ISO 8601 (2024-11-29T12:34:56Z) | (optional) defaults to undefined|
+| **dateSentTo** | [**string**] | UTC ISO 8601 (2024-11-29T12:34:56Z) | (optional) defaults to undefined|
+| **documentDateFrom** | [**string**] | UTC ISO 8601 (2024-11-29T12:34:56Z) | (optional) defaults to undefined|
+| **documentDateTo** | [**string**] | UTC ISO 8601 (2024-11-29T12:34:56Z) | (optional) defaults to undefined|
+| **documentNumber** | [**string**] | Document number. | (optional) defaults to undefined|
+| **includePayload** | [**boolean**] | Include payload in the response. Defaults to false. | (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|
+
+
+### Return type
+
+**Array<Receive>**
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**404** | Not Found |  -  |
+|**400** | Bad Request |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **receiveIdDelete**
+> Receive receiveIdDelete()
+
+Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+
+### Example
+
+```typescript
+import {
+    ReceiveApi,
+    Configuration
+} from '@invoicetronic/ts-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReceiveApi(configuration);
+
+let id: number; //Item id (default to undefined)
+
+const { status, data } = await apiInstance.receiveIdDelete(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Item id | defaults to undefined|
+
+
+### Return type
+
+**Receive**
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**422** | Unprocessable Content |  -  |
+|**400** | Bad Request |  -  |
+|**404** | Not Found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **receiveIdGet**
+> Receive receiveIdGet()
+
+Receive invoices are the invoices that are received from other companies. They are preserved for two years in the live environment and 24 hours in the Sandbox.
+
+### Example
+
+```typescript
+import {
+    ReceiveApi,
+    Configuration
+} from '@invoicetronic/ts-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReceiveApi(configuration);
+
+let id: number; //Item id (default to undefined)
+let includePayload: boolean; //Include payload in the response. Defaults to false. (optional) (default to false)
+
+const { status, data } = await apiInstance.receiveIdGet(
+    id,
+    includePayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Item id | defaults to undefined|
+| **includePayload** | [**boolean**] | Include payload in the response. Defaults to false. | (optional) defaults to false|
+
+
+### Return type
+
+**Receive**
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**404** | Not Found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/ScontoMaggiorazione.md

@@ -0,0 +1,24 @@
+# ScontoMaggiorazione
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tipo** | **string** |  | [optional] [default to undefined]
+**percentuale** | **number** |  | [optional] [default to undefined]
+**importo** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ScontoMaggiorazione } from '@invoicetronic/ts-sdk';
+
+const instance: ScontoMaggiorazione = {
+    tipo,
+    percentuale,
+    importo,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SedeCedentePrestatore.md

@@ -0,0 +1,30 @@
+# SedeCedentePrestatore
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**indirizzo** | **string** |  | [optional] [default to undefined]
+**numero_civico** | **string** |  | [optional] [default to undefined]
+**cap** | **string** |  | [optional] [default to undefined]
+**comune** | **string** |  | [optional] [default to undefined]
+**provincia** | **string** |  | [optional] [default to undefined]
+**nazione** | **string** |  | [optional] [default to 'IT']
+
+## Example
+
+```typescript
+import { SedeCedentePrestatore } from '@invoicetronic/ts-sdk';
+
+const instance: SedeCedentePrestatore = {
+    indirizzo,
+    numero_civico,
+    cap,
+    comune,
+    provincia,
+    nazione,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SedeCessionarioCommittente.md

@@ -0,0 +1,30 @@
+# SedeCessionarioCommittente
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**indirizzo** | **string** |  | [optional] [default to undefined]
+**numero_civico** | **string** |  | [optional] [default to undefined]
+**cap** | **string** |  | [optional] [default to undefined]
+**comune** | **string** |  | [optional] [default to undefined]
+**provincia** | **string** |  | [optional] [default to undefined]
+**nazione** | **string** |  | [optional] [default to 'IT']
+
+## Example
+
+```typescript
+import { SedeCessionarioCommittente } from '@invoicetronic/ts-sdk';
+
+const instance: SedeCessionarioCommittente = {
+    indirizzo,
+    numero_civico,
+    cap,
+    comune,
+    provincia,
+    nazione,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Send.md

@@ -0,0 +1,52 @@
+# Send
+
+
+## Properties
+
+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 guaranted to be unique within the SDI system. | [optional] [default to undefined]
+**file_name** | **string** | Xml file name. | [optional] [default to undefined]
+**format** | **string** | SDI format (FPA12, FPR12, FSM10, ...) | [optional] [default to undefined]
+**payload** | **string** | Xml payloaad. This is the actual xml content, as string. On send, it can be base64 encoded. If it\'s not, it will be encoded before sending. It is guaranteed to be cyphered at rest. | [optional] [default to undefined]
+**last_update** | **string** | Last update from SDI. | [optional] [default to undefined]
+**date_sent** | **string** | When the invoice was sent to SDI. | [optional] [default to undefined]
+**documents** | [**Array<DocumentData>**](DocumentData.md) | The invoices included in the payload. This is set by the system, based on the xml content. | [optional] [default to undefined]
+**encoding** | **string** | Whether the payload is Base64 encoded or a plain XML (text). | [optional] [default to undefined]
+**meta_data** | **{ [key: string]: string; }** | Optional metadata, as json. | [optional] [default to undefined]
+**company** | [**Company**](Company.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Send } from '@invoicetronic/ts-sdk';
+
+const instance: Send = {
+    id,
+    created,
+    version,
+    user_id,
+    company_id,
+    committente,
+    prestatore,
+    identifier,
+    file_name,
+    format,
+    payload,
+    last_update,
+    date_sent,
+    documents,
+    encoding,
+    meta_data,
+    company,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)