Skip to content

UpdateApi.md

Latest commit

 

History

History
134 lines (94 loc) · 7.86 KB

UpdateApi.md

File metadata and controls

134 lines (94 loc) · 7.86 KB

invoicetronicSdk.UpdateApi

All URIs are relative to http://localhost

Method HTTP request Description
updateGet GET /update List updates
updateIdGet GET /update/{id} Get an update by id

updateGet

[Update] updateGet(opts)

List updates

Retrieve a paginated list of updates. Results can be filtered by various criteria such as company, send item, SDI state, and date ranges. Updates are status notifications from Italy's SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient's tax drawer, but it was not possible to deliver it to the recipient's reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | Cost: Querying this endpoint is free and does not count as an operation against your plan limits. Important: Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was not successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.

Example

import invoicetronicSdk from '@invoicetronic/js-sdk';
let defaultClient = invoicetronicSdk.ApiClient.instance;
// Configure HTTP basic authorization: Basic
let Basic = defaultClient.authentications['Basic'];
Basic.username = 'YOUR USERNAME';
Basic.password = 'YOUR PASSWORD';

let apiInstance = new invoicetronicSdk.UpdateApi();
let opts = {
  'companyId': 56, // Number | Company id
  'identifier': "identifier_example", // String | SDI identifier.
  'prestatore': "prestatore_example", // String | Vat number or fiscal code.
  'unread': true, // Boolean | Unread items only.
  'sendId': 56, // Number | Send item's id.
  'state': "state_example", // String | SDI state
  'lastUpdateFrom': new Date("2013-10-20T19:20:30+01:00"), // Date | UTC ISO 8601 (2024-11-29T12:34:56Z)
  'lastUpdateTo': new Date("2013-10-20T19:20:30+01:00"), // Date | UTC ISO 8601 (2024-11-29T12:34:56Z)
  'dateSentFrom': new Date("2013-10-20T19:20:30+01:00"), // Date | UTC ISO 8601 (2024-11-29T12:34:56Z)
  'dateSentTo': new Date("2013-10-20T19:20:30+01:00"), // Date | UTC ISO 8601 (2024-11-29T12:34:56Z)
  'page': 1, // Number | Page number.
  'pageSize': 100, // Number | Items per page. Cannot be greater than 200.
  'sort': "'last_update'" // String | Sort by field. Prefix with '-' for descending order.
};
apiInstance.updateGet(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
companyId Number Company id [optional]
identifier String SDI identifier. [optional]
prestatore String Vat number or fiscal code. [optional]
unread Boolean Unread items only. [optional]
sendId Number Send item's id. [optional]
state String SDI state [optional]
lastUpdateFrom Date UTC ISO 8601 (2024-11-29T12:34:56Z) [optional]
lastUpdateTo Date UTC ISO 8601 (2024-11-29T12:34:56Z) [optional]
dateSentFrom Date UTC ISO 8601 (2024-11-29T12:34:56Z) [optional]
dateSentTo Date UTC ISO 8601 (2024-11-29T12:34:56Z) [optional]
page Number Page number. [optional] [default to 1]
pageSize Number Items per page. Cannot be greater than 200. [optional] [default to 100]
sort String Sort by field. Prefix with '-' for descending order. [optional] [default to 'last_update']

Return type

[Update]

Authorization

Basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateIdGet

Update updateIdGet(id)

Get an update by id

Retrieve an update by its internal id. Updates are status notifications from Italy's SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient's tax drawer, but it was not possible to deliver it to the recipient's reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | Cost: Querying this endpoint is free and does not count as an operation against your plan limits. Important: Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was not successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.

Example

import invoicetronicSdk from '@invoicetronic/js-sdk';
let defaultClient = invoicetronicSdk.ApiClient.instance;
// Configure HTTP basic authorization: Basic
let Basic = defaultClient.authentications['Basic'];
Basic.username = 'YOUR USERNAME';
Basic.password = 'YOUR PASSWORD';

let apiInstance = new invoicetronicSdk.UpdateApi();
let id = 56; // Number | Item id
apiInstance.updateIdGet(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number Item id

Return type

Update

Authorization

Basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json