bills

List Bills

Retrieve a paginated list of bills.

Supports:

  • Pagination (page_size, page)
  • Date filtering (updated_after, updated_before)
  • Sorting (order_by)
get/bills

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/bills
  • Auth: API key in header x-api-key

Query parameters

page_sizeinteger

Number of items per page (max 100)

pageinteger

Page number (1-based)

order_by'asc' | 'desc'

Sort order for results

string date
OR
string date-time

Filter items updated after this timestamp (ISO 8601). Also matches records whose custom property values changed within the window.

string date
OR
string date-time

Filter items updated before this timestamp (ISO 8601). Also matches records whose custom property values changed within the window.

Response

List of bills

idinteger required

Bill identifier

billNumberinteger required

Unique bill number

descriptionstring nullable

Bill description

status'DRAFT' | 'SENT' | 'DECLINED' | 'PAID' | 'PARTIALLY_PAID' | 'OVERDUE' required

Bill status

basedOnIdinteger nullable

ID of the record this bill is based on

basedOnUidinteger nullable

UID of the record this bill is based on

dueDatestring date-time

Due date

issueDatestring date-time nullable

Issue date

amountnumber double required

Total bill amount

amountPaidnumber double required

Amount paid

isArchivedboolean

Whether the bill is archived

calculationMethodstring required

Calculation method (LINE_ITEMS or PERCENTAGE)

percentagenumber double nullable

Percentage if calculationMethod is PERCENTAGE

baseAmountnumber double nullable

Base amount if calculationMethod is PERCENTAGE

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.