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: 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.

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