Docs

Die Betreuungsliste: abgelehnte und im Zustand dead_letter gelandete Rechnungen mit dem Katalogcode und wer handelt

  • In der Sandbox

In einfachen Worten

Listet die abgelehnten und endgültig fehlgeschlagenen Rechnungen (dead letter) mit dem Katalogcode und wer handelt.
GET
/care

Seit 0.15.0 liest ein Kundenschlüssel mit dem Scope read die Zeilen seines eigenen Kunden, sodass ein Unternehmen seine eigenen abgelehnten Rechnungen sehen kann. Ein Kundenschlüssel erhält höchstens die neuesten 200 Zeilen im angefragten status, mit truncated: true, wenn es mehr gibt; seit 0.18.2 wird zuerst nach Status gefiltert, sodass eine alte offene Zeile nie hinter neueren erledigten verschwindet. Er darf 30-mal pro Minute abrufen (danach 429). Der Schlüssel des Betreibers sieht die Zeilen aller Kunden, oder mit client die eines Kunden.

Autorisierung

apiKey
headerAuthorizationBearer <token>

Senden Sie Ihren Schlüssel als Bearer-Token: Authorization: Bearer <your-api-key>. Der Systemzustand ist der einzige Aufruf, der keinen Schlüssel braucht.

Query-Parameter

status?string

open (noch nicht erledigt), handled oder all. Der Standard ist all, wie vor 0.8.0.

Standard"all"
Wert in"open""handled""all"
client?string

Der Filter des Betreibers auf einen Kunden. Ein Kundenschlüssel darf nur seinen eigenen Kunden nennen; jeder andere wird mit 404 beantwortet. Eine andere Form wird mit 400 beantwortet.

Muster^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

Antwort-Body

data: eine Zeile je Rechnung und Code.

application/json
  1. response
data*array<>
truncated?boolean

Vorhanden und true, wenn die Liste eines Kundenschlüssels vor dem Statusfilter auf die neuesten 200 Zeilen gekürzt wurde.

curl -X GET "https://example.com/care" \  -H "Authorization: Bearer <your-api-key>"
{  "data": [    {      "invoice_id": "string",      "catalogue_code": "string",      "who_acts": "us",      "age_seconds": 0,      "handled": true,      "handled_at": "2019-08-24T14:15:22Z",      "route": "PEPPOL",      "client": "string",      "invoice_ref": "string",      "deadline_at": "2019-08-24T14:15:22Z",      "field": "string",      "fix_hint": "string"    }  ],  "truncated": true}