API

We follow a standard API REST-ish interface on our endpoints and try to adhere to the standard/common return codes and behaviors of any standard API.

We are using the UBL standard messaging formats for our integrations through the API, but you should note that we only use a subset of UBL as specified by Peppol (peppol.eu)

As many of Qvalia's services are compatible with Peppol the data validation is also done using the Peppol standards. For example the Invoice endpoint strictly follows BIS Billing 3.0, https://docs.peppol.eu/poacc/billing/3.0/

This means that, although the JSON format is based upon UBL JSON we only allow the subset stated from https://docs.peppol.eu/poacc/billing/3.0/ for the Invoice and CreditNote message types, see the “Syntax” section!

For Order and OrderResponse you'll find the documentation at: https://docs.peppol.eu/poacc/upgrade-3/

Authentication

We use API keys for the Authentication of requests. You can get your API key from our Support team and you’ll get a separate key and URL for Production and Test environments. All requests are using HTTPS with a minimum of TLS 1.2

Each request made to the API will contain your registration number which is your account identifier for your Qvalia account. Your account identifier will be provided to you from the Support team during the onboarding process.

Your requests must use the registration number as e.g. POST /{registration_number}/invoices/outgoing

UBL JSON Representation standard

For the JSON representation of the format please refer to http://docs.oasis-open.org/ubl/UBL-2.1-JSON/v2.0/UBL-2.1-JSON-v2.0.html

UBL JSON samples and schemas can be found here: http://docs.oasis-open.org/ubl/UBL-2.1-JSON/v2.0/cnd01/

UBL XML Representation standard

For the XML representation, https://docs.oasis-open.org/ubl/UBL-2.1.html

The UBL version 2.1 has been selected due to the many compliant standars with UBL 2.1, mainly the Peppol standard (peppol.eu).

XML samples and XML schemas can be found here: http://docs.oasis-open.org/ubl/os-UBL-2.1/

Required

As the UBL JSON schema is fairly big, we only list the required attributes in the sample request and response data. You can browse the complete JSON schema viewing the UBL-Invoice-2.1.

Note the difference in objects below, only IssueDate is required, and thus IssueTime won't be listed in the sample request/responses:

Attachments

Often our customers wants to add, or request, attached documents to their messages, e.g. their invoices.

We support all the same attachments as Peppol does: Peppol media types

See more under Attachments to messages

SFTP Integration

Qvalia is also offering integration through SFTP. If you have opted for the SFTP integration please read more here: SFTP Integration