Docs API Reference Accounting Document Inbox/bff/accounting-document-inbox/list

getAccounting Document InboxAdmin BFF

/bff/accounting-document-inbox/list

Paginated list of fin__document_inbox rows.

AccountingDocumentInboxgetBffAccounting-document-inboxList

Parameters

5 query

Query parameters

· 5

statusesstringOptional

Comma-separated list of lifecycle states to include.

Exampleexample_statuses

kindsstringOptional

Comma-separated list of classifier kinds to include.

Exampleexample_kinds

searchstringOptional

Substring match on subject / from / filename.

Exampleexample_search

pagestringOptional

Exampleexample_page

limitstringOptional

Exampleexample_limit

Response schema

1 status code documented

200Success

itemsobject[]Required

Each array item:

externalIdstringRequired

statusstringRequired

kindstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

classificationConfidencenumber | nullRequired

One of 2:

Variant 1

number

Variant 2

null

classificationReasonstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

sourceSubjectstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

sourceFromstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

sourceFilenamestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

sourceContentTypestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

sourceSizenumber | nullRequired

One of 2:

Variant 1

number

Variant 2

null

insertedDatestringRequired

processedDatestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

classifierRunExternalIdstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

receivedEmailIdnumber | nullRequired

One of 2:

Variant 1

number

Variant 2

null

itemCountnumberRequired

Response example

application/json

{
  "items": [
    {
      "externalId": "example_externalId",
      "status": "example_status",
      "insertedDate": "example_insertedDate"
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/accounting-document-inbox/list

get

curl -X GET "https://api.bizkithub.com/bff/accounting-document-inbox/list?statuses=example_statuses&kinds=example_kinds&search=example_search&page=example_page&limit=example_limit" \
  -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