Charges
Get one Charge
Retrieve a single Charge record by its Id.
GET
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
The Id of the Charge record to retrieve.
Code Examples
Response
200
Coworker Id.
Business Id.
Business name.
Business currency code.
Charge number.
Quantity.
Description.
Display text on invoice line.
Whether this is a regular charge.
Discount amount.
Credit amount.
Discount code.
Due date.
Total amount.
Purchase order.
Tax Rate Id.
Financial Account Id.
Whether the charge has been invoiced.
Date the charge was invoiced.
Sale date.
From Team Member.
Coworker Extra Service Name.
Coworker Time Pass Name.
Coworker Product Name.
Tariff Name.
Coworker Product Unique Id.
Booking Unique Id.
UniqueId of the CoworkerContract that originated this charge.
UniqueId of the CoworkerExtraService (booking extra-service charge) that originated this charge.
UniqueId of the ExtraService that originated this charge.
UniqueId of the CoworkerTimePass that originated this charge.
UniqueId of the original charge passed from a non-paying team member to the team’s paying member.
UniqueId of the EventAttendee that originated this charge.
Invoice period start date.
Invoice period end date.
Repeat from date.
Repeat until date.
UniqueId of the CoworkerDiscountCode applied to this charge.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response