Bills

Search bills

Search for one or more bills.

get/v1/Bills

Request

Query parameters

search.bill_idinteger[]

Query by bill identifier.

search.parent_bill_idinteger[]

Query by parent bill identifier.

search.bill_typestring[]

Query by bill type (i.e. NORMAL, PARENT, CHILD).

search.customer_idinteger[]

Query by customer id.

search.due_date_startstring date-time

Return only entries due after this date.

search.due_date_endstring date-time

Return only entries due before this date.

search.created_date_startstring date-time

Return only entries created after this date.

search.created_date_endstring date-time

Return only entries created before this date.

search.print_queue_flagboolean

Query by bills ready for the print queue.

search.ebpp_queue_flagboolean

Query by bills ready for the email queue.

search.ebpp_sent_date_startstring date-time

Return bills emailed after this date.

search.ebpp_sent_date_endstring date-time

Return bills emailed before this date.

search.isLiveboolean

Query by bill ready for BillCenter.

search.cycle_date_startstring date-time

Return only entries due after this date.

search.cycle_date_endstring date-time

Return only entries due before this date.

search.print_profile_idinteger[]

Query by bill print profile id.

search.page_sizeinteger

Defines how many items to return at a time.

search.pageinteger

Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.

Changes

No recorded changes to this operation across all 2 revisions of this API.