Docs API Reference Purchase Invoice/bff/purchase-document/status

/bff/purchase-document/status

Standard transitions follow the lifecycle. Backwards moves (e.g. paid → booked) require force: true and are recorded in coreAuditLog as force_edit. The shop__purchase_invoice_log timeline also captures every change for the per-invoice detail page.

PurchaseInvoicepostBffPurchase-documentStatus

Parameters

JSON body

Request body

application/json

idnumberRequired

nextStatus"draft" | "received" | "booked" | "paid" | "cancelled"Required

Lifecycle status of a purchase invoice.

paidDatestring | nullOptional

One of 2:

Variant 1

string

Variant 2

null

forcebooleanOptional

Default: false

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/status

post

curl -X POST "https://api.bizkithub.com/bff/purchase-document/status" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": 0,
  "force": false
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key