Create CoworkerBookingCreditUseHistory

POST

api

billing

coworkerbookingcreditusehistories

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerBookingCreditId": 123,
  "CreditUsed": 123
}
'

import requests

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

payload = {
    "CoworkerBookingCreditId": 123,
    "CreditUsed": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({CoworkerBookingCreditId: 123, CreditUsed: 123})
};

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

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create role.

Request Body

Required Fields

integer

required

ID of the booking credit that was consumed.

number

required

Amount of credit consumed by this entry.

Optional Fields

string

Optional description or note for this credit use entry.

integer

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

integer

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

integer

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

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerBookingCreditId": 0,
    "CreditUsed": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CoworkerBookingCreditId: 0,
      CreditUsed: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerBookingCreditId': 0,
        'CreditUsed': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the coworkerbookingcreditusehistory was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerBookingCreditUseHistory was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "CreditUsed: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "CreditUsed"
    }
  ],
  "WasSuccessful": false
}

Update CoworkerBookingCreditUseHistoryUpdate an existing CoworkerBookingCreditUseHistory record.

Create CoworkerBookingCreditUseHistory

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerBookingCreditId": 123,
  "CreditUsed": 123
}
'

import requests

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

payload = {
    "CoworkerBookingCreditId": 123,
    "CreditUsed": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({CoworkerBookingCreditId: 123, CreditUsed: 123})
};

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

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Create CoworkerBookingCreditUseHistory

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400