Receipts

GET /inventory/receipts

Group: Inventory › Receipts · Operation ID: receipts

Returns a list of receipts. To filter by vendor, reference number, item or warehouse, use POST inventory/receipts/search.

The receipt collection. This endpoint returns the header fields only. A nested array of lines cannot be returned here, so lineCount stands in for them, and GET inventory/receipts/:id or POST inventory/receipts/search returns the full document. The vendor, its reference number, and the item and warehouse on the lines are not filterable here. POST inventory/receipts/search takes them.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
documentNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
documentStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
documentDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
deliveryDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
entityId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, documentNumber, documentDate, deliveryDate, documentStatus, totalAmount, createdDate, lastModifiedDate
Selectable: id, documentNumber, documentStatus, documentDate, deliveryDate, entityId, entityName, businessPartnerId, businessPartnerName, referenceNumber, currency, totalAmount, lineCount, notes, createdDate, lastModifiedDate

Response

200 Success

Under data, an array of receiptsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the receipt.
`documentNumber`	string or null	no	The receipt number, for example 'GR-2291'. Assigned when the receipt is created.
`documentStatus`	string	no	The status of the receipt. It is DRAFT when the receipt is created through this API and COMMITTED once you commit it with POST inventory/receipts/:id/commit. The receiving and invoicing processes set the other statuses.
`documentDate`	string (date)	no	The date of the receipt. Format YYYY-MM-DD.
`deliveryDate`	string (date) or null	no	The date the goods arrived or are expected. Format YYYY-MM-DD.
`entityId`	string	no	The legal entity the receipt belongs to.
`entityName`	string or null	no	The name of that legal entity.
`businessPartnerId`	string	no	The vendor the goods came from.
`businessPartnerName`	string or null	no	The name of that vendor.
`referenceNumber`	string or null	no	The vendor's own reference, typically their delivery note number.
`currency`	string or null	no	The currency of the receipt's amounts. Format ISO 4217, for example 'EUR'. This is the vendor's currency, which need not be the entity's functional currency. See functionalUnitPrice on the line for the functional-currency amounts.
`totalAmount`	string (decimal) or null	no	The total value of the receipt, in the receipt's currency.
`lineCount`	number or null	no	The number of lines on the receipt.
`notes`	string or null	no	Free text on the receipt.
`createdDate`	string (date-time) or null	no	The date and time the receipt was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
`lastModifiedDate`	string (date-time) or null	no	The date and time the receipt last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error