Search Charges

GET

api

billing

charges

Search Charges

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

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

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the customer billed for this charge; the customer’s invoicing location controls access..

integer

Filter by iD of the location that issued this charge and whose currency applies..

string

Filter by display value for Business.Name..

string

Filter by display value for Business.Currency.Code..

string

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

integer

Filter by number of units billed by this charge; defaults to 1..

string

Filter by description of the billed item or service..

string

Filter by optional customer-facing text to display for the resulting invoice line instead of Description..

boolean

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

number

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

number

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

string

Filter by read-only discount-code text copied to this charge when it is generated..

string

Filter by optional UTC date and time before which this charge is not eligible to be invoiced..

number

Filter by total monetary amount charged to the customer..

string

Filter by optional purchase-order reference used for invoice grouping and billing..

integer

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

string

Filter by display value for TaxRate.Name..

integer

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

string

Filter by display value for FinancialAccount.Name..

boolean

Filter by 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

Filter by read-only UTC date and time set when this charge is marked invoiced..

string

Filter by optional UTC date and time when the underlying sale occurred..

boolean

Filter by 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

Filter by system-maintained display name of the customer time credit associated with this charge..

string

Filter by system-maintained display name of the customer pass associated with this charge..

string

Filter by system-maintained display name of the customer product sale associated with this charge..

string

Filter by system-maintained name of the plan associated with this charge..

string

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

string

Filter by system-maintained GUID of the booking that generated this charge, when applicable..

string

Filter by read-only GUID of the contract that generated this charge, when applicable..

string

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

string

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

string

Filter by read-only GUID of the customer pass that generated this charge, when applicable..

string

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

string

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

string

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

string

Filter by read-only UTC end date and time of the billed invoice period, when applicable..

string

Filter by optional UTC date and time from which this recurring charge may be invoiced..

string

Filter by optional UTC date and time after which this recurring charge must stop being invoiced..

string

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

Range Filters

integer

Filter by number of units billed by this charge; defaults to 1. greater than or equal to this value.

integer

Filter by number of units billed by this charge; defaults to 1. less than or equal to this value.

number

Filter by internal monetary discount amount; charge creation uses the system default and this field is not exposed to the agent. greater than or equal to this value.

number

Filter by internal monetary discount amount; charge creation uses the system default and this field is not exposed to the agent. less than or equal to this value.

number

Filter by internal monetary credit amount; charge creation uses the system default and this field is not exposed to the agent. greater than or equal to this value.

number

Filter by internal monetary credit amount; charge creation uses the system default and this field is not exposed to the agent. less than or equal to this value.

string

Filter by optional UTC date and time before which this charge is not eligible to be invoiced. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC date and time before which this charge is not eligible to be invoiced. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

number

Filter by total monetary amount charged to the customer. greater than or equal to this value.

number

Filter by total monetary amount charged to the customer. less than or equal to this value.

string

Filter by read-only UTC date and time set when this charge is marked invoiced. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC date and time set when this charge is marked invoiced. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC date and time when the underlying sale occurred. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC date and time when the underlying sale occurred. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC start date and time of the billed invoice period, when applicable. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC start date and time of the billed invoice period, when applicable. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC end date and time of the billed invoice period, when applicable. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC end date and time of the billed invoice period, when applicable. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC date and time from which this recurring charge may be invoiced. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC date and time from which this recurring charge may be invoiced. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC date and time after which this recurring charge must stop being invoiced. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC date and time after which this recurring charge must stop being invoiced. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/billing/charges?page=1&size=15&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/charges?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'CreatedOn',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/charges',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'CreatedOn',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/billing/charges?Charge_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/charges?' + new URLSearchParams({
    Charge_CreatedOn: 'example-value',
    orderBy: 'CreatedOn',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/charges',
    params={
        'Charge_CreatedOn': 'example-value',
        'orderBy': 'CreatedOn',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/billing/charges?from_Charge_UpdatedOn=2025-01-01T00:00&to_Charge_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/charges?' + new URLSearchParams({
    from_Charge_UpdatedOn: '2025-01-01T00:00',
    to_Charge_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/charges',
    params={
        'from_Charge_UpdatedOn': '2025-01-01T00:00',
        'to_Charge_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

Charge[]

The list of Charge records matching the query. See the Get one Charge endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each Charge. The following fields are not populated in the Records[] response: DiscountAmount, CreditAmount, PurchaseOrder.To get all fields, fetch the full record using the Get one Charge endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "CoworkerId": 0,
      "BusinessId": 0,
      "BusinessName": null,
      "BusinessCurrencyCode": null,
      "ChargeNumber": null,
      "Quantity": 0,
      "Description": null,
      "InvoiceLineDisplayAs": null,
      "RegularCharge": false,
      "DiscountCode": null,
      "DueDate": null,
      "TotalAmount": 0,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search Charges

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

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

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by CreatedOn

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200