Search for electronic invoices#

This endpoint is used to search for all received document in different statuses. There are multiple search criteria available that retrieves several document informations, including the document id, necessary to get the physical document.

Endpoint steps#

  1. Get a token from your credentials by calling the endpoint Account/getToken;

  2. Search for invoices through the endpoint InboundFinancialDocument/search, by specifying the necessary criteria;

  3. Once the request has finished successfully you should store the document id in case you need to obtain the document content in the legal format.

Response structure from server#

When a request is well formed and the authentication data is correct the system responds with a message envelope as follows:

{
	"CorrelationId": "<GUID>", /* for correlation purposes */
	"IsValid": true,           /* false in case of erros */
	"Errors": [],              /* if empty is a good signal */
	"Data": "<Service Response Data>"   /* the data retuned ex: token, invoice status, dependent on the endpoint called */
}

Endpoint Server Base URL#

# Test Environment
server_base_adress = "dcn-solution-qa.saphety.com/Dcn.Business.WebApi"

# Saphety Invoice Network - Production Environment
#server_base_adress = "dcn-solution.saphety.com/Dcn.Business.WebApi"

1. Get a token (Account/getToken)#

Get a token from your account credentials using endpoint api/Account/getToken
Check here how to obtain an authentication token.