Step 1: Get access
Step 2: Get an API user
If you have been identified as a valid sender end/or receiver you will get a userId and password. The PartyId’s for organisations used for sending and receiving are attached to this userid. The user can have several rights assigned for a partyId and can create hooks for getting information about sending and receiving documents.
Step 3: Test the functionality
You can test the working with the SWAGGER UI
A PartyId is an identifier that is registered in the PEPPOL network. The PartyId is used for discovery of receivers and the routing of documents.
There are several type of identifiers that can be registered. Most used in the Netherlands are KvK, VAT and OIN. Examples: NL:KVK:12345678, 0106:12345678, NL:VAT:NL12345678B01, 9944:NL12345678B01 or NL:OIN:00000001003214345000.
Get information about the User and the PartyId’s registered.
With the PurchaseInvoice endpoint you can download a document that is sent to your organisation or investigate the status history. You will need a PartyId from the organisation where the document is sent to and a documentId of the document. The documentId is pushed to you when the document arrives.
With the SalesInvoice endpoint you can send a document to a other organisation or investigate the status. You will need a partyid from the organisation where the document is send to and a valid SimplerInvoicing 1.2 document. With the call queryRecipientParty you can get advise on which partyId to be used. Advise is based on registration of partyId and type of documents that is registered for the partyID.
A hook is a setting that defines how information is delivered back to the user. This can be via mail or a push connection about the following topics InvoiceReceived, InvoiceReceivedError, InvoiceSent, InvoiceSentError, InvoiceSentRetry. With the Hook endpoint you can create a hook. With a hook you can indicate how information is pushed to you. Via the push hook you will get informed about the arrival of documents.
Step 4: Use the API in you environment
The SWAGGER UI is a good example how the API’s can be used. But if you use your own code you need to retrieve the bearer token with your own code to login. The other API code can be generated with swagger to code generators.