curl --request GET \
--url https://{host}/cleemy-procurement/services/inbox \
--header 'Authorization: <authorization>'{
"items": [
{
"id": 123,
"document": {
"id": 123,
"owner": {
"id": 123,
"href": "<string>",
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"pictureHref": "<string>"
},
"type": "Invoice",
"context": {
"purchase": {
"id": 123,
"href": "<string>",
"name": "<string>",
"type": "Subscription"
}
},
"documentBreakdown": {
"id": 2,
"href": "<string>",
"name": "<string>"
},
"documentDate": "2023-12-25",
"documentNumber": "<string>",
"amountIncludingTaxes": {
"excludingTaxes": {
"value": 123,
"currency": "Invalid"
},
"taxes": [
{
"rateTypeId": 123,
"value": 123,
"currency": "Invalid"
}
],
"includingTaxes": {
"value": 123,
"currency": "Invalid"
}
},
"accountingLabel": "<string>",
"comment": "<string>",
"intraCommunityTaxes": true,
"attachments": [
{
"id": 123,
"file": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"href": "<string>",
"name": "<string>",
"displayHref": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"pages": {
"displayHrefTemplate": "<string>",
"count": 123
}
}
],
"ocrStatus": "Pending",
"dueDate": "2023-12-25",
"paymentDetails": {
"paymentMethod": "BankTransfer",
"bankAccount": {
"iban": "<string>",
"bic": "<string>"
}
},
"createdAt": "2023-11-07T05:31:56Z",
"modifiedAt": "2023-11-07T05:31:56Z",
"author": {
"id": 123,
"href": "<string>",
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"pictureHref": "<string>"
},
"modifier": {
"id": 123,
"href": "<string>",
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"pictureHref": "<string>"
}
},
"source": {
"type": "<string>"
},
"action": {},
"createdAt": "2023-11-07T05:31:56Z",
"modifiedAt": "2023-11-07T05:31:56Z",
"author": {
"id": 123,
"href": "<string>",
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"pictureHref": "<string>"
},
"modifier": {
"id": 123,
"href": "<string>",
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"pictureHref": "<string>"
}
}
],
"prev": "<string>",
"next": "<string>",
"count": 1
}List documents waiting to be processed in the inbox.
curl --request GET \
--url https://{host}/cleemy-procurement/services/inbox \
--header 'Authorization: <authorization>'{
"items": [
{
"id": 123,
"document": {
"id": 123,
"owner": {
"id": 123,
"href": "<string>",
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"pictureHref": "<string>"
},
"type": "Invoice",
"context": {
"purchase": {
"id": 123,
"href": "<string>",
"name": "<string>",
"type": "Subscription"
}
},
"documentBreakdown": {
"id": 2,
"href": "<string>",
"name": "<string>"
},
"documentDate": "2023-12-25",
"documentNumber": "<string>",
"amountIncludingTaxes": {
"excludingTaxes": {
"value": 123,
"currency": "Invalid"
},
"taxes": [
{
"rateTypeId": 123,
"value": 123,
"currency": "Invalid"
}
],
"includingTaxes": {
"value": 123,
"currency": "Invalid"
}
},
"accountingLabel": "<string>",
"comment": "<string>",
"intraCommunityTaxes": true,
"attachments": [
{
"id": 123,
"file": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"href": "<string>",
"name": "<string>",
"displayHref": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"pages": {
"displayHrefTemplate": "<string>",
"count": 123
}
}
],
"ocrStatus": "Pending",
"dueDate": "2023-12-25",
"paymentDetails": {
"paymentMethod": "BankTransfer",
"bankAccount": {
"iban": "<string>",
"bic": "<string>"
}
},
"createdAt": "2023-11-07T05:31:56Z",
"modifiedAt": "2023-11-07T05:31:56Z",
"author": {
"id": 123,
"href": "<string>",
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"pictureHref": "<string>"
},
"modifier": {
"id": 123,
"href": "<string>",
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"pictureHref": "<string>"
}
},
"source": {
"type": "<string>"
},
"action": {},
"createdAt": "2023-11-07T05:31:56Z",
"modifiedAt": "2023-11-07T05:31:56Z",
"author": {
"id": 123,
"href": "<string>",
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"pictureHref": "<string>"
},
"modifier": {
"id": 123,
"href": "<string>",
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"pictureHref": "<string>"
}
}
],
"prev": "<string>",
"next": "<string>",
"count": 1
}API key. Value must be formatted like so: lucca application={api_key}.
Filter on OCR status.
None, Pending, Completed, Failed, Applied Filter on author user IDs.
Filter on purchase IDs.
Filter on dispute IDs.
Filter on user operations (roles).
Buyer, PurchasingManager, Accountant, Admin, Payer, PurchaseReader, InvoicingManager Filter on establishment IDs.
Include documents with no establishment.
Sort order. Prefix with - for descending. Comma-separated for multiple properties.
Include root collection fields (paging).
prev, next, count Page selection. Page tokens can be retrieved by adding ?fields.root=next,prev on your GET collections requests.
Page size (max 100).
0 <= x <= 100Was this page helpful?