v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB

Accounts Payable

List Accounting Bills

    Retrieve a paginated list of accounting bills with comprehensive filtering, search, and sorting capabilities.

    This endpoint provides complete access to your bills data with:
    - Advanced filtering by date ranges, payment status, vendors, entities, and currency
    - Full-text search across bill numbers, vendor names, addresses, and bill messages
    - Flexible sorting by any field including calculated fields (totals, amounts due, etc.)
    - Comprehensive pagination with customizable page sizes
    - Aging calculations and payment status categorization
    - Automatic calculation of totals, amounts paid, and amounts due

    **Deleted Records Support:**
    - When include_deleted=true: Returns ONLY deleted bills with minimal data (id, is_deleted, deleted_at, last_modified_at)
    - When include_deleted=false or omitted: Returns ONLY active bills with full data
    - Timestamp filtering (last_modified_at__gte/lte) works with both active and deleted records

get/coa/api/v1/bill/

Query parameters

currencystring

Filter by currency code (e.g., USD, EUR)

downloadboolean

If true, triggers async download workflow and sends bills via email

end_datestring

Filter bills with bill_date on or before this date (YYYY-MM-DD)

entityinteger

Filter by entity ID. Can be specified multiple times for multiple entities

include_deletedboolean

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.

last_modified_at__gtestring

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).

last_modified_at__ltestring

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).

limitinteger

Number of results to return per page (default: 50, max: 1000)

offsetinteger

The initial index from which to return the results

qstring

Search query - searches by mailing address, bill number, message on bill, or vendor name

sortstring

Sort order. Use field name for ascending, -field for descending. Special fields: vendor_name, total_amount, amount_paid, amount_due, payment. Default: -bill_date

start_datestring

Filter bills with bill_date on or after this date (YYYY-MM-DD)

Filter by payment status

vendorinteger

Filter by vendor ID. Can be specified multiple times for multiple vendors

Response

No response body