In this tutorial we build a simple C# console application that connects and authenticates with the Invoicetronic API and uploads outbound invoices to SDI FatturaPA.
Before continuing, make sure all the prerequisites below are met.
Prerequisites
We assume that these prerequisites are met:
- The .NET SDK has been downloaded and installed
- You obtained an active API Key
- You registered with the Italian Revenue Service (needed for the live environment)
We use the dotnet
tool and VS Code as they are available on most systems, but you can follow along with your favourite IDE (Visual Studio, Rider, etc.) if you prefer.
For an optimal C# experience in VS Code, you want to ensure that the C# Dev Kit extension is installed and enabled. For more information, see Getting Started with C# in VS Code.
Create the app
The first step is to create the application:
dotnet new console -n send
The command created a new C# project named "quickstart" in a directory with the same name. Step into that directory:
cd send
Install the SDK
Once in the quickstart directory, install the C# SDK:
dotnet add package Invoicetronic.Sdk
Once that's done, open VS Code in the current directory:
code .
Click on the Program.cs file to see its contents in VS Code right pane.
Configure the SDK
Replace Program.cs default content with the following:
using Invoicetronic.Sdk.Api;
using Invoicetronic.Sdk.Client;
using Invoicetronic.Sdk.Model;
// Configure the SDK.
var config = new Configuration
{
BasePath = "https://api.invoicetronic.com/v1",
Username = "YOUR TEST API KEY (starts with ik_test_)"
};
As you can see, we initialize a Configuration
instance by setting the API's base path and your test API Key (not the live one). Notice how we use the Username
property to set the API Key.
When you create your account, you obtain a pair of API Keys. One is the test key for the API Sandbox, and the other is the live API's. You can tell the difference because the former starts with ik_test_
, while the latter begins with ik_live_
. In this tutorial, always use the test key.
Send an invoice
We are ready to make a request. We want to send an invoice to the SDI. Add the following code:
// Send an invoice
var filePath = "/some/file/path/filename.xml";
var metaData = new Dictionary<string, string>
{
{ "internal_id", "123" },
{ "created_with", "myapp" },
{ "some_other_custom_data", "value" },
};
var sendApi = new SendApi(config);
try
{
var sentInvoice = await sendApi.SendPostAsync(new Send()
{
FileName = Path.GetFileName(filePath),
Payload = File.ReadAllText(filePath),
MetaData = metaData
});
Console.WriteLine($"The invoice was sent successfully, it now has the unique Id of {sentInvoice.Id}.");
}
catch (ApiException e)
{
Console.WriteLine($"{e.Message} - {e.ErrorCode}");
}
Switch to the terminal and type:
dotnet run
You should obtain an output similar to this one:
The invoice filename.xml was sent successfully, it now has the unique Id of 123.
What we learned
In this example, we learned several things.
We must configure the SDK by setting both the
BasePath
andUsername
properties, the latter initialized with the API key.We must instantiate a class representing the endpoint we want to work with. In this case, we leverage
SendApi
to send invoices. Endpoint classes likeSendApi
offer methods for interacting with their target entity. We callInvoiceV1SendPosttAsync
to send an invoice.The
Send
class exposes valuable properties such asFileName
,MetaData
, andPayload
. The last one contains the invoice content, whileMetaData
is optional and binds custom data to the document.
Top comments (0)