BizKitHub
DocsAPI ReferenceInvoice/bff/document/detail
getInvoiceAdmin BFF

/bff/document/detail

Returns complete invoice detail including line items, supplier, customer, and payment information. This data can be used for displaying the invoice or generating PDF.

InvoicegetBffDocumentDetail

Parameters

1 query

Query parameters

· 1
idstringRequired

External invoice ID (16 characters).

ExampleaB3xKm9pQ2wLn4Yz

Response schema

1 status code documented

200SuccessComplete invoice detail.
idstringRequired

External invoice ID.

sequenceNumberstringRequired

Invoice number.

typestringRequired

Document type.

titlestringRequired

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

statusstringRequired

Invoice status.

hasPaidbooleanRequired

Whether the invoice is paid.

totalnumberRequired

Total amount.

currencystringRequired

Currency code.

supplierobjectRequired

Invoice participant (supplier or customer).

namestringRequired

Company name or person name.

streetAddressstringRequired

Street address.

citystringRequired

City.

postalCodestringRequired

Postal/ZIP code.

companyRegistrationNumberstringOptional

Company registration number.

taxIdentificationNumberstringOptional

Tax identification number (VAT ID).

accountNumberstringOptional

Bank account number.

addressDescriptionstringOptional

Address description.

supplierExternalIdstringOptional

External id (CuRefNo) of the issuer contact. shop__invoice.issuer_id is NOT NULL so this is populated for every invoice — admin surfaces use it to link the supplier block to the contact detail.

customerobjectOptional

Invoice participant (supplier or customer).

namestringRequired

Company name or person name.

streetAddressstringRequired

Street address.

citystringRequired

City.

postalCodestringRequired

Postal/ZIP code.

companyRegistrationNumberstringOptional

Company registration number.

taxIdentificationNumberstringOptional

Tax identification number (VAT ID).

accountNumberstringOptional

Bank account number.

addressDescriptionstringOptional

Address description.

customerExternalIdstringOptional

External id (CuRefNo) of the current customer contact. Used by admin flows that need to identify the linked contact (change-customer picker, contact drill-down).

variableSymbolstringOptional

Variable symbol (payment reference).

constantSymbolstringOptional

Constant symbol.

specificSymbolstringOptional

Specific symbol.

bankNamestringOptional

Bank name.

ibanstringOptional

IBAN.

bicstringOptional

BIC/SWIFT code.

dueDatestringRequired

Due date (ISO format).

issueDatestringRequired

Issue date (ISO format).

taxableSupplyDatestringOptional

Taxable supply date (ISO format).

paymentMethodstringOptional

Payment method.

publicNoticestringOptional

Public notice (displayed on invoice).

internalNoticestringOptional

Internal notice (not displayed on invoice).

itemsobject[]Required

Invoice line items.

Each array item:

Invoice line item.

descriptionstringRequired

Item description.

quantitynumberRequired

Quantity.

unitstringOptional

Unit (pcs, hrs, …).

unitPricenumberRequired

Unit price excluding VAT.

totalPricenumberRequired

Total item price.

vatRatenumberRequired

VAT rate in percent.

useVatbooleanRequired

Whether the organisation is VAT registered.

logoUrlstringOptional

Organisation logo URL.

snapshottedAtstringOptional

ISO timestamp when the invoice was locked into an immutable snapshot. Absent when the invoice still reflects live supplier/customer/bank data.

lastReminderAtstringOptional

ISO timestamp of the most recent overdue reminder, if any.

reminderCountnumberRequired

Total reminders sent for this invoice.

fileobjectOptional

Invoice PDF file information.

tokenstringRequired

Unique file token.

filenamestringRequired

Original filename.

downloadUrlstringRequired

Direct download URL for the PDF file.

sizenumberRequired

File size in bytes.

Response example

application/json
{
  "id": "example_id",
  "sequenceNumber": "example_sequenceNumber",
  "type": "example_type",
  "title": "example_title",
  "status": "example_status",
  "hasPaid": false,
  "total": 0,
  "currency": "example_currency",
  "supplier": {
    "name": "example_name",
    "streetAddress": "example_streetAddress",
    "city": "example_city",
    "postalCode": "example_postalCode",
    "companyRegistrationNumber": "example_companyRegistrationNumber",
    "taxIdentificationNumber": "example_taxIdentificationNumber",
    "accountNumber": "example_accountNumber",
    "addressDescription": "example_addressDescription"
  },
  "supplierExternalId": "example_supplierExternalId",
  "customer": {
    "name": "example_name",
    "streetAddress": "example_streetAddress",
    "city": "example_city",
    "postalCode": "example_postalCode",
    "companyRegistrationNumber": "example_companyRegistrationNumber",
    "taxIdentificationNumber": "example_taxIdentificationNumber",
    "accountNumber": "example_accountNumber",
    "addressDescription": "example_addressDescription"
  },
  "customerExternalId": "example_customerExternalId",
  "variableSymbol": "example_variableSymbol",
  "constantSymbol": "example_constantSymbol",
  "specificSymbol": "example_specificSymbol",
  "bankName": "example_bankName",
  "iban": "example_iban",
  "bic": "example_bic",
  "dueDate": "example_dueDate",
  "issueDate": "example_issueDate",
  "taxableSupplyDate": "example_taxableSupplyDate",
  "paymentMethod": "example_paymentMethod",
  "publicNotice": "example_publicNotice",
  "internalNotice": "example_internalNotice",
  "items": [
    {
      "description": "example_description",
      "quantity": 0,
      "unit": "example_unit",
      "unitPrice": 0,
      "totalPrice": 0,
      "vatRate": 0
    }
  ],
  "useVat": false,
  "logoUrl": "example_logoUrl",
  "snapshottedAt": "example_snapshottedAt",
  "lastReminderAt": "example_lastReminderAt",
  "reminderCount": 0,
  "file": {
    "token": "example_token",
    "filename": "example_filename",
    "downloadUrl": "example_downloadUrl",
    "size": 0
  }
}

Request example

GET /bff/document/detail

get
curl -X GET "https://api.bizkithub.com/bff/document/detail?id=aB3xKm9pQ2wLn4Yz" \
  -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