BizKitHub
DocsAPI ReferencePurchase Invoice/bff/purchase-document/inbox/materialize
postPurchase InvoiceAdmin BFF

/bff/purchase-document/inbox/materialize

Takes the reviewed / edited invoice payload (typically the extracted JSON after the operator has approved it), creates the shop__purchase_invoice row, attaches the source blob as pdf_primary, and flips the inbox row's resulting_invoice_id — so the row disappears from the received-documents grid.

PurchaseInvoicepostBffPurchase-documentInboxMaterialize

Parameters

JSON body

Request body

application/json
inboxIdnumberRequired

Inbox row to materialise. Must be classified and not yet materialised.

invoiceobjectRequired
vendorExternalNumberstring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
vendorIdnumber | nullOptional
One of 2:
Variant 1
number
Variant 2
null
recipientIdnumber | nullOptional
One of 2:
Variant 1
number
Variant 2
null
currencyCodestringRequired

ISO-4217 currency code (e.g. CZK, EUR).

issueDatestringRequired

Issue date (YYYY-MM-DD).

dueDatestring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
taxDatestring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
receivedDatestring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
paymentMethodstring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
variableSymbolstring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
constantSymbolstring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
specificSymbolstring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
vendorIbanstring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
vendorSwiftstring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
internalNoticestring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
publicNoticestring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
roundingnumberOptional
Default: 0
isReverseChargebooleanOptional
Default: false
isCreditNotebooleanOptional
Default: false
parentIdnumber | nullOptional
One of 2:
Variant 1
number
Variant 2
null
itemsobject[]Required

At least one line is required.

Each array item:
descriptionstringRequired

Item description (free text).

quantitynumberRequired

Quantity, ≥ 0.

unitPricenumberRequired

Unit price (without VAT) in invoice currency.

vatRatenumberRequired

VAT rate in percent (e.g. 21, 12, 0).

vatClassificationIdnumber | nullOptional
One of 2:
Variant 1
number

Explicit classification id (auto-classify if null).

Variant 2
null

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

POST /bff/purchase-document/inbox/materialize

post
curl -X POST "https://api.bizkithub.com/bff/purchase-document/inbox/materialize" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "inboxId": 0,
  "invoice": {
    "currencyCode": "example_currencyCode",
    "issueDate": "example_issueDate",
    "rounding": 0,
    "isReverseCharge": false,
    "isCreditNote": false,
    "items": [
      {
        "description": "example_description",
        "quantity": 0,
        "unitPrice": 0,
        "vatRate": 0
      }
    ]
  }
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key