Authorizations
Token-based authentication with required prefix "Token"
Query Parameters
Filter by currency code (e.g., USD, EUR)
If true, triggers async download workflow and sends bills via email
Filter bills with bill_date on or before this date (YYYY-MM-DD)
Filter by entity ID. Can be specified multiple times for multiple entities
When set to 'true', returns ONLY deleted records instead of active records. Deleted records contain minimal data: 'id', 'is_deleted=true', 'deleted_at' timestamp, and 'last_modified_at'. When 'false' or omitted, returns ONLY active records. This provides clean separation between active and deleted data.
Filter for records modified on or after this timestamp. Format: ISO 8601 (e.g., '2024-01-01T00:00:00Z' or '2024-01-01'). Works with both active records and deleted records (filters by deletion time for deleted records).
Filter for records modified on or before this timestamp. Format: ISO 8601 (e.g., '2024-12-31T23:59:59Z' or '2024-12-31'). Works with both active records and deleted records (filters by deletion time for deleted records).
Number of results to return per page (default: 50, max: 1000)
The initial index from which to return the results
Search query - searches by mailing address, bill number, message on bill, or vendor name
Sort order. Use field name for ascending, -field for descending. Special fields: vendor_name, total_amount, amount_paid, amount_due, payment. Default: -bill_date
Filter bills with bill_date on or after this date (YYYY-MM-DD)
Filter by payment status
1_30
, 31_60
, 61_90
, 91_120
, current
, open
, over_120
, paid
, partially_paid
, past_due
, payment_not_found
, payment_pending
, unpaid
, voided
Filter by vendor ID. Can be specified multiple times for multiple vendors