DocsAPI ReferenceExpense/bff/expense/list
getExpenseAdmin BFF

/bff/expense/list

Returns the expense ledger of the logged-in organisation with optional filters. total is the signed sum of all non-deleted, non-rejected rows whose totalMoney is set; rejected and soft-deleted entries are still returned for the UI but excluded from the sum.

ExpensegetBffExpenseList

Parameters

9 query

9 total
Query · 9
accountingEntityExternalIdstring
Length: 2424
branchSlugstring
categorystring | string | string | string | string | string | string | string | string | string | string | string | string | string | string
statusstring | string | string | string | string | string | string | string
sourcestring | string | string | string | string | string | string | string | string | string | string | string | string | string
fromstring

YYYY-MM-DD inclusive lower bound on effective_date.

tostring

YYYY-MM-DD inclusive upper bound on effective_date.

includeDeletedboolean
limitstring | integer
Range: 12000

Request

GET /bff/expense/list

get
curl -X GET "https://api.bizkithub.com/bff/expense/list?accountingEntityExternalId=example_accountingEntityExternalId&branchSlug=example_branchSlug&from=example_from&to=example_to&includeDeleted=false" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key