Get one CoworkerProduct

GET

api

billing

coworkerproducts

{id}

Get one CoworkerProduct

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

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerproducts/{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/coworkerproducts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerEmail": "<string>",
  "BusinessId": 123,
  "ProductId": 123,
  "ProductName": "<string>",
  "ProductPrice": 123,
  "ProductApplyProRating": true,
  "ProductCurrencyCode": "<string>",
  "ProductFinancialAccountId": 123,
  "ProductFinancialAccountName": "<string>",
  "ProductFinancialAccountAccountType": "<string>",
  "Notes": "<string>",
  "PurchaseOrder": "<string>",
  "OrderNumber": "<string>",
  "Activated": true,
  "ActivateNow": true,
  "InvoiceThisCoworker": true,
  "Price": 123,
  "Quantity": 123,
  "RegularCharge": true,
  "RepeatCycle": 123,
  "RepeatUnit": 123,
  "InvoiceOn": "<string>",
  "RepeatFrom": "<string>",
  "RepeatUntil": "<string>",
  "SaleDate": "<string>",
  "DueDate": "<string>",
  "Invoiced": true,
  "InvoicedOn": "<string>",
  "FromTariff": true,
  "BookingUniqueId": "<string>",
  "MrmReminded": true,
  "ApplyProRating": true,
  "CoworkerContractUniqueId": "<string>",
  "ContractDepositUniqueId": "<string>",
  "ContractProductUniqueId": "<string>",
  "CoworkerDeliveryUniqueId": "<string>",
  "ProposalUniqueId": "<string>",
  "CoworkerInvoiceId": 123,
  "CoworkerInvoiceNumber": "<string>",
  "CoworkerInvoicePaid": true,
  "TeamsAtTheTimeOfPurchase": "<string>",
  "CreditAmount": 123,
  "DiscountAmount": 123,
  "Refundable": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A product sale (CoworkerProduct) records a product sold to a customer, either as a one-off purchase or a recurring charge, and can grant the product’s included passes, time credit, and booking credit.

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

Path Parameters

integer

required

The Id of the CoworkerProduct record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the customer purchasing this product; the customer must be accessible at the selected location..

string

Display value for Coworker.CoworkerType..

string

Display value for Coworker.FullName..

string

Display value for Coworker.CompanyName..

string

Display value for Coworker.BillingName..

string

Display value for Coworker.Email..

integer

ID of the location that owns and issues this product sale; set automatically from the tool’s location context..

integer

ID of the product being sold; the product must be available to the selected customer at this location..

string

Display value for Product.Name..

number

Display value for Product.Price..

boolean

Display value for Product.ApplyProRating..

string

Display value for Product.Currency.Code..

integer

Display value for Product.FinancialAccount.Id..

string

Display value for Product.FinancialAccount.Name..

string

Display value for Product.FinancialAccount.AccountType..

string

Optional internal notes about this product sale..

string

Optional customer purchase-order reference for this sale..

string

Read-only order reference assigned by the purchasing workflow..

boolean

Whether included benefits have been activated and granted to the customer; controlled by activation processing..

boolean

Whether to activate included passes, time credit, and booking credit immediately, before the sale is invoiced or paid..

boolean

Whether to invoice this customer directly instead of the paying customer in their team..

number

Optional unit-price override in the product currency; when omitted, the product’s current price is used, then multiplied by Quantity..

integer

Number of product units to sell; must be at least 1 and multiplies price and included benefits..

boolean

Whether this is a recurring product sale rather than a one-off sale; requires scheduling values for non-PricePlan repeat cycles..

integer

Recurring schedule pattern: PricePlan, Day, Week, Month, Year, or LastDayOfMonth. PricePlan follows the customer’s main contract; prefer ContractProduct for plan-linked recurring products.. See eRecurrentChargePattern enum values: 1 = PricePlan, 2 = Day, 3 = Week, 4 = Month, 5 = Year, 6 = LastDayOfMonth.

integer

Positive number of RepeatCycle units between recurring charges; required when RegularCharge is true and RepeatCycle is not PricePlan..

string

Date and time when this sale is next due for invoicing; required for recurring sales whose RepeatCycle is not PricePlan..

string

Optional date and time from which recurring invoicing begins; a future value delays activation until that date..

string

Optional exclusive end date for recurring invoicing; no later charge is created when the next invoicing date reaches this value..

string

Optional sale date for this product sale; when omitted, reports use the record creation date..

string

Optional date and time by which payment is due; benefits can auto-activate when it has passed and the discounted price is zero..

boolean

Whether this sale has been included on an invoice; set by the invoicing process..

string

Read-only date and time when the invoicing process invoiced this sale..

boolean

Internal flag showing the sale was created from a plan; manage the originating contract or ContractProduct instead..

string

Internal GUID link to the booking that generated this sale; manage the booking rather than setting this field..

boolean

Internal reminder-processing flag set after product reminders are handled..

boolean

Whether the sale price is prorated against the customer’s main contract billing period; the product’s prorating setting can also apply..

string

Internal GUID link to the contract that generated this sale; manage the originating contract instead..

string

Internal GUID link to the contract deposit that generated this sale; manage the originating deposit instead..

string

Internal GUID link to the ContractProduct that generated this sale; manage the originating ContractProduct instead..

string

Internal GUID link to the delivery record that generated this sale; managed by the delivery workflow..

string

Internal GUID link to the proposal that created this sale; manage the proposal instead..

integer

Read-only internal ID of the invoice containing this sale, populated by the invoicing process..

string

Read-only invoice number containing this sale, populated by the invoicing process..

boolean

Read-only payment status of the invoice containing this sale, populated from the invoice..

string

Internal snapshot of the customer’s teams when the sale was created, populated by the create handler..

number

Read-only monetary amount from the customer’s available booking credit applied to this sale by the BookingProduct workflow..

number

Monetary discount amount applied to this sale in the invoice currency..

boolean

Whether the deposit represented by this sale is refunded when its connected contract is cancelled; applies only to deposit products..

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,
  "CoworkerCoworkerType": null,
  "CoworkerFullName": null,
  "CoworkerCompanyName": null,
  "CoworkerBillingName": null,
  "CoworkerEmail": null,
  "BusinessId": 0,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": null,
  "ProductApplyProRating": null,
  "ProductCurrencyCode": null,
  "ProductFinancialAccountId": null,
  "ProductFinancialAccountName": null,
  "ProductFinancialAccountAccountType": null,
  "Notes": null,
  "PurchaseOrder": null,
  "OrderNumber": null,
  "Activated": false,
  "ActivateNow": false,
  "InvoiceThisCoworker": false,
  "Price": null,
  "Quantity": 0,
  "RegularCharge": false,
  "RepeatCycle": 0,
  "RepeatUnit": null,
  "InvoiceOn": null,
  "RepeatFrom": null,
  "RepeatUntil": null,
  "SaleDate": null,
  "DueDate": null,
  "Invoiced": false,
  "InvoicedOn": null,
  "FromTariff": false,
  "BookingUniqueId": null,
  "MrmReminded": false,
  "ApplyProRating": false,
  "CoworkerContractUniqueId": null,
  "ContractDepositUniqueId": null,
  "ContractProductUniqueId": null,
  "CoworkerDeliveryUniqueId": null,
  "ProposalUniqueId": null,
  "CoworkerInvoiceId": null,
  "CoworkerInvoiceNumber": null,
  "CoworkerInvoicePaid": false,
  "TeamsAtTheTimeOfPurchase": null,
  "CreditAmount": 0,
  "DiscountAmount": 0,
  "Refundable": false,
  "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": "CoworkerProduct Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one CoworkerProduct

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

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerproducts/{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/coworkerproducts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerEmail": "<string>",
  "BusinessId": 123,
  "ProductId": 123,
  "ProductName": "<string>",
  "ProductPrice": 123,
  "ProductApplyProRating": true,
  "ProductCurrencyCode": "<string>",
  "ProductFinancialAccountId": 123,
  "ProductFinancialAccountName": "<string>",
  "ProductFinancialAccountAccountType": "<string>",
  "Notes": "<string>",
  "PurchaseOrder": "<string>",
  "OrderNumber": "<string>",
  "Activated": true,
  "ActivateNow": true,
  "InvoiceThisCoworker": true,
  "Price": 123,
  "Quantity": 123,
  "RegularCharge": true,
  "RepeatCycle": 123,
  "RepeatUnit": 123,
  "InvoiceOn": "<string>",
  "RepeatFrom": "<string>",
  "RepeatUntil": "<string>",
  "SaleDate": "<string>",
  "DueDate": "<string>",
  "Invoiced": true,
  "InvoicedOn": "<string>",
  "FromTariff": true,
  "BookingUniqueId": "<string>",
  "MrmReminded": true,
  "ApplyProRating": true,
  "CoworkerContractUniqueId": "<string>",
  "ContractDepositUniqueId": "<string>",
  "ContractProductUniqueId": "<string>",
  "CoworkerDeliveryUniqueId": "<string>",
  "ProposalUniqueId": "<string>",
  "CoworkerInvoiceId": 123,
  "CoworkerInvoiceNumber": "<string>",
  "CoworkerInvoicePaid": true,
  "TeamsAtTheTimeOfPurchase": "<string>",
  "CreditAmount": 123,
  "DiscountAmount": 123,
  "Refundable": true,
  "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