Search Charges

GET

api

billing

charges

Search Charges

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

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

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 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-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 coworker linked to this record.

integer

Filter by iD of the business linked to this record.

string

Filter by business name.

string

Filter by business currency code.

string

Filter by charge number.

integer

Filter by number of units.

string

Filter by free-text description of this charge.

string

Filter by display text on invoice line.

boolean

Filter by whether this is a regular charge.

number

Filter by discount amount.

number

Filter by credit amount.

string

Filter by discount code.

string

Filter by due date.

number

Filter by total amount.

string

Filter by purchase order.

integer

Filter by iD of the tax rate linked to this record.

integer

Filter by iD of the financial account linked to this record.

boolean

Filter by whether the charge has been invoiced.

string

Filter by date the charge was invoiced.

string

Filter by sale date.

boolean

Filter by whether from team member is enabled.

string

Filter by the coworker extra service name value for this charge.

string

Filter by the coworker time pass name value for this charge.

string

Filter by the coworker product name value for this charge.

string

Filter by the tariff name value for this charge.

string

Filter by iD of the coworker product unique associated with this record.

string

Filter by iD of the booking unique associated with this record.

string

Filter by uniqueId of the CoworkerContract that originated this charge.

string

Filter by uniqueId of the CoworkerExtraService (booking extra-service charge) that originated this charge.

string

Filter by uniqueId of the ExtraService that originated this charge.

string

Filter by uniqueId of the CoworkerTimePass that originated this charge.

string

Filter by uniqueId of the original charge passed from a non-paying team member to the team’s paying member.

string

Filter by uniqueId of the EventAttendee that originated this charge.

string

Filter by invoice period start date.

string

Filter by invoice period end date.

string

Filter by repeat from date.

string

Filter by repeat until date.

string

Filter by uniqueId of the CoworkerDiscountCode applied to this charge.

Range Filters

integer

Filter by number of units greater than or equal to this value.

integer

Filter by number of units less than or equal to this value.

number

Filter by discount amount greater than or equal to this value.

number

Filter by discount amount less than or equal to this value.

number

Filter by credit amount greater than or equal to this value.

number

Filter by credit amount less than or equal to this value.

string

Filter by due date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by due date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

number

Filter by total amount greater than or equal to this value.

number

Filter by total amount less than or equal to this value.

string

Filter by date the charge was invoiced greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date the charge was invoiced less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by sale date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by sale date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by invoice period start date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by invoice period start date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by invoice period end date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by invoice period end date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by repeat from date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by repeat from date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by repeat until date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by repeat until date 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,
      "FinancialAccountId": 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
}

Get one ChargeRetrieve a single Charge record by its Id.

Search Charges

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

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

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