Skip to main content
GET
/
api
/
billing
/
coworkerbookingcreditusehistories
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
A CoworkerBookingCreditUseHistory records each time a CoworkerBookingCredit was consumed. Each entry captures the amount of credit deducted and links back to the booking, event attendance, or invoice line that triggered the use. Use the read-only denormalised fields (BookingFromTime, BookingResourceName, EventAttendeeCalendarEventName, etc.) to inspect what the credit was spent on without needing to fetch the related records separately.

​
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 CoworkerBookingCreditUseHistory-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. 1 for ascending, -1 for descending.

​
Filters

​
CoworkerBookingCreditUseHistory_Description
string
Filter by optional description or note for this credit use entry.
​
CoworkerBookingCreditUseHistory_CoworkerBookingCredit
integer
Filter by iD of the booking credit that was consumed.
​
CoworkerBookingCreditUseHistory_Booking
integer
Filter by iD of the booking this credit was applied to, if the credit was used for a booking.
​
CoworkerBookingCreditUseHistory_Booking_FromTime
string
Filter by start time of the booking.
​
CoworkerBookingCreditUseHistory_Booking_ToTime
string
Filter by end time of the booking.
​
CoworkerBookingCreditUseHistory_Booking_Resource_Name
string
Filter by name of the resource that was booked.
​
CoworkerBookingCreditUseHistory_CoworkerInvoiceLine
integer
Filter by iD of the invoice line this credit was applied to, if the credit was used against an invoice.
​
CoworkerBookingCreditUseHistory_CoworkerInvoiceLine_CoworkerInvoice_Id
integer
Filter by iD of the invoice containing the linked invoice line.
​
CoworkerBookingCreditUseHistory_CoworkerInvoiceLine_CoworkerInvoice_InvoiceNumber
string
Filter by invoice number of the invoice containing the linked invoice line.
​
CoworkerBookingCreditUseHistory_EventAttendee
integer
Filter by iD of the event attendance record this credit was applied to, if the credit was used for an event.
​
CoworkerBookingCreditUseHistory_EventAttendee_CalendarEvent_Name
string
Filter by name of the calendar event the credit was used for.
​
CoworkerBookingCreditUseHistory_EventAttendee_EventProduct_Name
string
Filter by name of the event ticket product purchased by the attendee.
​
CoworkerBookingCreditUseHistory_EventAttendee_FullName
string
Filter by full name of the event attendee.
​
CoworkerBookingCreditUseHistory_EventAttendee_Email
string
Filter by email address of the event attendee.
​
CoworkerBookingCreditUseHistory_CreditUsed
number
Filter by amount of credit consumed by this entry.

​
Range Filters

​
from_CoworkerBookingCreditUseHistory_BookingFromTime
string
Filter by start time of the booking greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerBookingCreditUseHistory_BookingFromTime
string
Filter by start time of the booking less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_CoworkerBookingCreditUseHistory_BookingToTime
string
Filter by end time of the booking greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerBookingCreditUseHistory_BookingToTime
string
Filter by end time of the booking less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_CoworkerBookingCreditUseHistory_CoworkerInvoiceLineCoworkerInvoiceId
integer
Filter by iD of the invoice containing the linked invoice line greater than or equal to this value.
​
to_CoworkerBookingCreditUseHistory_CoworkerInvoiceLineCoworkerInvoiceId
integer
Filter by iD of the invoice containing the linked invoice line less than or equal to this value.
​
from_CoworkerBookingCreditUseHistory_CreditUsed
number
Filter by amount of credit consumed by this entry greater than or equal to this value.
​
to_CoworkerBookingCreditUseHistory_CreditUsed
number
Filter by amount of credit consumed by this entry less than or equal to this value.
​
from_CoworkerBookingCreditUseHistory_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerBookingCreditUseHistory_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_CoworkerBookingCreditUseHistory_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerBookingCreditUseHistory_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/coworkerbookingcreditusehistories?page=1&size=15&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by CreatedOn

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

​
Range filters

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

​
Response

​
200

​
Records
CoworkerBookingCreditUseHistory[]
The list of CoworkerBookingCreditUseHistory records matching the query. See the Get one CoworkerBookingCreditUseHistory endpoint for the full list of properties returned for each record.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (1 = 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": [
    {
      "Description": null,
      "CoworkerBookingCreditId": 0,
      "BookingId": null,
      "BookingFromTime": null,
      "BookingToTime": null,
      "BookingResourceName": null,
      "CoworkerInvoiceLineId": null,
      "CoworkerInvoiceLineCoworkerInvoiceId": null,
      "CoworkerInvoiceLineCoworkerInvoiceInvoiceNumber": null,
      "EventAttendeeId": null,
      "EventAttendeeCalendarEventName": null,
      "EventAttendeeEventProductName": null,
      "EventAttendeeFullName": null,
      "EventAttendeeEmail": null,
      "CreditUsed": 0,
      "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": "CoworkerBookingCreditUseHistory 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
}