Get one Charge

GET

api

billing

charges

{id}

Get one Charge

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

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

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

{
  "CoworkerId": 123,
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessCurrencyCode": "<string>",
  "ChargeNumber": "<string>",
  "Quantity": 123,
  "Description": "<string>",
  "InvoiceLineDisplayAs": "<string>",
  "RegularCharge": true,
  "DiscountAmount": 123,
  "CreditAmount": 123,
  "DiscountCode": "<string>",
  "DueDate": "<string>",
  "TotalAmount": 123,
  "PurchaseOrder": "<string>",
  "TaxRateId": 123,
  "TaxRateName": "<string>",
  "FinancialAccountId": 123,
  "FinancialAccountName": "<string>",
  "Invoiced": true,
  "InvoicedOn": "<string>",
  "SaleDate": "<string>",
  "FromTeamMember": true,
  "CoworkerExtraServiceName": "<string>",
  "CoworkerTimePassName": "<string>",
  "CoworkerProductName": "<string>",
  "TariffName": "<string>",
  "CoworkerProductUniqueId": "<string>",
  "BookingUniqueId": "<string>",
  "CoworkerContractUniqueId": "<string>",
  "CoworkerExtraServiceUniqueId": "<string>",
  "ExtraServiceUniqueId": "<string>",
  "CoworkerTimePassUniqueId": "<string>",
  "CoworkerChargeUniqueId": "<string>",
  "EventAttendeeUniqueId": "<string>",
  "InvoiceFromDate": "<string>",
  "InvoiceToDate": "<string>",
  "RepeatFrom": "<string>",
  "RepeatUntil": "<string>",
  "CoworkerDiscountCodeUniqueId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<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-Read role.

Path Parameters

integer

required

The Id of the Charge record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the customer billed for this charge; the customer’s invoicing location controls access..

integer

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

string

Display value for Business.Name..

string

Display value for Business.Currency.Code..

string

Read-only unique charge number assigned by the system after creation..

integer

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

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

number

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

number

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

string

Read-only discount-code text copied to this charge when it is generated..

string

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

number

Total monetary amount charged to the customer..

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

string

Display value for TaxRate.Name..

integer

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

string

Display value for FinancialAccount.Name..

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

Read-only UTC date and time set when this charge is marked invoiced..

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

Read-only GUID of the contract that generated this charge, when applicable..

string

Read-only GUID of the customer time credit that generated this charge, when applicable..

string

Read-only GUID of the underlying booking or printing rate associated with this charge, when applicable..

string

Read-only GUID of the customer pass that generated this charge, when applicable..

string

Read-only GUID of the related originating charge, when this charge was created from another charge..

string

Read-only GUID of the event attendance purchase that generated this charge, when applicable..

string

Read-only UTC start date and time of the billed invoice period, when applicable..

string

Read-only UTC end date and time of the billed invoice period, 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..

string

Read-only GUID of the customer discount-code record that generated this charge’s discount..

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

{
  "CoworkerId": 0,
  "BusinessId": 0,
  "BusinessName": null,
  "BusinessCurrencyCode": null,
  "ChargeNumber": null,
  "Quantity": 0,
  "Description": null,
  "InvoiceLineDisplayAs": null,
  "RegularCharge": false,
  "DiscountAmount": 0,
  "CreditAmount": 0,
  "DiscountCode": null,
  "DueDate": null,
  "TotalAmount": 0,
  "PurchaseOrder": null,
  "TaxRateId": null,
  "TaxRateName": null,
  "FinancialAccountId": null,
  "FinancialAccountName": null,
  "Invoiced": false,
  "InvoicedOn": null,
  "SaleDate": null,
  "FromTeamMember": false,
  "CoworkerExtraServiceName": null,
  "CoworkerTimePassName": null,
  "CoworkerProductName": null,
  "TariffName": null,
  "CoworkerProductUniqueId": null,
  "BookingUniqueId": null,
  "CoworkerContractUniqueId": null,
  "CoworkerExtraServiceUniqueId": null,
  "ExtraServiceUniqueId": null,
  "CoworkerTimePassUniqueId": null,
  "CoworkerChargeUniqueId": null,
  "EventAttendeeUniqueId": null,
  "InvoiceFromDate": null,
  "InvoiceToDate": null,
  "RepeatFrom": null,
  "RepeatUntil": null,
  "CoworkerDiscountCodeUniqueId": null,
  "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": "Charge Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one Charge

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

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

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

{
  "CoworkerId": 123,
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessCurrencyCode": "<string>",
  "ChargeNumber": "<string>",
  "Quantity": 123,
  "Description": "<string>",
  "InvoiceLineDisplayAs": "<string>",
  "RegularCharge": true,
  "DiscountAmount": 123,
  "CreditAmount": 123,
  "DiscountCode": "<string>",
  "DueDate": "<string>",
  "TotalAmount": 123,
  "PurchaseOrder": "<string>",
  "TaxRateId": 123,
  "TaxRateName": "<string>",
  "FinancialAccountId": 123,
  "FinancialAccountName": "<string>",
  "Invoiced": true,
  "InvoicedOn": "<string>",
  "SaleDate": "<string>",
  "FromTeamMember": true,
  "CoworkerExtraServiceName": "<string>",
  "CoworkerTimePassName": "<string>",
  "CoworkerProductName": "<string>",
  "TariffName": "<string>",
  "CoworkerProductUniqueId": "<string>",
  "BookingUniqueId": "<string>",
  "CoworkerContractUniqueId": "<string>",
  "CoworkerExtraServiceUniqueId": "<string>",
  "ExtraServiceUniqueId": "<string>",
  "CoworkerTimePassUniqueId": "<string>",
  "CoworkerChargeUniqueId": "<string>",
  "EventAttendeeUniqueId": "<string>",
  "InvoiceFromDate": "<string>",
  "InvoiceToDate": "<string>",
  "RepeatFrom": "<string>",
  "RepeatUntil": "<string>",
  "CoworkerDiscountCodeUniqueId": "<string>",
  "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

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200