Suggested invoices to link

GET/api/v1/contracts/{contract_id}/suggested-invoices

Rank the business's unlinked (non-void, non-draft) invoices as likely matches for this contract, using deterministic heuristics: same customer, issue date inside the contract term, exact amount matches (order line / per-period / remaining value), and description-token overlap. Returns the top matches with human-readable reasons for each score.

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

contract_idstringrequired

Responses

200Successful Response

Schema: SuccessEnvelope_SuggestedInvoicesResponse_

successboolean
messagestring
codestring
dataSuggestedInvoicesResponse

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/contracts/{contract_id}/suggested-invoices

bash

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