BizKitHub
DocsAPI ReferenceLedger/bff/ledger/automation/suggestion-list
getLedgerAdmin BFF

/bff/ledger/automation/suggestion-list

Posting suggestions (open = pending / needs input / blocked)

LedgergetBffLedgerAutomationSuggestion-list

Parameters

9 query

Query parameters

· 9
entityIdstringRequired

Accounting entity external id.

Length: 16–24
Exampleexample_entityId
status"open" | "pending" | "needs_input" | "blocked" | "approved" | "rejected" | "auto_posted" | "superseded"Optional
querystringOptional
Length: 0–100
Exampleexample_query
operationType"document.issued" | "document.received" | "document.expense" | "document.advance" | "payment.in" | "payment.out"Optional
reasonCodestringOptional
Length: 0–48
Exampleexample_reasonCode
filterFulltextQuerystringOptional

DataGrid fulltext (same as query).

Length: 0–100
Exampleexample_filterFulltextQuery
orderBystringOptional

DataGrid sort, field:asc|desc.

Exampleexample_orderBy
pagestring | numberOptional
Range: 1–∞
limitstring | numberOptional

Clamped to the DataGrid maximum.

Range: 1–∞

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

GET /bff/ledger/automation/suggestion-list

get
curl -X GET "https://api.bizkithub.com/bff/ledger/automation/suggestion-list?entityId=example_entityId&query=example_query&reasonCode=example_reasonCode&filterFulltextQuery=example_filterFulltextQuery&orderBy=example_orderBy" \
  -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