> ## 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 CoworkerLedgerEntry

> Update an existing CoworkerLedgerEntry record.

Updates an existing CoworkerLedgerEntry 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 **`CoworkerLedgerEntry-Edit`** role.
</Note>

## Enums

<Accordion title="ePaymentProvider">
  | Value | Name                       |
  | ----- | -------------------------- |
  | 1     | PayPalStandard             |
  | 2     | PaypalStandardSubscription |
  | 3     | GoCardless                 |
  | 4     | Stripe                     |
  | 5     | AuthorizeNetDirect         |
  | 6     | UsaEPay                    |
  | 7     | AuthorizeNetSubscription   |
  | 8     | Adyen                      |
  | 9     | MultiGateway               |
  | 11    | Manual                     |
  | 12    | Forte                      |
  | 13    | PayPalAdaptive             |
  | 14    | GoCardlessPro              |
  | 15    | CreditCard                 |
  | 16    | EPay                       |
  | 17    | Braintree                  |
  | 18    | MidTrans                   |
  | 19    | EziDebit                   |
  | 20    | LiqPay                     |
  | 21    | RazorPay                   |
  | 22    | SquareCash                 |
  | 23    | SquareCreditCard           |
  | 24    | StripeACH                  |
  | 25    | StripeDirectDebit          |
  | 26    | IZettleCreditCard          |
  | 27    | PeachPayments              |
  | 28    | Klarna                     |
  | 29    | StripeTerminal             |
  | 30    | PayPalStandardRest         |
  | 401   | HostedPaymentPage1         |
  | 402   | HostedPaymentPage2         |
  | 403   | HostedPaymentPage3         |
  | 500   | Xero                       |
  | 501   | Quickbooks                 |
  | 989   | ManualDirectDebit          |
  | 990   | BadDebt                    |
  | 991   | CreditCardManual1          |
  | 992   | CreditCardManual2          |
  | 993   | CreditCardManual3          |
  | 994   | Credit                     |
  | 995   | Gift                       |
  | 996   | Bank                       |
  | 997   | Cash                       |
  | 998   | Check                      |
  | 999   | Other                      |
</Accordion>

## Request Body

### Required Fields

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

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

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

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

<ParamField body="Code" type="string" required>
  Ledger entry code.
</ParamField>

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

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

<ParamField body="Balance" type="number" required>
  Balance.
</ParamField>

### Optional Fields

<ParamField body="CoworkerInvoiceId" type="integer">
  Coworker Invoice Id.
</ParamField>

<ParamField body="PaymentGatewayName" type="integer">
  Payment gateway name. See `ePaymentProvider?` enum above.
</ParamField>

<ParamField body="PaymentMethodNumber" type="string">
  Payment method number.
</ParamField>

<ParamField body="TransactionDate" type="string">
  Transaction date.
</ParamField>

<ParamField body="Billed" type="boolean">
  Whether this entry has been billed.
</ParamField>

<ParamField body="TransactionDateLocal" type="string">
  Transaction date in the location's local time.
</ParamField>

<ParamField body="ConnectedTransactionGuid" type="string">
  Connected transaction GUID.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/billing/coworkerledgerentries" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "BusinessId": 0,
      "CoworkerId": 0,
      "Description": "",
      "Code": "",
      "Debit": 0,
      "Credit": 0,
      "Balance": 0,
      "Id": 87654321
  }'
  ```

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

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

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

  response = requests.put(
      'https://spaces.nexudus.com/api/billing/coworkerledgerentries',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'BusinessId': 0,
          'CoworkerId': 0,
          'Description': '',
          'Code': '',
          'Debit': 0,
          'Credit': 0,
          'Balance': 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 coworkerledgerentry was updated successfully.
</ResponseField>

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

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "CoworkerLedgerEntry 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": "Description: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Description"
    }
  ],
  "WasSuccessful": false
}
```