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 (internal name CoworkerCharge) is a one-off debit billed to a customer at a location. It records the item, quantity, amount, optional tax, discount, credit, and invoicing timing; a recurring charge is eligible only when the customer’s main contract is due for renewal.

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 customer billed for this charge; the customer’s invoicing location controls access..

integer

required

ID of the location that issued this charge and whose currency applies..

integer

required

Number of units billed by this charge; defaults to 1..

number

required

Internal monetary discount amount; charge creation uses the system default and this field is not exposed to the agent..

number

required

Internal monetary credit amount; charge creation uses the system default and this field is not exposed to the agent..

number

required

Total monetary amount charged to the customer..

Optional Fields

string

Description of the billed item or service..

string

Optional customer-facing text to display for the resulting invoice line instead of Description..

boolean

Whether this recurring charge is invoiced only when the customer has a main contract due for renewal..

string

Optional UTC date and time before which this charge is not eligible to be invoiced..

string

Optional purchase-order reference used for invoice grouping and billing..

integer

Optional ID of the tax rate applied to this charge; required when the issuing location requires tax rates..

integer

Optional ID of the financial account that categorises this charge; required when the issuing location requires financial accounts..

boolean

Whether this charge has been added to an invoice; changing an invoiced charge is blocked for locked periods and its amount cannot change after payment..

string

Optional UTC date and time when the underlying sale occurred..

boolean

Internal flag for team-member charges; it bypasses the normal tax-rate and financial-account validation and must not be set by the agent..

string

System-maintained display name of the customer time credit associated with this charge..

string

System-maintained display name of the customer pass associated with this charge..

string

System-maintained display name of the customer product sale associated with this charge..

string

System-maintained name of the plan associated with this charge..

string

System-maintained GUID of the customer product sale that generated this charge, when applicable..

string

System-maintained GUID of the booking that generated this charge, when applicable..

string

Optional UTC date and time from which this recurring charge may be invoiced..

string

Optional UTC date and time after which this recurring charge must stop being invoiced..

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
}

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