BizKitHub
DocsAPI ReferenceOrder/bff/order/document-list
getOrderAdmin BFF

/bff/order/document-list

Every document issued for the order (newest first) with PDF file, parent link, void / supersede chain and e-mail delivery, plus the already-credited quantity / amount per order line.

OrdergetBffOrderDocument-list

Parameters

1 query

Query parameters

· 1
hashstringRequired

Unique order hash identifier.

Exampleexample_hash

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired
sequenceNumberstringRequired
typestringRequired
statusstringRequired
totalnumberRequired
currencystringRequired
issueDatestringRequired
dueDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
taxableSupplyDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
paidDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
insertedDatestringRequired
publicNoticestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
voidedAtstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
voidReasonstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
isLockedbooleanRequired
parentobject | nullRequired
One of 2:
Variant 1
idstringRequired
sequenceNumberstringRequired
typestringRequired
Variant 2
null
supersedesSequenceNumberstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
replacedBySequenceNumberstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
fileobject | nullRequired
One of 2:
Variant 1
tokenstringRequired
filenamestringRequired
sizenumberRequired
downloadUrlstringRequired
Variant 2
null
deliveryobject | nullRequired
One of 2:
Variant 1
countnumberRequired
lastSentAtstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
lastQueuedAtstringRequired
openedAtstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
Variant 2
null
creditedobject[]Required
Each array item:
orderItemIdnumberRequired
quantitynumberRequired
amountnumberRequired

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "sequenceNumber": "example_sequenceNumber",
      "type": "example_type",
      "status": "example_status",
      "total": 0,
      "currency": "example_currency",
      "issueDate": "example_issueDate",
      "insertedDate": "example_insertedDate",
      "isLocked": false
    }
  ],
  "credited": [
    {
      "orderItemId": 0,
      "quantity": 0,
      "amount": 0
    }
  ]
}

Request example

GET /bff/order/document-list

get
curl -X GET "https://api.bizkithub.com/bff/order/document-list?hash=example_hash" \
  -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