Andere Endpunkte

Liste der Formate

Eine Liste der unterstützten Formate wird vom Endpunkt /api/format/list geliefert.

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

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

Zurückgeliefert wird eine Liste von Einträgen, die beispielsweise so aussehen:

{
    "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",
}

Die Bedeutung der einzelnen Felder ist:

• name: Der Name des Formats wie er bei der Erzeugung von Rechnungen angegeben werden muss.
• syntax: Die allgemeine Syntax des XML-Anteils, entweder CII oder UBL.
• mimeType: Entweder application/xml für reine XML-Formate oder application/pdf für hybride Formate (Factur-X/ZUGFeRD)
• customizationID: Die Customization-ID des Formats.
• profileID: Die Profil-ID des Formats.

Schemata

Auch die von der Software verwendeten JSON0Schema-Definitionen können ausgegeben werden.

Rechnungsschema

Dieser Endpunkt liefert das JSON-Schema für das interne Rechnungsformat:

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

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

Mapping-Schema

Dieser Endpunkt liefert das JSON-Schema für Mapping-Definitionen, die in der Regel in YAML übergeben werden:

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

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