Skip to main content
POST
/
api
/
billing
/
coworkerproducts
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,
  "CreditAmount": 123,
  "DiscountAmount": 123
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
A CoworkerProduct is a record of a product sold to a customer as a one-off or on a recurrent basis. RepeatCycle can only be set to PricePlan if the customer has a contract set as their main contract. In general, it is best to use ContractProduct instead of adding CoworkerProducts repeating based on PricePlan. InvoiceThisCoworker indicates this customer should be invoiced for this product instead of the paying member of their team. ActivateNow releases any benefits (credits or passes) even before the product is invoiced and paid. ProductApplyProRating indicates the sold product is configured to prorate the price of this sale based on the prorating rules of the main contract of the customer: it adjusts the price based on the number of days left between the current date and the next invoice date (RenewalDate) of the customer’s main contract. Properties ending in UniqueId link the sale to the originating record using its GUID UniqueId property (not the integer ID). Only one of these will be populated per record:
UniqueId propertySource entity
CoworkerContractUniqueIdCoworkerContract
ContractDepositUniqueIdContractDeposit
ContractProductUniqueIdContractProduct
BookingUniqueIdBooking
CoworkerDeliveryUniqueIdCoworkerDelivery

​
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

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

​
Request Body

​
Required Fields

​
CoworkerId
integer
required
Coworker Id.
​
BusinessId
integer
required
Business Id.
​
ProductId
integer
required
Product Id.
​
Quantity
integer
required
Quantity.
​
RepeatCycle
integer
required
Repeat cycle pattern. PricePlan can only be used if the customer has a main contract; prefer ContractProduct instead of CoworkerProducts repeating on PricePlan. Defaults to eRecurrentChargePattern.PricePlan.
​
CreditAmount
number
required
Credit amount.
​
DiscountAmount
number
required
Discount amount.

​
Optional Fields

​
Notes
string
Notes.
​
PurchaseOrder
string
Purchase order.
​
ActivateNow
boolean
Activate immediately, releasing any benefits (credits or passes) even before the product is invoiced and paid.
​
InvoiceThisCoworker
boolean
Invoice this customer for this product instead of the paying member of their team.
​
Price
number
Price override.
​
RegularCharge
boolean
Whether this is a regular charge.
​
RepeatUnit
integer
Number of repeat units.
​
InvoiceOn
string
Invoice on date.
​
RepeatFrom
string
Repeat from date.
​
RepeatUntil
string
Repeat until date.
​
SaleDate
string
Sale date.
​
DueDate
string
Due date.
​
Invoiced
boolean
Whether it has been invoiced.
​
MrmReminded
boolean
Mrm Reminded.
​
ApplyProRating
boolean
Apply pro-rating.
​
ProposalUniqueId
string
Proposal Unique Id.
​
CoworkerInvoiceId
integer
Coworker invoice ID.
​
CoworkerInvoiceNumber
string
Coworker invoice number.
​
CoworkerInvoicePaid
boolean
Whether coworker invoice is paid.

​
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,
    "CreditAmount": 0,
    "DiscountAmount": 0
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the creation.
​
Value
object
Contains the Id of the newly created record.
​
WasSuccessful
boolean
true if the coworkerproduct was created successfully.
​
Errors
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

​
Message
string
A summary of the validation error(s), in the format PropertyName: error message.
​
Value
any
null on validation failure.
​
Errors
object[]
Array of validation errors.
​
WasSuccessful
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
}