EasyExchange.Sdk
1.10.1
dotnet add package EasyExchange.Sdk --version 1.10.1
NuGet\Install-Package EasyExchange.Sdk -Version 1.10.1
<PackageReference Include="EasyExchange.Sdk" Version="1.10.1" />
paket add EasyExchange.Sdk --version 1.10.1
#r "nuget: EasyExchange.Sdk, 1.10.1"
// Install EasyExchange.Sdk as a Cake Addin
#addin nuget:?package=EasyExchange.Sdk&version=1.10.1
// Install EasyExchange.Sdk as a Cake Tool
#tool nuget:?package=EasyExchange.Sdk&version=1.10.1
Easy Exchange SDK
Overview
EasyExchange Sdk is a ready to use C# Client to connect to the Easy Exchange Services.
Version information
EasyExchange.Sdk (version 1.x) is based on the .Net Framework 4.5.2 platform. EasyExchange.Sdk.Core (version 2.0 and above) is based on .Net Standard 2.0 platform.
Getting started
1: Get Authentication keys
Contact our sales department to obtain the necessary Authentication keys for your application. You will receive:
- Client ID - The client_id is a public identifier for your application. Even though it's public, it's best that it isn't guessable by third parties, so keep it private within your organization.
- Client Secret - The client_secret is a secret known only to your application and our authorization server.
- Scopes - A list of API Permissions you are allowed to use
- username - a testuser to test things on our test environment
- password
2: Implement the API
Implement the API using our Walkthrough or checkout our sample project on github
3: Test it
We have a test environment ready for you to test things during development of the connection. The url needed for this is https:/easyexchange-partners.es-prd.net
4: Ship your software
Don't forget to ship it using the production url for our services: https://easyexchange.es-prd.net
Samples
For a set of samples on how to use this sdk please visit our Sample code
Walkthroughs
Below you find a short description on all endpoints and how to use them.
SalesInvoices
Get a list of SalesInvoices
Response is a list of Invoices.
Get a SalesInvoice By Id
Using your document ID you can request the SalesInvoice and retrieve information about the invoice: Status and sending details
Post a SalesInvoice by PDF + metadata
When calling the PostAsync method the supplied document is directly stored. If the document is valid it is accepted and the call will return the unique code of the posted document in the form of an Id. Store this Id for later use. If there is no Id returned the response should contain information why the document was not accepted.
Get a SalesInvoice Image
Using your document ID you can request the SalesInvoice Image of that document using the call GetImageAsync. Response:
- FileName
- ContentType
- DataUri
PurchaseInvoices
The proces to retrieve new PurchaseInvoices is divided in three steps:
- Get a list of new Documents The result is an array of Ids. With each Id you make the following calls:
- Get Document Details to get more details about the actual document
- Get Document Xml in EN 16931 Ubl format
- Get Document Original Xml
- Confirm you have receieved the document
Get a list new Documents
Response is a list of Ids.
Get Document Details to get more details about the actual document
Response is all details about the Document
Get Document Xml in EN 16931 Ubl format
Response is the actual xml of the Document
Get Document Original Xml
When document details state it has an original you can use this method to download the original xml
Post Confirm Document as received
StatusCode 200 marks the confirm as completed
SmpLookup
Search through the Peppol directory
Find
Find a participant by its iso5623 code and value and list all supported documents
PeppolDocuments
Classify and validate Xml messages meant to be sent to Peppol Addresses
Validate
Validate XML based on its classification. XML has to be supplied in Base64
Classify
Determin the classification of given XML. XML has to be supplied in Base64
More information
For more information check our website
Acknowledgements
EasyExchange Sdk is built using the following projects
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET Framework | net452 is compatible. net46 was computed. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
-
.NETFramework 4.5.2
- IdentityModel (>= 3.10.7)
- Refit (>= 4.4.17)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.10.1 | 621 | 4/30/2021 |
1.10.0 | 352 | 4/30/2021 |
1.9.1 | 334 | 4/20/2021 |
1.8.0 | 1,064 | 7/19/2019 |
1.7.3 | 572 | 7/9/2019 |
1.7.2 | 590 | 7/8/2019 |
1.7.0 | 570 | 7/2/2019 |
1.6.2 | 639 | 5/28/2019 |
1.6.2-beta | 452 | 5/28/2019 |
1.6.1-beta | 461 | 5/28/2019 |
1.6.0 | 584 | 5/17/2019 |
1.5.1 | 655 | 4/15/2019 |
1.4.0 | 685 | 4/1/2019 |
1.3.0-beta | 469 | 3/29/2019 |
1.2.0 | 623 | 3/27/2019 |
1.1.2 | 631 | 3/22/2019 |
1.1.1 | 649 | 3/22/2019 |
1.0.6.175 | 772 | 11/1/2018 |
1.0.5.173 | 902 | 11/1/2018 |
1.0.4.171 | 733 | 10/24/2018 |
1.0.3.169 | 714 | 10/24/2018 |
1.0.1.162 | 770 | 10/22/2018 |
1.0.0.155-alpha | 704 | 10/9/2018 |