List suggestions for invoice

GET/api/v1/invoices/{invoice_id}/suggestions

List auto-detected payment match suggestions for a specific invoice.

Operation ID: list_invoice_suggestions_api_v1_invoices__invoice_id__suggestions_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

Path

invoice_idstring · uuidrequired

Query

statusstringdefault: pending: Filter by status

Responses

200Successful Response

Schema: SuccessEnvelope_ListInvoiceSuggestionsResponse_

successboolean
messagestring
codestring
dataListInvoiceSuggestionsResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/invoices/{invoice_id}/suggestions

bash

curl -X GET 'https://api.ondayzero.com/api/v1/invoices/{invoice_id}/suggestions' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'