Get Started

Suggested matches for a transaction

GET/api/v1/transactions/{transaction_id}/suggested-matches

Return ranked suggested matches for a single bank transaction. Income transactions are matched against open invoices; expense transactions against open bills. Matches are scored by amount, date proximity, memo, and counterparty similarity.

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

transaction_idstringrequired

Query

limitintegerdefault: 10

Max suggested matches

Responses

200Successful Response

Schema: TransactionSuggestedMatchesResponse

transaction_idstringrequired

UUID of the transaction.

amountintegerrequired

Absolute transaction amount in cents.

directionstringrequired

inflow (money in → invoices) or outflow (money out → bills).

One of: inflow, outflow

matchesarray · SuggestedMatchSuggestedMatch

Suggested matches ranked by confidence (highest first).

10 fields
typestringrequired

Whether this match is an invoice (income) or a bill (expense).

One of: invoice, bill

idstringrequired

UUID of the matched invoice or bill.

numberstring

Invoice number or vendor bill number, if set.

party_namestring

Customer name (invoice) or vendor name (bill).

balance_dueintegerrequired

Open balance of the invoice/bill in cents.

due_datestring

Due date of the invoice/bill (ISO 8601 date).

suggested_amountintegerrequired

Suggested allocation amount in cents (capped at the open balance).

confidencenumberrequired

Composite match confidence score (0-1).

signalsobject

Per-signal score breakdown (amount, date, memo, counterparty).

match_group_idstring

Set when this match is part of a multi-document group (one transaction paying several invoices/bills).

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