Inbox
List the incoming documents that have not been marked as read.
List the incoming documents that have not been marked as read. Use it as a work queue: process a document, then mark it as read so the next call no longer returns it. This response is not paginated and carries every unread incoming document, so keeping up with the marking is what keeps it a reasonable size. It differs from GET /documents?isUnread=true&direction=incoming in two ways: that endpoint is paginated and filterable, and it returns the parsed document body, which the inbox leaves out to stay cheap. Fetch a document by its ID when you need its contents.
Basic API key authentication. Create a new API key and secret in the Recommand dashboard.
In: header
Query Parameters
Optionally filter documents by company ID
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/inbox"{ "success": true, "documents": [ { "id": "doc_01JQZ8X0M4T7RB6K9V2NDHW3PA", "teamId": "team_01JQZ8X0M4T7RB6K9V2NDHW3PA", "companyId": "c_01JQZ8X0M4T7RB6K9V2NDHW3PA", "direction": "incoming", "senderId": "0208:1012081766", "receiverId": "0208:0428643097", "docTypeId": "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1", "processId": "urn:fdc:peppol.eu:2017:poacc:billing:01:1.0", "countryC1": "BE", "type": "invoice", "readAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "validation": { "result": "valid", "errors": [ { "ruleCode": "PEPPOL-EN16931-R010", "errorMessage": "string", "errorLevel": "ERROR", "fieldName": "string", "source": "string" } ] }, "sentOverPeppol": true, "sentOverEmail": false, "emailRecipients": [], "labels": [ { "colorHex": "#3B82F6", "externalId": "erp-routing-inbox", "id": "lbl_01JQZ8X0M4T7RB6K9V2NDHW3PA", "name": "ERP" } ], "peppolMessageId": "string", "peppolConversationId": "string", "receivedPeppolSignalMessage": "string", "envelopeId": "string", "deliveryStatus": "delivered", "deliveries": [ { "id": "dlv_01JQZ8X0M4T7RB6K9V2NDHW3PA", "channel": "peppol", "address": "0208:0428643097", "status": "delivered", "statusChangedAt": "2019-08-24T14:15:22Z", "failure": { "category": "validation", "message": "string", "providerCode": "TXE-1005" }, "references": { "peppolMessageId": "string", "peppolConversationId": "string", "envelopeId": "string", "messageId": "string" } } ] } ]}