List receipt amount lines across all receipts, optionally filtered and paginated

Each line still carries its parent receipt’s id, so results can be grouped back by receipt.

Availability: Full version only — a Clock instance answers 404 for this endpoint.

Request

GET /api/v1/receipts-amounts

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/receipts-amounts' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Query parameters

Name
perPage
Type
integer, nullable
Description
Ignored on this endpoint — send limit instead. Any value given here is replaced by limit, or by the default when limit is absent.
Name
page
Type
integer, nullable
Description
The page of results to return, counting from 1.
Name
orderBy
Type
string, nullable
Description
Name of the field to sort by.
Name
order
Type
string, nullable
Description
Sort direction, ascending or descending.
One of: "asc", "desc"
Name
limit
Type
integer, nullable
Description
The number of records per page, 1 to 200. Defaults to 15.
Name
modified_after
Type
string (date-time)
Description
Only return records modified after this timestamp (ISO 8601, or “Y-m-d H:i:s”).
Name
modified_before
Type
string (date-time)
Description
Only return records modified before or at this timestamp (ISO 8601, or “Y-m-d H:i:s”).
Name
date_from
Type
string (date), nullable
Description
Only return amounts whose receipt date is on or after this date.
Name
date_to
Type
string (date), nullable
Description
Only return amounts whose receipt date is on or before this date. Must not be earlier than date_from.
Name
employee_id
Type
string, nullable
Description
Only return amounts belonging to this employee’s receipts.
Name
receipt_id
Type
integer, nullable
Description
Only return amounts belonging to this receipt.

Response

{
  "data": [
    {
      "id": 1,
      "receipt_id": 1,
      "tax": "19.0000",
      "quantity": "1.00000",
      "amount": "285.21",
      "invoicing_share": "89.50",
      "private_share": "string",
      "is_amount_net": false,
      "is_invoice_amount_net": false,
      "employee_id": "max.mustermann"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Response fields

Name
id
Type
integer
Description
The receipt amount line’s unique identifier.
Name
receipt_id
Type
string
Description
The parent receipt this amount line belongs to; a legacy column served as either a string or an integer.
Name
tax
Type
string
Description
The tax percentage rate applied to this amount line, between 0 and 100.
Name
quantity
Type
string
Description
How many units this amount line bills, e.g. the number of kilometres or nights.
Name
amount
Type
string
Description
The line’s total amount; net or gross depending on the parent receipt’s is_amount_net.
Name
invoicing_share
Type
string
Description
The amount of this line that is billable to the client — an amount, not a percentage share despite the name.
Name
private_share
Type
string
Description
The amount of this line that is private and not billable — an amount, not a percentage share despite the name.
Name
is_amount_net
Type
boolean
Description
Whether amount is net or gross, copied from the parent receipt rather than stored on this line.
Name
is_invoice_amount_net
Type
boolean
Description
Whether the invoiceable amount is net or gross, copied from the parent receipt rather than stored on this line.
Name
employee_id
Type
string, nullable
Description
The employee who submitted the parent receipt, copied from it rather than stored on this line.

Generated from the OpenAPI specification — edit the source code, not this page.

DELETE Delete a receipt GET List the amount lines of a single receipt