Create Charge

POST

api

billing

charges

Create Charge

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/charges \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerId": 123,
  "BusinessId": 123,
  "Quantity": 123,
  "DiscountAmount": 123,
  "CreditAmount": 123,
  "TotalAmount": 123
}
'

import requests

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

payload = {
    "CoworkerId": 123,
    "BusinessId": 123,
    "Quantity": 123,
    "DiscountAmount": 123,
    "CreditAmount": 123,
    "TotalAmount": 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({
    CoworkerId: 123,
    BusinessId: 123,
    Quantity: 123,
    DiscountAmount: 123,
    CreditAmount: 123,
    TotalAmount: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/charges', 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 Charge is a generic debit item applied to a customer account. Prefer more specific entities when available — use CoworkerProduct for product sales, Booking for room/resource bookings, EventAttendee for event registrations, and CoworkerContract for recurring plan charges. Charges can reference the originating sale from another entity via its UniqueId (a GUID, not an integer ID). This is how items billed to a non-paying team member are passed through to the team’s paying member: the charge appears on the paying member’s account with a UniqueId reference back to the original CoworkerProduct, Booking, EventAttendee, or CoworkerTimePass. Booking-related extra-service charges are represented by CoworkerExtraService records and referenced via CoworkerExtraServiceUniqueId.

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 Charge-Create role.

Request Body

Required Fields

integer

required

ID of the coworker linked to this record.

integer

required

ID of the business linked to this record.

integer

required

Number of units.

number

required

Discount amount.

number

required

Credit amount.

number

required

Total amount.

Optional Fields

string

Free-text description of this charge.

string

Display text on invoice line.

boolean

Whether this is a regular charge.

string

Due date.

string

Purchase order.

integer

ID of the tax rate linked to this record.

integer

ID of the financial account linked to this record.

boolean

Whether the charge has been invoiced.

string

Sale date.

boolean

Whether from team member is enabled.

string

The coworker extra service name value for this charge.

string

The coworker time pass name value for this charge.

string

The coworker product name value for this charge.

string

The tariff name value for this charge.

string

ID of the coworker product unique associated with this record.

string

ID of the booking unique associated with this record.

string

Repeat from date.

string

Repeat until date.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/charges" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerId": 0,
    "BusinessId": 0,
    "Quantity": 0,
    "DiscountAmount": 0,
    "CreditAmount": 0,
    "TotalAmount": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/charges',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CoworkerId: 0,
      BusinessId: 0,
      Quantity: 0,
      DiscountAmount: 0,
      CreditAmount: 0,
      TotalAmount: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/charges',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerId': 0,
        'BusinessId': 0,
        'Quantity': 0,
        'DiscountAmount': 0,
        'CreditAmount': 0,
        'TotalAmount': 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 charge was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "Charge 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": "DiscountAmount: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "DiscountAmount"
    }
  ],
  "WasSuccessful": false
}

Update ChargeUpdate an existing Charge record.

Create Charge

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/charges \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerId": 123,
  "BusinessId": 123,
  "Quantity": 123,
  "DiscountAmount": 123,
  "CreditAmount": 123,
  "TotalAmount": 123
}
'

import requests

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

payload = {
    "CoworkerId": 123,
    "BusinessId": 123,
    "Quantity": 123,
    "DiscountAmount": 123,
    "CreditAmount": 123,
    "TotalAmount": 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({
    CoworkerId: 123,
    BusinessId: 123,
    Quantity: 123,
    DiscountAmount: 123,
    CreditAmount: 123,
    TotalAmount: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/charges', 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

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