Update Charge

Update an existing Charge record.

PUT /api/billing/charges

Update Charge

cURL

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
}
'

200

{
  "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

Coworker Id.

BusinessId · integer · required

Business Id.

Quantity · integer · required

Quantity.

DiscountAmount · number · required

Discount amount.

CreditAmount · number · required

Credit amount.

TotalAmount · number · required

Total amount.

Optional Fields

Description · string

Description.

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

Tax Rate Id.

FinancialAccountId · integer

Financial Account Id.

Invoiced · boolean

Whether the charge has been invoiced.

SaleDate · string

Sale date.

FromTeamMember · boolean

From Team Member.

CoworkerExtraServiceName · string

Coworker Extra Service Name.

CoworkerTimePassName · string

Coworker Time Pass Name.

CoworkerProductName · string

Coworker Product Name.

TariffName · string

Tariff Name.

CoworkerProductUniqueId · string

Coworker Product Unique Id.

BookingUniqueId · string

Booking Unique Id.

RepeatFrom · string

Repeat from date.

RepeatUntil · string

Repeat until date.

Code Examples

cURL

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": "[e-mail]",
  "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.

Show child attributes

AttemptedValue · any

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

Message · string

The validation error message.

PropertyName · string

The name of the property that failed validation.

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
}