Über die GraphQL Schnittstelle lassen sich alle Dokumente abfragen, welche in HERO erstellt oder hochgeladen wurden:
query {
customer_documents {
id
created
nr
value
vat
status_code
partner_id
document_type {
name
id
}
file_upload {
url
}
}
}
id: Die systeminterne Dokumenten-ID
created: Das Erstellungsdatum des Dokuments
nr: Die accountinterne Nummer des Dokuments
value: Der Nettowert des Dokuments
vat: Die Mehrwehrtsteuer in % (value-after-tax)
status_code: Der systeminterne Status-Code des Dokuments
partner_id: Die systeminterne ID der Dokumentenersteller*in
name: Der Name des Dokumenttyps
document_type\id: Die ID des Dokumenttyps
url: Der Link zum Dokument
Zu beachten ist, dass die URL im JSON-Format gespeichert wird, weshalb den “/“-Zeichen ein “\“ vorgestellt wird. Um daraus die URL zu gewinnen, kann z.B. ein JSON Decoder verwendet werden.
Die Codes für den Status bedeuten Folgendes:
status_code | Bedeutung |
0 |
Entwurf |
100 | Erstellt |
200 | Versendet |
600 | Storniert |
1000 | Gelöscht |