Receipts: get receipts
receipts_listSearch and retrieve receipts for a customer account by direction, date range, payment status, or invoice number. Filter, sort, and paginate results to locate matching inbound or outbound documents.
Instructions
🟢 READ-ONLY: Fetches data. Makes no changes to the accounting records.
get receipts
Get receipts for a specified customer account. The response includes the number of returned rows and an array of receipts data.
Use to search receipts by direction, date range or payment status.
To fetch one known receipt, use receipts_get_by_id.
list_direction is required and selects inbound or outbound receipts. Supports limit and offset; the response reports the total in rows.
Endpoint: POST /receipts/get
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | A limit of returned data. If no limit is given, the default will be 500. Also the maximum limit is 500. If specified, the field will be validated. | |
| order | No | Possible fields are: date amount invoicenumber (invoice_number) invoicingparty (counterparty) Allowed values are 'ASC' and 'DESC' Example: {"date": "ASC"} {"date": "ASC", "amount": "DESC"} | |
| offset | No | The offset for paging returned data. If no offset is given, the default will be 0. If specified, the field will be validated. | |
| date_to | No | The receipt's issuing date in format 'YYYY-MM-DD' (e.g. '2017-04-26'). All receipts with issuing date including and before given value will be returned. If specified, the field will be validated. An empty string is not considered a valid date. | |
| deleted | No | If true, only deleted receipts will be returned. If specified, the field will be validated. | |
| due_date | No | The receipt's issuing due date in format 'YYYY-MM-DD' (e.g. '2017-04-26'). All receipts with the same due date given value will be returned. If specified, the field will be validated. An empty string is not considered a valid due date. | |
| date_from | No | The receipt's issuing date in format 'YYYY-MM-DD' (e.g. '2017-04-26'). All receipts with issuing date including and after given value will be returned. If specified, the field will be validated. An empty string is not considered a valid date. | |
| counterparty | No | The counterparty of the receipt, i.e. the invoicing party for type 'inbound' or the recipient for type 'outbound' (e.g. 'Peter Maier'). If specified, the field will be validated. | |
| invoicenumber | No | The invoicenumber for the invoice. If specified, the receipts with the same invoicenumber will be retrieved. | |
| include_offers | No | If true, offers will be included. If specified, the field will be validated. | |
| list_direction | Yes | Can be either 'inbound' ("Eingangsbelege") or 'outbound' ("Ausgangsbelege"). | |
| payment_status | No | Can be either 'paid' ("bezahlt") or 'unpaid' ("unbezahlt"). If specified, the field will be validated. | |
| date_since_last_modified | No | A date and time in format 'YYYY-MM-DD HH:MM:SS' (e.g. '2017-04-26 13:45:00'). If only 'YYYY-MM-DD' is specified, the time defaults to '23:59:59'. All receipts whose date_updated value is later than the specified value will be returned. If specified, the field will be validated. An empty string is not considered a valid date. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | An array of receipts data | |
| rows | No | Number of returned rows | |
| message | No | blank | |
| success | Yes | Success boolean |