Retrieve a list of invoices

get

https://api.zenbooker.com/v1/invoices

Returns a list of invoices. Optionally filter the invoices using parameters below.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

sort_by

string

enum

Defaults to creation_date. You can use total_paid or total_due to sort by monetary amounts.

Allowed:

sort_order

string

enum

If empty, defaults to ascending

Allowed:

created_before

date

Returns invoices created before this datetime

created_after

date

Returns invoices created after this datetime

status

string

enum

draft, unpaid, partial_paid ,paid ,void. If empty, returns invoices in any status.

Allowed:

customer

string

The ID of the customer to return invoices for.

territory

string

Filter invoices based on the ID of the service territory.

cursor

int32

Defaults to 0

Pagination start

limit

int32

Defaults to 20

The maximum number of results to return. If not specified, defaults to 20. Max is 100.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400