The care list: rejected and dead-lettered invoices with the catalogue code and who acts
- In the sandbox
In plain words
Since 0.15.0 a client key with the read scope reads its own client's rows, so a business can see its own
rejected invoices. A client key gets at most its newest 200 rows in the asked status, with truncated: true
when there are more; since 0.18.2 the status is applied first, so an old open row is never hidden behind newer
handled ones. It may list 30 times a minute (429 past that). The operator's key sees every
client's rows, or one client's with client.
apiKeyAuthorizationBearer <token>Send your key as a bearer token: Authorization: Bearer <your-api-key>. Health is the only call that needs no key.
status?stringopen (not yet handled), handled, or all. The default is all, as before 0.8.0.
"all""open""handled""all"client?stringThe operator's filter to one client. A client key may name only its own client; any other answers 404. Another shape answers 400.
^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$data: one row per invoice and code.
application/json- response
data*array<>truncated?booleanPresent and true when a client key's list was cut to its newest 200 rows, before the status filter.
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}The stored files of a care-list invoice with their SHA-256 GET
Since 0.15.0 a client key with the read scope reads the evidence of its own client's invoices, 10 times a minute. Another client's invoice answers 404, exactly as an invoice that is not on the care list does. Files over 8 MiB in all answer 413 (evidence-too-large) for every key; read them one by one with GET /invoices/{id}/documents/{kind}.
Mark an invoice's care rows handled POST
The operator's key only. Handling a care row is Rejection Care's work, so a client key gets 403.