Get one Charge - Nexudus Platform

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

{
  "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,
  "FinancialAccountId": 123,
  "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 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-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"

Response

200

CoworkerId

integer

ID of the coworker linked to this record.

BusinessId

integer

ID of the business linked to this record.

BusinessName

string

Business name.

BusinessCurrencyCode

string

Business currency code.

ChargeNumber

string

Charge number.

Quantity

integer

Number of units.

Description

string

Free-text description of this charge.

InvoiceLineDisplayAs

string

Display text on invoice line.

RegularCharge

boolean

Whether this is a regular charge.

DiscountAmount

number

Discount amount.

CreditAmount

number

Credit amount.

DiscountCode

string

Discount code.

DueDate

string

Due date.

TotalAmount

number

Total amount.

PurchaseOrder

string

Purchase order.

TaxRateId

integer

ID of the tax rate linked to this record.

FinancialAccountId

integer

ID of the financial account linked to this record.

Invoiced

boolean

Whether the charge has been invoiced.

InvoicedOn

string

Date the charge was invoiced.

SaleDate

string

Sale date.

FromTeamMember

boolean

Whether from team member is enabled.

CoworkerExtraServiceName

string

The coworker extra service name value for this charge.

CoworkerTimePassName

string

The coworker time pass name value for this charge.

CoworkerProductName

string

The coworker product name value for this charge.

TariffName

string

The tariff name value for this charge.

CoworkerProductUniqueId

string

ID of the coworker product unique associated with this record.

BookingUniqueId

string

ID of the booking unique associated with this record.

CoworkerContractUniqueId

string

UniqueId of the CoworkerContract that originated this charge.

CoworkerExtraServiceUniqueId

string

UniqueId of the CoworkerExtraService (booking extra-service charge) that originated this charge.

ExtraServiceUniqueId

string

UniqueId of the ExtraService that originated this charge.

CoworkerTimePassUniqueId

string

UniqueId of the CoworkerTimePass that originated this charge.

CoworkerChargeUniqueId

string

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

EventAttendeeUniqueId

string

UniqueId of the EventAttendee that originated this charge.

InvoiceFromDate

string

Invoice period start date.

InvoiceToDate

string

Invoice period end date.

RepeatFrom

string

Repeat from date.

RepeatUntil

string

Repeat until date.

CoworkerDiscountCodeUniqueId

string

UniqueId of the CoworkerDiscountCode applied to this charge.

integer

Unique record identifier.

UniqueId

string

UUID of the record.

CreatedOn

string

Date and time the record was created (ISO 8601).

UpdatedOn

string

Date and time the record was last updated (ISO 8601).

UpdatedBy

string

Email of the user who last updated this record.

IsNew

boolean

Whether the record was recently created.

SystemId

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,
  "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
}

Get multiple ChargesRetrieve multiple Charge records by their Ids in a single request.

Get one Charge

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

{
  "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,
  "FinancialAccountId": 123,
  "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>"
}

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200