BizKitHub
DocsAPI ReferenceInvoice/bff/document/list
getInvoiceAdmin BFF

/bff/document/list

Returns a paginated list of invoices for the organisation. Invoices are sorted by issue date (newest first). Supports filtering by status, type, payment state, customer, date range, and full-text search.

InvoicegetBffDocumentList

Parameters

12 query

Query parameters

· 12
pagestringOptional

Page number (1-based) for pagination.

Example1
limitstringOptional

Maximum items per page (1–500, default 50).

Example50
status"open" | "sent" | "overdue" | "paid" | "cancelled" | "uncollectible"Optional

Invoice status.

type"invoice" | "receipt" | "proforma" | "partialProforma" | "correction" | "taxDocument" | "finalInvoice" | "creditNote"Optional

Document type.

isPaidstringOptional

Filter by payment status: "true" or "false".

Exampletrue
customerIdstringOptional

External customer ID for filtering.

ExamplexK9mP2wLn4YzaB3Q
issuerIdstringOptional

External issuer contact ID for filtering (accounting entity that issued the invoice).

ExampleaB3xKm9pQ2wLn4Yz
dateFromstringOptional

Issue date from (ISO format: YYYY-MM-DD).

Example2026-01-01
dateTostringOptional

Issue date to (ISO format: YYYY-MM-DD).

Example2026-03-31
yearstringOptional

Convenience shortcut for the admin Year selector — translated internally to dateFrom/dateTo. Ignored when dateFrom/dateTo are set.

Example2026
monthstringOptional

Convenience shortcut for the admin Month selector (1–12). Combined with year when both are set; falls back to the current server year when used alone.

Example3
searchstringOptional

Full-text search in invoice number, email, and customer name.

Example2024001

Response schema

1 status code documented

200SuccessPaginated list of invoices.
itemsobject[]Required

List of invoices.

Each array item:

Invoice item in the list.

idstringRequired

Unique external invoice identifier (16 characters).

sequence_numberstringRequired

Invoice number (e.g., "2024001").

order_hashstringOptional

Hash of the associated order.

order_numberstringOptional

Number of the associated order.

typestringRequired

Document type (invoice, receipt, proforma, creditNote, …).

statusstringRequired

Invoice status (open, sent, overdue, paid, cancelled, uncollectible).

totalstringRequired

Total invoice amount.

currencystringRequired

Currency code (CZK, EUR, …).

issuer_idstringRequired

External ID of the issuer.

issuer_namestringOptional

Name of the issuer.

customer_idstringOptional

External ID of the customer.

customer_namestringOptional

Name of the customer.

recipient_idstringOptional

External ID of the recipient (if different from customer).

recipient_namestringOptional

Name of the recipient.

issue_dateDate | string | string | numberRequired

Invoice issue date.

One of 4:
Variant 1
Date

Invoice issue date.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
due_dateDate | string | string | numberRequired

Payment due date.

One of 4:
Variant 1
Date

Payment due date.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
invoice_pay_dateDate | string | string | numberOptional

Payment date. Null if unpaid.

One of 4:
Variant 1
Date

Payment date. Null if unpaid.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
itemCountnumberRequired

Total number of invoices matching the filter.

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "sequence_number": "example_sequence_number",
      "order_hash": "example_order_hash",
      "order_number": "example_order_number",
      "type": "example_type",
      "status": "example_status",
      "total": "example_total",
      "currency": "example_currency",
      "issuer_id": "example_issuer_id",
      "issuer_name": "example_issuer_name",
      "customer_id": "example_customer_id",
      "customer_name": "example_customer_name",
      "recipient_id": "example_recipient_id",
      "recipient_name": "example_recipient_name"
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/document/list

get
curl -X GET "https://api.bizkithub.com/bff/document/list?page=1&limit=50&isPaid=true&customerId=xK9mP2wLn4YzaB3Q&issuerId=aB3xKm9pQ2wLn4Yz&dateFrom=2026-01-01&dateTo=2026-03-31&year=2026&month=3&search=2024001" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key