List bill payment suggestions

GET /api/v1/bills/payment-suggestions

List auto-detected matches between bank transactions and open bills.

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

Query

bill_id string: Filter by bill UUID
status string default: pending: Filter by status
min_confidence number: Minimum confidence threshold
start_date string · date: Only include suggestions whose transaction date is on or after this date (YYYY-MM-DD)
end_date string · date: Only include suggestions whose transaction date is on or before this date (YYYY-MM-DD)
limit integer default: 100: Max results

Responses

200 Successful Response

Schema: BillPaymentSuggestionsListResponse

items array · BillPaymentSuggestionResponse BillPaymentSuggestionResponse

List of suggestions

18 fields

id string required: Suggestion UUID
bill_id string required: Bill UUID
bill_number string: Bill number
vendor_name string: Vendor name
transaction_id string required: Transaction UUID
transaction_description string: Transaction description
transaction_counterparty string: Transaction counterparty
transaction_date string · date: Date of the transaction
transaction_account_name string: Name of the ledger/bank account the transaction posted to
business_id string required: Business UUID
amount integer required: Suggested payment amount in cents
confidence number required: Match confidence (0–1)
signals object: Signal score breakdown
match_group_id string: Group ID for multi-bill matches
status string required: pending | accepted | rejected | expired
reviewed_at string · date-time: When reviewed
created_at string · date-time: When created
updated_at string · date-time: When updated

pending_count integer

Total pending suggestions

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

GET /api/v1/bills/payment-suggestions

bash

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

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/bills/payment-suggestions', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/bills/payment-suggestions", headers=headers)
data = response.json()