TypeScript SDK for the Invoicetronic API

The Invoicetronic API is a RESTful service that allows you to send and receive invoices through the Italian Servizio di Interscambio (SDI), 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

Before you start

For the full integration guide, tutorials, SDKs and quickstarts, see the Documentation. A few cross-cutting topics worth knowing before integrating:

• Prerequisites — what you need to start in Sandbox and what's required to move to production.
• API Keys — how ik_live_ and ik_test_ keys select the environment.
• Sandbox — free test environment that mirrors the live workflow, with no credits consumed.
• Rate Limiting — per-second, per-minute and per-day limits; how to handle 429 Too Many Requests.
• Pagination — page and page_size parameters and the Invoicetronic-Total-Count response header.
• CORS — calling the API from the browser; allowed origins are configured per key.
• Webhooks — real-time event notifications with HMAC-SHA256 signature validation.
• Localization — use the Accept-Language header to receive error messages in Italian, English or German.

@invoicetronic/ts-sdk@1.11

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @invoicetronic/ts-sdk@1.11 --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save