Search CoworkerExtraServices

GET

api

billing

coworkerextraservices

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

import requests

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

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/coworkerextraservices', 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 Customer Time Credit (CoworkerExtraService) records a customer’s booking time or printing allowance, or a charge generated for a booking; manual credits are used only for matching booking rates while plan, product, and booking records are managed by their source workflow.

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.

Enums

eChargePeriod — ChargePeriod values

Value	Name
1	Minutes
2	Days
3	Weeks
4	Months
5	Uses
6	FourWeekMonths

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 customer who owns this time credit or booking charge..

integer

Filter by iD of the location that issued this record; it is required and cannot be changed after creation..

integer

Filter by iD of the booking rate that defines this record’s eligible resource types, currency, and credit type..

string

Filter by display value for ExtraService.Name..

string

Filter by display value for ExtraService.Currency.Code..

boolean

Filter by display value for ExtraService.IsPrintingCredit..

string

Filter by read-only description generated for the assigned booking rate or credit..

string

Filter by optional internal notes about this time credit or booking charge..

integer

Filter by read-only unused credit remaining, in the unit selected by ChargePeriod; it is reduced when the credit is used..

integer

Filter by total credit granted, in the ChargePeriod unit; it must be at least RemainingUses and is set only when creating a manual credit..

boolean

Filter by whether the record has no charge to the customer; when true, calculated price is zero..

number

Filter by optional monetary amount charged in the booking rate’s currency; when omitted, the server calculates it from the rate and TotalUses..

number

Filter by read-only monetary adjustment calculated for a last-minute booking..

number

Filter by read-only monetary adjustment calculated by demand-based pricing..

number

Filter by read-only price multiplier calculated for a last-minute booking..

number

Filter by read-only price multiplier calculated by demand-based pricing..

string

Filter by optional UTC date and time when credit becomes usable; blank means it can be used immediately..

string

Filter by optional UTC expiry date and time; blank means no expiry, and when set it must be after ValidFrom and credit is valid only before it..

string

Filter by optional UTC due date for invoicing this booking charge; blank means it is included on the next invoice..

string

Filter by optional customer purchase-order reference for invoicing..

integer

Filter by unit used for TotalUses and RemainingUses: Minutes, Days, Weeks, Months, Uses, or FourWeekMonths..

boolean

Filter by whether this booking charge has been added to an invoice; invoiced records have billing update restrictions..

string

Filter by read-only UTC date and time when this charge was invoiced..

boolean

Filter by whether this credit was automatically provisioned from the customer’s plan; plan-provisioned credits cannot be deleted directly..

string

Filter by internal identifier linking a plan-provisioned credit to its plan benefit definition; managed by contract processing..

string

Filter by internal identifier linking this record to the customer product that provisioned it; such records cannot be deleted directly..

string

Filter by internal booking identifier that links a generated booking charge to its source booking; reverse or change the booking instead..

boolean

Filter by whether the record was created automatically for a booking rather than as a manually assigned credit; automatic records are not eligible credit..

boolean

Filter by whether to invoice this customer directly rather than their team or company paying customer..

string

Filter by read-only discount-code text applied to this charge..

string

Filter by internal identifier of the customer discount applied to this charge; the discount is managed through its discount record..

number

Filter by read-only monetary amount discounted from Price in the booking rate’s currency..

integer

Filter by read-only internal numeric ID of the booking that generated this charge; use the Booking entity instead..

string

Filter by read-only UTC start time copied from the source booking; update the booking instead..

string

Filter by read-only UTC end time copied from the source booking; update the booking instead..

string

Filter by read-only resource name copied from the source booking; update the booking instead..

string

Filter by internal identifier linking a plan-provisioned credit to its customer contract; managed by contract processing..

Range Filters

integer

Filter by read-only unused credit remaining, in the unit selected by ChargePeriod; it is reduced when the credit is used. greater than or equal to this value.

integer

Filter by read-only unused credit remaining, in the unit selected by ChargePeriod; it is reduced when the credit is used. less than or equal to this value.

integer

Filter by total credit granted, in the ChargePeriod unit; it must be at least RemainingUses and is set only when creating a manual credit. greater than or equal to this value.

integer

Filter by total credit granted, in the ChargePeriod unit; it must be at least RemainingUses and is set only when creating a manual credit. less than or equal to this value.

number

Filter by optional monetary amount charged in the booking rate’s currency; when omitted, the server calculates it from the rate and TotalUses. greater than or equal to this value.

number

Filter by optional monetary amount charged in the booking rate’s currency; when omitted, the server calculates it from the rate and TotalUses. less than or equal to this value.

number

Filter by read-only monetary adjustment calculated for a last-minute booking. greater than or equal to this value.

number

Filter by read-only monetary adjustment calculated for a last-minute booking. less than or equal to this value.

number

Filter by read-only monetary adjustment calculated by demand-based pricing. greater than or equal to this value.

number

Filter by read-only monetary adjustment calculated by demand-based pricing. less than or equal to this value.

number

Filter by read-only price multiplier calculated for a last-minute booking. greater than or equal to this value.

number

Filter by read-only price multiplier calculated for a last-minute booking. less than or equal to this value.

number

Filter by read-only price multiplier calculated by demand-based pricing. greater than or equal to this value.

number

Filter by read-only price multiplier calculated by demand-based pricing. less than or equal to this value.

string

Filter by optional UTC date and time when credit becomes usable; blank means it can be used immediately. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC date and time when credit becomes usable; blank means it can be used immediately. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC expiry date and time; blank means no expiry, and when set it must be after ValidFrom and credit is valid only before it. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC expiry date and time; blank means no expiry, and when set it must be after ValidFrom and credit is valid only before it. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC due date for invoicing this booking charge; blank means it is included on the next invoice. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC due date for invoicing this booking charge; blank means it is included on the next invoice. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC date and time when this charge was invoiced. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC date and time when this charge was invoiced. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

number

Filter by read-only monetary amount discounted from Price in the booking rate’s currency. greater than or equal to this value.

number

Filter by read-only monetary amount discounted from Price in the booking rate’s currency. less than or equal to this value.

integer

Filter by read-only internal numeric ID of the booking that generated this charge; use the Booking entity instead. greater than or equal to this value.

integer

Filter by read-only internal numeric ID of the booking that generated this charge; use the Booking entity instead. less than or equal to this value.

string

Filter by read-only UTC start time copied from the source booking; update the booking instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC start time copied from the source booking; update the booking instead. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC end time copied from the source booking; update the booking instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC end time copied from the source booking; update the booking instead. 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/coworkerextraservices?page=1&size=15&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerextraservices?' + 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/coworkerextraservices',
    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/coworkerextraservices?CoworkerExtraService_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerextraservices?' + new URLSearchParams({
    CoworkerExtraService_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/coworkerextraservices',
    params={
        'CoworkerExtraService_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/coworkerextraservices?from_CoworkerExtraService_UpdatedOn=2025-01-01T00:00&to_CoworkerExtraService_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerextraservices?' + new URLSearchParams({
    from_CoworkerExtraService_UpdatedOn: '2025-01-01T00:00',
    to_CoworkerExtraService_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/coworkerextraservices',
    params={
        'from_CoworkerExtraService_UpdatedOn': '2025-01-01T00:00',
        'to_CoworkerExtraService_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

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 populated in the Records[] response: 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.

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,
      "ExtraServiceId": 0,
      "ExtraServiceName": null,
      "ExtraServiceCurrencyCode": null,
      "ExtraServiceIsPrintingCredit": null,
      "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,
      "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
}

Search CoworkerExtraServices

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

import requests

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

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/coworkerextraservices', 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

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by CreatedOn

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200