List expense candidates

GET/api/v1/bills/expense-candidates

Return outgoing transactions that may represent bill payments. Filters to posted expense transactions with unallocated balances, useful for the Record Payment modal on the bills page.

Operation ID: list_expense_candidates_api_v1_bills_expense_candidates_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

limitintegerdefault: 200: Max results

Responses

200Successful Response

Schema: SuccessEnvelope_ListExpenseCandidatesResponse_

successboolean
messagestring
codestring
dataListExpenseCandidatesResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/bills/expense-candidates

bash

curl -X GET 'https://api.ondayzero.com/api/v1/bills/expense-candidates' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'