Search Charges

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

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

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

dir

integer

Sort direction. 1 for ascending, -1 for descending.

Filters

Charge_Coworker

integer

Filter by Coworker Id.

Charge_Business

integer

Filter by Business Id.

Charge_Business_Name

string

Filter by business name.

Charge_Business_Currency_Code

string

Filter by business currency code.

Charge_ChargeNumber

string

Filter by charge number.

Charge_Quantity

integer

Filter by quantity.

Charge_Description

string

Filter by description.

Charge_InvoiceLineDisplayAs

string

Filter by display text on invoice line.

Charge_RegularCharge

boolean

Filter by whether this is a regular charge.

Charge_DiscountAmount

number

Filter by discount amount.

Charge_CreditAmount

number

Filter by credit amount.

Charge_DiscountCode

string

Filter by discount code.

Charge_DueDate

string

Filter by due date.

Charge_TotalAmount

number

Filter by total amount.

Charge_PurchaseOrder

string

Filter by purchase order.

Charge_TaxRate

integer

Filter by Tax Rate Id.

Charge_FinancialAccount

integer

Filter by Financial Account Id.

Charge_Invoiced

boolean

Filter by whether the charge has been invoiced.

Charge_InvoicedOn

string

Filter by date the charge was invoiced.

Charge_SaleDate

string

Filter by sale date.

Charge_FromTeamMember

boolean

Filter by From Team Member.

Charge_CoworkerExtraServiceName

string

Filter by Coworker Extra Service Name.

Charge_CoworkerTimePassName

string

Filter by Coworker Time Pass Name.

Charge_CoworkerProductName

string

Filter by Coworker Product Name.

Charge_TariffName

string

Filter by Tariff Name.

Charge_CoworkerProductUniqueId

string

Filter by Coworker Product Unique Id.

Charge_BookingUniqueId

string

Filter by Booking Unique Id.

Charge_CoworkerContractUniqueId

string

Filter by uniqueId of the CoworkerContract that originated this charge.

Charge_CoworkerExtraServiceUniqueId

string

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

Charge_ExtraServiceUniqueId

string

Filter by uniqueId of the ExtraService that originated this charge.

Charge_CoworkerTimePassUniqueId

string

Filter by uniqueId of the CoworkerTimePass that originated this charge.

Charge_CoworkerChargeUniqueId

string

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

Charge_EventAttendeeUniqueId

string

Filter by uniqueId of the EventAttendee that originated this charge.

Charge_InvoiceFromDate

string

Filter by invoice period start date.

Charge_InvoiceToDate

string

Filter by invoice period end date.

Charge_RepeatFrom

string

Filter by repeat from date.

Charge_RepeatUntil

string

Filter by repeat until date.

Charge_CoworkerDiscountCodeUniqueId

string

Filter by uniqueId of the CoworkerDiscountCode applied to this charge.

Range Filters

from_Charge_Quantity

integer

Filter by quantity greater than or equal to this value.

to_Charge_Quantity

integer

Filter by quantity less than or equal to this value.

from_Charge_DiscountAmount

number

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

to_Charge_DiscountAmount

number

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

from_Charge_CreditAmount

number

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

to_Charge_CreditAmount

number

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

from_Charge_DueDate

string

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

to_Charge_DueDate

string

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

from_Charge_TotalAmount

number

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

to_Charge_TotalAmount

number

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

from_Charge_InvoicedOn

string

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

to_Charge_InvoicedOn

string

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

from_Charge_SaleDate

string

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

to_Charge_SaleDate

string

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

from_Charge_InvoiceFromDate

string

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

to_Charge_InvoiceFromDate

string

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

from_Charge_InvoiceToDate

string

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

to_Charge_InvoiceToDate

string

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

from_Charge_RepeatFrom

string

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

to_Charge_RepeatFrom

string

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

from_Charge_RepeatUntil

string

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

to_Charge_RepeatUntil

string

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

from_Charge_CreatedOn

string

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

to_Charge_CreatedOn

string

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

from_Charge_UpdatedOn

string

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

to_Charge_UpdatedOn

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=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by CreatedOn

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

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=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records

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

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

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

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

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,
      "DiscountAmount": 0,
      "CreditAmount": 0,
      "DiscountCode": null,
      "DueDate": null,
      "TotalAmount": 0,
      "PurchaseOrder": null,
      "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
}

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

​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