List deposit candidates

GET/api/v1/invoices/deposit-candidates

Return income transactions that may represent customer deposits. Filters to posted income transactions with unallocated balances, useful for the AI deposit sidebar on the invoices page.

Operation ID: list_deposit_candidates_api_v1_invoices_deposit_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: 50: Max results

Responses

200Successful Response

Schema: SuccessEnvelope_ListDepositCandidatesResponse_

successboolean
messagestring
codestring
dataListDepositCandidatesResponse

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/invoices/deposit-candidates

bash

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