Get one CoworkerBookingCreditUseHistory

GET

api

billing

coworkerbookingcreditusehistories

{id}

Get one CoworkerBookingCreditUseHistory

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

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Description": "<string>",
  "CoworkerBookingCreditId": 123,
  "BookingId": 123,
  "BookingFromTime": "<string>",
  "BookingToTime": "<string>",
  "BookingResourceName": "<string>",
  "CoworkerInvoiceLineId": 123,
  "CoworkerInvoiceLineCoworkerInvoiceId": 123,
  "CoworkerInvoiceLineCoworkerInvoiceInvoiceNumber": "<string>",
  "EventAttendeeId": 123,
  "EventAttendeeCalendarEventName": "<string>",
  "EventAttendeeEventProductName": "<string>",
  "EventAttendeeFullName": "<string>",
  "EventAttendeeEmail": "<string>",
  "CreditUsed": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

integer

required

The Id of the CoworkerBookingCreditUseHistory record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

string

Optional description or note for this credit use entry.

integer

ID of the booking credit that was consumed.

integer

ID of the booking this credit was applied to, if the credit was used for a booking.

string

Start time of the booking.

string

End time of the booking.

string

Name of the resource that was booked.

integer

ID of the invoice line this credit was applied to, if the credit was used against an invoice.

integer

ID of the invoice containing the linked invoice line.

string

Invoice number of the invoice containing the linked invoice line.

integer

ID of the event attendance record this credit was applied to, if the credit was used for an event.

string

Name of the calendar event the credit was used for.

string

Name of the event ticket product purchased by the attendee.

string

Full name of the event attendee.

string

Email address of the event attendee.

number

Amount of credit consumed by this entry.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "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
}

Get multiple CoworkerBookingCreditUseHistoriesRetrieve multiple CoworkerBookingCreditUseHistory records by their Ids in a single request.

Get one CoworkerBookingCreditUseHistory

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

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Description": "<string>",
  "CoworkerBookingCreditId": 123,
  "BookingId": 123,
  "BookingFromTime": "<string>",
  "BookingToTime": "<string>",
  "BookingResourceName": "<string>",
  "CoworkerInvoiceLineId": 123,
  "CoworkerInvoiceLineCoworkerInvoiceId": 123,
  "CoworkerInvoiceLineCoworkerInvoiceInvoiceNumber": "<string>",
  "EventAttendeeId": 123,
  "EventAttendeeCalendarEventName": "<string>",
  "EventAttendeeEventProductName": "<string>",
  "EventAttendeeFullName": "<string>",
  "EventAttendeeEmail": "<string>",
  "CreditUsed": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Get one CoworkerBookingCreditUseHistory

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200