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

# Get one ContractDeposit

> Retrieve a single ContractDeposit record by its Id.

A **ContractDeposit** represents a security deposit or retainer associated with a plan contract (`CoworkerContract`). Each deposit is based on a `Product` and is charged to the member either on the first invoice generated for the contract, or on the next invoice for any contract that has `IncludeSignupFee = true`.

ContractDeposits are created automatically when a contract is signed for a plan (`Tariff`) that includes one or more `TariffSignupProducts`. Each `TariffSignupProduct` on the plan becomes a corresponding `ContractDeposit` on the new contract.

When `Refundable = true`, cancelling the parent contract automatically generates a credit note for the deposit amount. That credit note can then be applied — fully or partially — against any outstanding fees or damage charges raised via a separate invoice.

## 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 **`ContractDeposit-Read`** role.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the ContractDeposit record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractdeposits/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractdeposits/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

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

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

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractdeposits/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

## Response

### 200

<ResponseField name="CoworkerContractId" type="integer">
  Coworker Contract Id.
</ResponseField>

<ResponseField name="CoworkerContractQuantity" type="integer">
  Coworker Contract Quantity.
</ResponseField>

<ResponseField name="CoworkerContractFloorPlanDeskIds" type="string">
  Coworker Contract Floor Plan Desk Ids.
</ResponseField>

<ResponseField name="CoworkerContractFloorPlanDeskNames" type="string">
  Coworker Contract Floor Plan Desk Names.
</ResponseField>

<ResponseField name="CoworkerContractTariffName" type="string">
  Name of the tariff/plan associated with the parent contract.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerId" type="integer">
  Coworker Contract Coworker Id.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerFullName" type="string">
  Full name of the member holding the parent contract.
</ResponseField>

<ResponseField name="CoworkerContractCoworkerBillingName" type="string">
  Billing name of the member holding the parent contract.
</ResponseField>

<ResponseField name="ProductId" type="integer">
  Product Id.
</ResponseField>

<ResponseField name="ProductName" type="string">
  Name of the product this deposit is based on.
</ResponseField>

<ResponseField name="ProductPrice" type="number">
  Default price of the underlying product (used when Price is not overridden).
</ResponseField>

<ResponseField name="ProductCurrencyCode" type="string">
  ISO currency code of the underlying product.
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes or internal comments about this deposit.
</ResponseField>

<ResponseField name="Price" type="number">
  Deposit amount to charge. When set, overrides the default price of the linked product.
</ResponseField>

<ResponseField name="Refundable" type="boolean">
  When true, cancelling the parent contract automatically generates a credit note for the deposit amount, which can be applied against outstanding fees or damages.
</ResponseField>

<ResponseField name="Invoiced" type="boolean">
  True once the deposit has been included in an invoice (either the first contract invoice or the next invoice when IncludeSignupFee = true on the contract).
</ResponseField>

<ResponseField name="Credited" type="boolean">
  True once a credit note has been issued for this refundable deposit following contract cancellation.
</ResponseField>

<ResponseField name="InvoicedOn" type="string">
  Date and time when the deposit was included in an invoice.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerContractId": 0,
  "CoworkerContractQuantity": null,
  "CoworkerContractFloorPlanDeskIds": null,
  "CoworkerContractFloorPlanDeskNames": null,
  "CoworkerContractTariffName": null,
  "CoworkerContractCoworkerId": null,
  "CoworkerContractCoworkerFullName": null,
  "CoworkerContractCoworkerBillingName": null,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": 0,
  "ProductCurrencyCode": null,
  "Notes": null,
  "Price": null,
  "Refundable": false,
  "Invoiced": false,
  "Credited": false,
  "InvoicedOn": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "ContractDeposit Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```