Search CoworkerBookingCredits

GET

api

billing

coworkerbookingcredits

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/coworkerbookingcredits \
  --header 'Authorization: Basic <encoded-value>'

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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 CaneBeUsedForBookings to allow the credit to pay for bookings. Use ElegibleResourceTypes to restrict the credit to specific resource types; if left empty the credit is valid for all resource types.
Events — set CaneBeUsedForEvents to allow the credit to pay for event sign-ups. Use EventCategories to restrict to specific event categories; if left empty the credit is valid for all events.

Setting 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

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

The property name to sort results by (e.g. Name, CreatedOn).

dir

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

CoworkerBookingCredit_Coworker

integer

Filter by iD of the customer this credit is assigned to.

CoworkerBookingCredit_Business

integer

Filter by iD of the location issuing the credit.

CoworkerBookingCredit_Business_Name

string

Filter by location name.

CoworkerBookingCredit_Business_Currency_Code

string

Filter by currency code of the location.

CoworkerBookingCredit_Description

string

Filter by optional description or label for this credit.

CoworkerBookingCredit_TariffBookingCredit

integer

Filter by iD of the plan credit template (TariffBookingCredit) that originated this credit, if any.

CoworkerBookingCredit_TariffBookingCredit_Name

string

Filter by name of the plan credit template that originated this credit.

CoworkerBookingCredit_RemainingCredit

number

Filter by remaining credit balance.

CoworkerBookingCredit_TotalCredit

number

Filter by total credit amount originally assigned.

CoworkerBookingCredit_ValidFrom

string

Filter by date from which this credit is valid.

CoworkerBookingCredit_ExpireDate

string

Filter by date on which this credit expires.

CoworkerBookingCredit_CaneBeUsedForBookings

boolean

Filter by whether this credit can be used to pay for bookings. Restrict to specific resource types with ElegibleResourceTypes.

CoworkerBookingCredit_CaneBeUsedForEvents

boolean

Filter by whether this credit can be used to pay for event sign-ups. Restrict to specific categories with EventCategories.

CoworkerBookingCredit_IsUniversalCredit

boolean

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.

CoworkerBookingCredit_CoworkerProductUniqueId

string

Filter by unique ID of the product purchase that created this credit.

CoworkerBookingCredit_UseCreditPrice

boolean

Filter by whether to use the credit price instead of the standard booking price when this credit is applied.

CoworkerBookingCredit_CoworkerContractUniqueId

string

Filter by unique ID of the contract that originated this credit.

CoworkerBookingCredit_AppliesToCharges

boolean

Filter by whether this universal credit applies to other charges.

Range Filters

from_CoworkerBookingCredit_RemainingCredit

number

Filter by remaining credit balance greater than or equal to this value.

to_CoworkerBookingCredit_RemainingCredit

number

Filter by remaining credit balance less than or equal to this value.

from_CoworkerBookingCredit_TotalCredit

number

Filter by total credit amount originally assigned greater than or equal to this value.

to_CoworkerBookingCredit_TotalCredit

number

Filter by total credit amount originally assigned less than or equal to this value.

from_CoworkerBookingCredit_ValidFrom

string

Filter by date from which this credit is valid greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerBookingCredit_ValidFrom

string

Filter by date from which this credit is valid less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerBookingCredit_ExpireDate

string

Filter by date on which this credit expires greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerBookingCredit_ExpireDate

string

Filter by date on which this credit expires less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerBookingCredit_CreatedOn

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CoworkerBookingCredit_CreatedOn

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_CoworkerBookingCredit_UpdatedOn

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CoworkerBookingCredit_UpdatedOn

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerbookingcredits?page=1&size=15&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerbookingcredits?CoworkerBookingCredit_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerbookingcredits?from_CoworkerBookingCredit_UpdatedOn=2025-01-01T00:00&to_CoworkerBookingCredit_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records

CoworkerBookingCredit[]

The list of CoworkerBookingCredit records matching the query. See the Get one CoworkerBookingCredit endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each CoworkerBookingCredit. The following fields are not populated in the Records[] response: Description, CaneBeUsedForBookings, CaneBeUsedForEvents, IsUniversalCredit, AppliesToCharges.To get all fields, fetch the full record using the Get one CoworkerBookingCredit endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

The sort direction (0 = ascending, 1 = descending).

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "CoworkerId": 0,
      "BusinessId": 0,
      "BusinessName": null,
      "BusinessCurrencyCode": null,
      "TariffBookingCreditId": null,
      "TariffBookingCreditName": null,
      "ElegibleResourceTypes": [],
      "ElegibleProducts": [],
      "ElegibleTariffs": [],
      "RemainingCredit": 0,
      "TotalCredit": 0,
      "ValidFrom": null,
      "ExpireDate": null,
      "EventCategories": [],
      "CoworkerProductUniqueId": null,
      "UseCreditPrice": false,
      "CoworkerContractUniqueId": null,
      "ElegiblePasses": [],
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "CoworkerBookingCredit Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one CoworkerBookingCreditRetrieve a single CoworkerBookingCredit record by its Id.

Search CoworkerBookingCredits

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/coworkerbookingcredits \
  --header 'Authorization: Basic <encoded-value>'

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Documentation Index

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by CreatedOn

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200