BizKitHub
DocsAPI ReferenceDev/bff/test/document/{type}
getDevAdmin BFF

/bff/test/document/{type}

Renders the maximal variant of a document type (invoice, receipt, proforma, partialProforma, taxDocument, finalInvoice, correction, creditNote) using static sample data. Query flags toggle format (PDF / HTML / debug PDF) and the payment QR code (qr=false). Intended for design tuning — no DB access, no auth-scoped data.

DevgetBffTestDocumentByType

Parameters

1 path · 3 query

Path parameters

· 1
type"invoice" | "receipt" | "proforma" | "partialProforma" | "taxDocument" | "finalInvoice" | "correction" | "creditNote"Required

Query parameters

· 3
format"pdf" | "html" | "debug"Optional

Render output. pdf (default) returns the PDF; html returns raw HTML; debug adds red table borders on the PDF.

qrstringOptional

Set to "false" to suppress the payment QR code (only meaningful for invoice-like documents).

Examplefalse
localestringOptional

Sample locale (cs, en, de, …). Defaults to cs.

Examplecs

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

GET /bff/test/document/{type}

get
curl -X GET "https://api.bizkithub.com/bff/test/document/{type}?qr=false&locale=cs" \
  -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