Skip to main content
PUT
/
api
/
billing
/
coworkerproducts
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
Updates an existing CoworkerProduct record. You must include the Id of the record to update along with all required fields.

​
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-Edit role.

​
Enums

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

​
Request Body

​
Required Fields

​
Id
integer
required
The Id of the CoworkerProduct record to update.
​
CoworkerId
integer
required
Coworker Id.
​
BusinessId
integer
required
Business Id.
​
ProductId
integer
required
Product Id.
​
Quantity
integer
required
Quantity.
​
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.
​
RepeatCycle
integer
Repeat cycle pattern. PricePlan can only be used if the customer has a main contract; prefer ContractProduct instead of CoworkerProducts repeating on PricePlan. See eRecurrentChargePattern enum above.
​
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 PUT \
  "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,
    "CreditAmount": 0,
    "DiscountAmount": 0,
    "Id": 87654321
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the update.
​
Value
object
Contains the Id of the updated record.
​
WasSuccessful
boolean
true if the coworkerproduct was updated successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "CoworkerProduct was successfully updated.",
  "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": "CreditAmount: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "CreditAmount"
    }
  ],
  "WasSuccessful": false
}