CoworkerBookingCredits
Search CoworkerBookingCredits
Search and list CoworkerBookingCredit records with filtering, sorting, and pagination.
GET
A CoworkerBookingCredit is an amount of monetary credit assigned to a customer. Credits are typically created automatically when a customer’s contract on a plan that includes a
TariffBookingCredit renews, but can also be created manually.
Credit can be configured for two primary uses:
- Bookings — set
CaneBeUsedForBookingsto allow the credit to pay for bookings. UseElegibleResourceTypesto restrict the credit to specific resource types; if left empty the credit is valid for all resource types. - Events — set
CaneBeUsedForEventsto allow the credit to pay for event sign-ups. UseEventCategoriesto restrict to specific event categories; if left empty the credit is valid for all events.
IsUniversalCredit enables the credit for products, time passes, and other charges. Use ElegibleProducts, ElegiblePasses, and AppliesToCharges to restrict which products or passes the credit is valid for. If all restriction lists are empty the universal credit applies to all products, passes and charges.
Use ValidFrom and ExpireDate to control the validity window of the credit.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CoworkerBookingCredit-List role.Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by iD of the customer this credit is assigned to.
Filter by iD of the location issuing the credit.
Filter by location name.
Filter by currency code of the location.
Filter by optional description or label for this credit.
Filter by iD of the plan credit template (TariffBookingCredit) that originated this credit, if any.
Filter by name of the plan credit template that originated this credit.
Filter by remaining credit balance.
Filter by total credit amount originally assigned.
Filter by date from which this credit is valid.
Filter by date on which this credit expires.
Filter by whether this credit can be used to pay for bookings. Restrict to specific resource types with
ElegibleResourceTypes.Filter by whether this credit can be used to pay for event sign-ups. Restrict to specific categories with
EventCategories.Filter by whether this is a universal credit applicable to products, time passes and other charges. Restrict with
ElegibleProducts, ElegiblePasses and AppliesToCharges; if all are empty the credit applies to all products, passes and charges.Filter by unique ID of the product purchase that created this credit.
Filter by whether to use the credit price instead of the standard booking price when this credit is applied.
Filter by unique ID of the contract that originated this credit.
Filter by whether this universal credit applies to other charges.
Range Filters
Filter by remaining credit balance greater than or equal to this value.
Filter by remaining credit balance less than or equal to this value.
Filter by total credit amount originally assigned greater than or equal to this value.
Filter by total credit amount originally assigned less than or equal to this value.
Filter by date from which this credit is valid greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date from which this credit is valid less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date on which this credit expires greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date on which this credit expires less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by CreatedOn
Range filters
Response
200
The list of CoworkerBookingCredit records matching the query. See the Get one CoworkerBookingCredit endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response