Search CoworkerExtraServices

A CoworkerExtraService records a charge or credit assigned to a customer. It covers three use cases:

Booking charges — charges associated with bookings (e.g., meeting room usage fees). These are linked to a specific booking via BookingId and track the resource, time range, and price.
Time credit — booking time allowances for specific resource types. Customers can spend these credits when booking resources of the matching type. The unit of credit depends on the ChargePeriod of the linked extra service (minutes, days, uses, etc.). TotalUses and RemainingUses track the allowance.
Printing credit — credits for printing integrations such as PaperCut or Ezeep. The linked extra service has IsPrintingCredit = true. TotalUses and RemainingUses track the number of print jobs or pages available.

Records can be created manually or added automatically from a plan (tariff). When IsFromTariff is true, the record was provisioned by a customer’s contract (CoworkerContract) and is linked via CoworkerContractUniqueId.

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

CoworkerExtraService_Coworker

integer

Filter by Coworker Id.

CoworkerExtraService_Business

integer

Filter by Business Id.

CoworkerExtraService_ExtraService

integer

Filter by Extra Service Id.

CoworkerExtraService_ExtraService_Name

string

Filter by name of the linked extra service.

CoworkerExtraService_ExtraService_Currency_Code

string

Filter by currency code of the linked extra service (e.g., USD, EUR).

CoworkerExtraService_ExtraService_IsPrintingCredit

boolean

Filter by true if the linked extra service is a printing credit (PaperCut/Ezeep). False for booking time credit.

CoworkerExtraService_Description

string

Filter by free-text description of this charge or credit.

CoworkerExtraService_Notes

string

Filter by internal notes.

CoworkerExtraService_RemainingUses

integer

Filter by remaining credit (time or printing) the customer can still use.

CoworkerExtraService_TotalUses

integer

Filter by total credit originally allocated (time or printing). Unit depends on the ChargePeriod of the linked extra service.

CoworkerExtraService_Free

boolean

Filter by whether this charge or credit is free (no cost to the customer).

CoworkerExtraService_Price

number

Filter by price charged for this extra service.

CoworkerExtraService_LastMinutePriceAdjustment

number

Filter by price adjustment applied for last-minute bookings.

CoworkerExtraService_DynamicPriceAdjustment

number

Filter by price adjustment applied by demand-based dynamic pricing.

CoworkerExtraService_PriceFactorLastMinute

number

Filter by multiplier applied for last-minute booking pricing.

CoworkerExtraService_PriceFactorDemand

number

Filter by multiplier applied for demand-based pricing.

CoworkerExtraService_ValidFrom

string

Filter by date from which this credit becomes usable.

CoworkerExtraService_ExpireDate

string

Filter by date when this credit expires and can no longer be used.

CoworkerExtraService_DueDate

string

Filter by payment due date for the charge.

CoworkerExtraService_PurchaseOrder

string

Filter by purchase order.

CoworkerExtraService_ChargePeriod

integer

Filter by unit of measurement for time credit (Minutes, Days, Weeks, Months, Uses, FourWeekMonths).

CoworkerExtraService_Invoiced

boolean

Filter by whether this charge has already been invoiced.

CoworkerExtraService_InvoiceDate

string

Filter by invoice date.

CoworkerExtraService_IsFromTariff

boolean

Filter by whether this credit was automatically provisioned from the customer’s plan (tariff).

CoworkerExtraService_TariffTimePassUniqueId

string

Filter by links this credit back to the time pass definition in the plan.

CoworkerExtraService_CoworkerProductUniqueId

string

Filter by links this credit back to the customer product that provisioned it.

CoworkerExtraService_BookingUniqueId

string

Filter by unique ID of the booking that generated this charge.

CoworkerExtraService_AutomaticallyAdded

boolean

Filter by whether this record was automatically created (e.g., from a booking or plan renewal).

CoworkerExtraService_InvoiceThisCoworker

boolean

Filter by invoice the customer directly instead of the team or company paying member.

CoworkerExtraService_DiscountCode

string

Filter by discount code.

CoworkerExtraService_CoworkerDiscountUniqueId

string

Filter by unique ID of the discount applied to this charge.

CoworkerExtraService_DiscountAmount

number

Filter by amount discounted from the price.

CoworkerExtraService_BookingId

integer

Filter by iD of the booking that generated this charge.

CoworkerExtraService_BookingFromTime

string

Filter by start time of the booking that generated this charge.

CoworkerExtraService_BookingToTime

string

Filter by end time of the booking that generated this charge.

CoworkerExtraService_BookingResourceName

string

Filter by name of the resource booked (e.g., meeting room name).

CoworkerExtraService_CoworkerContractUniqueId

string

Filter by links this credit back to the customer contract that provisioned it.

Range Filters

from_CoworkerExtraService_RemainingUses

integer

Filter by remaining credit (time or printing) the customer can still use greater than or equal to this value.

to_CoworkerExtraService_RemainingUses

integer

Filter by remaining credit (time or printing) the customer can still use less than or equal to this value.

from_CoworkerExtraService_TotalUses

integer

Filter by total credit originally allocated (time or printing). Unit depends on the ChargePeriod of the linked extra service greater than or equal to this value.

to_CoworkerExtraService_TotalUses

integer

Filter by total credit originally allocated (time or printing). Unit depends on the ChargePeriod of the linked extra service less than or equal to this value.

from_CoworkerExtraService_Price

number

Filter by price charged for this extra service greater than or equal to this value.

to_CoworkerExtraService_Price

number

Filter by price charged for this extra service less than or equal to this value.

from_CoworkerExtraService_LastMinutePriceAdjustment

number

Filter by price adjustment applied for last-minute bookings greater than or equal to this value.

to_CoworkerExtraService_LastMinutePriceAdjustment

number

Filter by price adjustment applied for last-minute bookings less than or equal to this value.

from_CoworkerExtraService_DynamicPriceAdjustment

number

Filter by price adjustment applied by demand-based dynamic pricing greater than or equal to this value.

to_CoworkerExtraService_DynamicPriceAdjustment

number

Filter by price adjustment applied by demand-based dynamic pricing less than or equal to this value.

from_CoworkerExtraService_PriceFactorLastMinute

number

Filter by multiplier applied for last-minute booking pricing greater than or equal to this value.

to_CoworkerExtraService_PriceFactorLastMinute

number

Filter by multiplier applied for last-minute booking pricing less than or equal to this value.

from_CoworkerExtraService_PriceFactorDemand

number

Filter by multiplier applied for demand-based pricing greater than or equal to this value.

to_CoworkerExtraService_PriceFactorDemand

number

Filter by multiplier applied for demand-based pricing less than or equal to this value.

from_CoworkerExtraService_ValidFrom

string

Filter by date from which this credit becomes usable greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerExtraService_ValidFrom

string

Filter by date from which this credit becomes usable less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerExtraService_ExpireDate

string

Filter by date when this credit expires and can no longer be used greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerExtraService_ExpireDate

string

Filter by date when this credit expires and can no longer be used less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerExtraService_DueDate

string

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

to_CoworkerExtraService_DueDate

string

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

from_CoworkerExtraService_InvoiceDate

string

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

to_CoworkerExtraService_InvoiceDate

string

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

from_CoworkerExtraService_DiscountAmount

number

Filter by amount discounted from the price greater than or equal to this value.

to_CoworkerExtraService_DiscountAmount

number

Filter by amount discounted from the price less than or equal to this value.

from_CoworkerExtraService_BookingId

integer

Filter by iD of the booking that generated this charge greater than or equal to this value.

to_CoworkerExtraService_BookingId

integer

Filter by iD of the booking that generated this charge less than or equal to this value.

from_CoworkerExtraService_BookingFromTime

string

Filter by start time of the booking that generated this charge greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerExtraService_BookingFromTime

string

Filter by start time of the booking that generated this charge less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerExtraService_BookingToTime

string

Filter by end time of the booking that generated this charge greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerExtraService_BookingToTime

string

Filter by end time of the booking that generated this charge less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerExtraService_CreatedOn

string

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

to_CoworkerExtraService_CreatedOn

string

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

from_CoworkerExtraService_UpdatedOn

string

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

to_CoworkerExtraService_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/coworkerextraservices?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/coworkerextraservices?CoworkerExtraService_CreatedOn=example-value&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

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

Response

200

Records

CoworkerExtraService[]

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

Partial records — The listing endpoint returns a summary representation of each CoworkerExtraService. The following fields are not included in the Records[] response: Notes, InvoiceThisCoworker.To get all fields, fetch the full record using the Get one CoworkerExtraService 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,
      "ExtraServiceId": 0,
      "ExtraServiceName": null,
      "ExtraServiceCurrencyCode": null,
      "ExtraServiceIsPrintingCredit": false,
      "Description": null,
      "Notes": null,
      "RemainingUses": 0,
      "TotalUses": 0,
      "Free": false,
      "Price": null,
      "LastMinutePriceAdjustment": null,
      "DynamicPriceAdjustment": null,
      "PriceFactorLastMinute": null,
      "PriceFactorDemand": null,
      "ValidFrom": null,
      "ExpireDate": null,
      "DueDate": null,
      "PurchaseOrder": null,
      "ChargePeriod": 0,
      "Invoiced": false,
      "InvoiceDate": null,
      "IsFromTariff": false,
      "TariffTimePassUniqueId": null,
      "CoworkerProductUniqueId": null,
      "BookingUniqueId": null,
      "AutomaticallyAdded": false,
      "InvoiceThisCoworker": false,
      "DiscountCode": null,
      "CoworkerDiscountUniqueId": null,
      "DiscountAmount": null,
      "BookingId": null,
      "BookingFromTime": null,
      "BookingToTime": null,
      "BookingResourceName": null,
      "CoworkerContractUniqueId": 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": "CoworkerExtraService 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