Create CoworkerProduct

POST

api

billing

coworkerproducts

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/coworkerproducts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerId": 123,
  "BusinessId": 123,
  "ProductId": 123,
  "Quantity": 123,
  "RepeatCycle": 123,
  "DiscountAmount": 123
}
'

import requests

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

payload = {
    "CoworkerId": 123,
    "BusinessId": 123,
    "ProductId": 123,
    "Quantity": 123,
    "RepeatCycle": 123,
    "DiscountAmount": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    CoworkerId: 123,
    BusinessId: 123,
    ProductId: 123,
    Quantity: 123,
    RepeatCycle: 123,
    DiscountAmount: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/coworkerproducts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create role.

Enums

eRecurrentChargePattern — RepeatCycle values

Value	Name
1	PricePlan
2	Day
3	Week
4	Month
5	Year
6	LastDayOfMonth

Request Body

Required Fields

integer

required

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

integer

required

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

integer

required

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

integer

required

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

integer

required

Recurring schedule pattern: PricePlan, Day, Week, Month, Year, or LastDayOfMonth. PricePlan follows the customer’s main contract; prefer ContractProduct for plan-linked recurring products.. Defaults to eRecurrentChargePattern.PricePlan.

number

required

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

Optional Fields

string

Optional internal notes about this product sale..

string

Optional customer purchase-order reference for this sale..

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

boolean

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

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

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 proposal that created this sale; manage the proposal instead..

boolean

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

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/coworkerproducts" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerId": 0,
    "BusinessId": 0,
    "ProductId": 0,
    "Quantity": 0,
    "RepeatCycle": 0,
    "DiscountAmount": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerproducts',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CoworkerId: 0,
      BusinessId: 0,
      ProductId: 0,
      Quantity: 0,
      RepeatCycle: 0,
      DiscountAmount: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/coworkerproducts',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerId': 0,
        'BusinessId': 0,
        'ProductId': 0,
        'Quantity': 0,
        'RepeatCycle': 0,
        'DiscountAmount': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the coworkerproduct was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerProduct was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "RepeatCycle: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "RepeatCycle"
    }
  ],
  "WasSuccessful": false
}

Create CoworkerProduct

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/coworkerproducts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerId": 123,
  "BusinessId": 123,
  "ProductId": 123,
  "Quantity": 123,
  "RepeatCycle": 123,
  "DiscountAmount": 123
}
'

import requests

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

payload = {
    "CoworkerId": 123,
    "BusinessId": 123,
    "ProductId": 123,
    "Quantity": 123,
    "RepeatCycle": 123,
    "DiscountAmount": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    CoworkerId: 123,
    BusinessId: 123,
    ProductId: 123,
    Quantity: 123,
    RepeatCycle: 123,
    DiscountAmount: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/coworkerproducts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400