List invoices, optionally filtered and paginated

Returns invoice header data only — positions are listed separately via GET /invoices/{invoice}/items and attachments via GET /invoices/{invoice}/attachments.

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

Request

GET /api/v1/invoices

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/invoices' \
     --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
invoice_number[]
Type
array of string, nullable
Description

Response

{
  "data": [
    {
      "invoice_number": "20240001",
      "billing_kind": {
        "id": 1,
        "name": "Abrechnung"
      },
      "date": "2024-07-20T00:00:00.000000Z",
      "amount": 1.5,
      "status": {
        "id": 1,
        "name": "Billed"
      },
      "currency": "EUR",
      "correction_date": "string",
      "payment_terms_date": "2024-06-01",
      "payment_terms": 30,
      "address": "Musterstraße 123",
      "email_sent_at": "string",
      "email_recipient": "string",
      "customer_number": "K-12345",
      "title": "Dr.",
      "type": {
        "id": 1,
        "name": "Payment Request"
      },
      "note": "Familienurlaub",
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z"
    }
  ],
  "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
invoice_number
Type
string
Description
The invoice number, unique per invoice and formatted per tenant.
Name
billing_kind
Type
object
Description
How the invoice groups its positions — by project, by activity, or a manual selection.
Name
billing_kind.id
Type
integer
Description
The stored value. Compare against this, not against name.
Name
billing_kind.name
Type
string
Description
The human-readable label, delivered in the tenant’s language. Do not parse it.
One of: "Abrechnung", "Credit Memo"
Name
date
Type
string
Description
The date the invoice was issued.
Name
amount
Type
number
Description
The invoice total, including tax (the gross amount).
Name
status
Type
object
Description
The invoice’s processing state — planned, approved, billed or cancelled.
Name
status.id
Type
integer
Description
The stored value. Compare against this, not against name.
Name
status.name
Type
string
Description
The human-readable label, delivered in the tenant’s language. Do not parse it.
One of: "Billed", "Canceled", "In Correction"
Name
currency
Type
string
Description
The three-letter currency code the invoice amount is stated in.
Name
correction_date
Type
string
Description
The date a correcting credit note was issued, present only once this invoice has been corrected.
Name
payment_terms_date
Type
string
Description
The date payment is due, calculated from payment_terms.
Name
payment_terms
Type
integer
Description
The number of days after the invoice date within which payment is due.
Name
address
Type
string
Description
The billing address printed on the invoice.
Name
email_sent_at
Type
string
Description
The timestamp the invoice was emailed to the customer, present only once it has been sent.
Name
email_recipient
Type
string
Description
The email address the invoice was sent to, present only once an email has gone out.
Name
customer_number
Type
string
Description
The customer this invoice was billed to.
Name
title
Type
string
Description
The invoice’s title line, printed above its positions.
Name
type
Type
object, nullable
Description
How this invoice relates to another one — a correction or a cancellation credit note — present only when it is one.
Name
type.id
Type
integer
Description
The stored value. Compare against this, not against name.
Name
type.name
Type
string
Description
The human-readable label, delivered in the tenant’s language. Do not parse it.
One of: "Payment Request", "Final Invoice", "Partial Final Invoice"
Name
note
Type
string
Description
An internal note attached to the invoice, not printed on the document.
Name
created
Type
string (date-time), nullable
Description
When the invoice record was first created.
Name
modified
Type
string (date-time), nullable
Description
When the invoice record was last changed.

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

Invoices GET Get a single invoice by its invoice number