Skip to main content
PUT
/
api
/
billing
/
charges
Update Charge
curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/charges \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "CoworkerId": 123,
  "BusinessId": 123,
  "Quantity": 123,
  "DiscountAmount": 123,
  "CreditAmount": 123,
  "TotalAmount": 123
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
Updates an existing Charge 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 Charge-Edit role.

​
Request Body

​
Required Fields

​
Id
integer
required
The Id of the Charge record to update.
​
CoworkerId
integer
required
ID of the coworker linked to this record.
​
BusinessId
integer
required
ID of the business linked to this record.
​
Quantity
integer
required
Number of units.
​
DiscountAmount
number
required
Discount amount.
​
CreditAmount
number
required
Credit amount.
​
TotalAmount
number
required
Total amount.

​
Optional Fields

​
Description
string
Free-text description of this charge.
​
InvoiceLineDisplayAs
string
Display text on invoice line.
​
RegularCharge
boolean
Whether this is a regular charge.
​
DueDate
string
Due date.
​
PurchaseOrder
string
Purchase order.
​
TaxRateId
integer
ID of the tax rate linked to this record.
​
FinancialAccountId
integer
ID of the financial account linked to this record.
​
Invoiced
boolean
Whether the charge has been invoiced.
​
SaleDate
string
Sale date.
​
FromTeamMember
boolean
Whether from team member is enabled.
​
CoworkerExtraServiceName
string
The coworker extra service name value for this charge.
​
CoworkerTimePassName
string
The coworker time pass name value for this charge.
​
CoworkerProductName
string
The coworker product name value for this charge.
​
TariffName
string
The tariff name value for this charge.
​
CoworkerProductUniqueId
string
ID of the coworker product unique associated with this record.
​
BookingUniqueId
string
ID of the booking unique associated with this record.
​
RepeatFrom
string
Repeat from date.
​
RepeatUntil
string
Repeat until date.

​
Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/billing/charges" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerId": 0,
    "BusinessId": 0,
    "Quantity": 0,
    "DiscountAmount": 0,
    "CreditAmount": 0,
    "TotalAmount": 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 charge was updated successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "Charge 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": "DiscountAmount: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "DiscountAmount"
    }
  ],
  "WasSuccessful": false
}