Retrieve a list of transactions

get

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

Returns a list of transactions. Optionally filter the transactions 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 transactions created before this datetime

created_after

date

Returns transactions created after this datetime

type

string

enum

Filter by the transaction type: external_transaction or stripe_payment.

Allowed:

payment_method

string

enum

Filter by the payment_method type used for the transaction. Use stripe to return stripe payments processed through Zenbooker. credit_card to return external credit card transaction recorded in Zenbooker. Or cash, check, or custom.

Allowed:

status

string

enum

succeeded, failed, voided. If empty, returns transactions with any status.

Allowed:

transaction_date_before

date

Return transactions with a recorded payment date before this datetime.

transaction_date_after

date

Return transactions with a recorded payment date after this datetime.

customer

string

The ID of the customer to return transactions for.

territory

string

Filter transactions 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

200200

400400