Other Endpoints

List Formats

You can get a list of the supported formats with the endpoint /api/format/list.

curl http://localhost:3000/api/format/list

http http://localhost:300/api/format/list

It returns a list of entries that look - for example - like this:

{
    "name": "Factur-X-Extended",
    "syntax": "CII"
    "mimeType": "application/pdf",
    "customizationID": "urn:cen.eu:en16931:2017#conformant#urn:factur-x.eu:1p0:extended",
    "profileID": "urn:fdc:peppol.eu:2017:poacc:billing:01:1.0",
}

The meaning of the fields are:

• name: The name of the format as specified when creating invoices
• syntax: The general syntax of the XML portion, one of CII or UBL.
• mimeType: One of application/xml for pure XML formats or application/pdf for hybrid formats (Factur-X/ZUGFeRD)
• customizationID: The customization ID of the format.
• profileID: The profile ID of the format.

Schemas

You can also get the JSON Schema definitions used by the software.

Invoice Schema

This endpoint returns the JSON schema for the internal invoice format:

curl http://localhost:3000/api/schema/invoice

http http://localhost:300/api/schema/invoice

Mapping Schema

This endpoint returns the JSON schema for mapping definitions, usually given in YAML:

curl http://localhost:3000/api/schema/mapping

http http://localhost:300/api/schema/mapping