> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Charge

> Update an existing Charge record.

Updates an existing Charge record. You must include the `Id` of the record to update along with all required fields.

## Authentication

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

## Request Body

### Required Fields

<ParamField body="Id" type="integer" required>
  The Id of the Charge record to update.
</ParamField>

<ParamField body="CoworkerId" type="integer" required>
  Coworker Id.
</ParamField>

<ParamField body="BusinessId" type="integer" required>
  Business Id.
</ParamField>

<ParamField body="Quantity" type="integer" required>
  Quantity.
</ParamField>

<ParamField body="DiscountAmount" type="number" required>
  Discount amount.
</ParamField>

<ParamField body="CreditAmount" type="number" required>
  Credit amount.
</ParamField>

<ParamField body="TotalAmount" type="number" required>
  Total amount.
</ParamField>

### Optional Fields

<ParamField body="Description" type="string">
  Description.
</ParamField>

<ParamField body="InvoiceLineDisplayAs" type="string">
  Display text on invoice line.
</ParamField>

<ParamField body="RegularCharge" type="boolean">
  Whether this is a regular charge.
</ParamField>

<ParamField body="DueDate" type="string">
  Due date.
</ParamField>

<ParamField body="PurchaseOrder" type="string">
  Purchase order.
</ParamField>

<ParamField body="TaxRateId" type="integer">
  Tax Rate Id.
</ParamField>

<ParamField body="FinancialAccountId" type="integer">
  Financial Account Id.
</ParamField>

<ParamField body="Invoiced" type="boolean">
  Whether the charge has been invoiced.
</ParamField>

<ParamField body="SaleDate" type="string">
  Sale date.
</ParamField>

<ParamField body="FromTeamMember" type="boolean">
  From Team Member.
</ParamField>

<ParamField body="CoworkerExtraServiceName" type="string">
  Coworker Extra Service Name.
</ParamField>

<ParamField body="CoworkerTimePassName" type="string">
  Coworker Time Pass Name.
</ParamField>

<ParamField body="CoworkerProductName" type="string">
  Coworker Product Name.
</ParamField>

<ParamField body="TariffName" type="string">
  Tariff Name.
</ParamField>

<ParamField body="CoworkerProductUniqueId" type="string">
  Coworker Product Unique Id.
</ParamField>

<ParamField body="BookingUniqueId" type="string">
  Booking Unique Id.
</ParamField>

<ParamField body="RepeatFrom" type="string">
  Repeat from date.
</ParamField>

<ParamField body="RepeatUntil" type="string">
  Repeat until date.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  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
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/charges',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        CoworkerId: 0,
        BusinessId: 0,
        Quantity: 0,
        DiscountAmount: 0,
        CreditAmount: 0,
        TotalAmount: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/charges',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'CoworkerId': 0,
          'BusinessId': 0,
          'Quantity': 0,
          'DiscountAmount': 0,
          'CreditAmount': 0,
          'TotalAmount': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the charge was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "DiscountAmount: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "DiscountAmount"
    }
  ],
  "WasSuccessful": false
}
```