Get one CoworkerExtraService

GET

api

billing

coworkerextraservices

{id}

Get one CoworkerExtraService

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "BusinessId": 123,
  "ExtraServiceId": 123,
  "ExtraServiceName": "<string>",
  "ExtraServiceCurrencyCode": "<string>",
  "ExtraServiceIsPrintingCredit": true,
  "Description": "<string>",
  "Notes": "<string>",
  "RemainingUses": 123,
  "TotalUses": 123,
  "Free": true,
  "Price": 123,
  "LastMinutePriceAdjustment": 123,
  "DynamicPriceAdjustment": 123,
  "PriceFactorLastMinute": 123,
  "PriceFactorDemand": 123,
  "ValidFrom": "<string>",
  "ExpireDate": "<string>",
  "DueDate": "<string>",
  "PurchaseOrder": "<string>",
  "ChargePeriod": 123,
  "Invoiced": true,
  "InvoiceDate": "<string>",
  "IsFromTariff": true,
  "TariffTimePassUniqueId": "<string>",
  "CoworkerProductUniqueId": "<string>",
  "BookingUniqueId": "<string>",
  "AutomaticallyAdded": true,
  "InvoiceThisCoworker": true,
  "DiscountCode": "<string>",
  "CoworkerDiscountUniqueId": "<string>",
  "DiscountAmount": 123,
  "BookingId": 123,
  "BookingFromTime": "<string>",
  "BookingToTime": "<string>",
  "BookingResourceName": "<string>",
  "CoworkerContractUniqueId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

integer

required

The Id of the CoworkerExtraService record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerextraservices/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerextraservices/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/coworkerextraservices/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the customer who owns this time credit or booking charge..

integer

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

integer

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

string

Display value for ExtraService.Name..

string

Display value for ExtraService.Currency.Code..

boolean

Display value for ExtraService.IsPrintingCredit..

string

Read-only description generated for the assigned booking rate or credit..

string

Optional internal notes about this time credit or booking charge..

integer

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

integer

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

boolean

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

number

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

number

Read-only monetary adjustment calculated for a last-minute booking..

number

Read-only monetary adjustment calculated by demand-based pricing..

number

Read-only price multiplier calculated for a last-minute booking..

number

Read-only price multiplier calculated by demand-based pricing..

string

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

string

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

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

string

Optional customer purchase-order reference for invoicing..

integer

Unit used for TotalUses and RemainingUses: Minutes, Days, Weeks, Months, Uses, or FourWeekMonths.. See eChargePeriod enum values: 1 = Minutes, 2 = Days, 3 = Weeks, 4 = Months, 5 = Uses, 6 = FourWeekMonths.

boolean

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

string

Read-only UTC date and time when this charge was invoiced..

boolean

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

string

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

string

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

string

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

boolean

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

boolean

Whether to invoice this customer directly rather than their team or company paying customer..

string

Read-only discount-code text applied to this charge..

string

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

number

Read-only monetary amount discounted from Price in the booking rate’s currency..

integer

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

string

Read-only UTC start time copied from the source booking; update the booking instead..

string

Read-only UTC end time copied from the source booking; update the booking instead..

string

Read-only resource name copied from the source booking; update the booking instead..

string

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

integer

Unique record identifier.

string

UUID of the record.

string

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

string

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

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

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

Get one CoworkerExtraService

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "BusinessId": 123,
  "ExtraServiceId": 123,
  "ExtraServiceName": "<string>",
  "ExtraServiceCurrencyCode": "<string>",
  "ExtraServiceIsPrintingCredit": true,
  "Description": "<string>",
  "Notes": "<string>",
  "RemainingUses": 123,
  "TotalUses": 123,
  "Free": true,
  "Price": 123,
  "LastMinutePriceAdjustment": 123,
  "DynamicPriceAdjustment": 123,
  "PriceFactorLastMinute": 123,
  "PriceFactorDemand": 123,
  "ValidFrom": "<string>",
  "ExpireDate": "<string>",
  "DueDate": "<string>",
  "PurchaseOrder": "<string>",
  "ChargePeriod": 123,
  "Invoiced": true,
  "InvoiceDate": "<string>",
  "IsFromTariff": true,
  "TariffTimePassUniqueId": "<string>",
  "CoworkerProductUniqueId": "<string>",
  "BookingUniqueId": "<string>",
  "AutomaticallyAdded": true,
  "InvoiceThisCoworker": true,
  "DiscountCode": "<string>",
  "CoworkerDiscountUniqueId": "<string>",
  "DiscountAmount": 123,
  "BookingId": 123,
  "BookingFromTime": "<string>",
  "BookingToTime": "<string>",
  "BookingResourceName": "<string>",
  "CoworkerContractUniqueId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200