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

# Search ContractDeposits

> Search and list ContractDeposit records with filtering, sorting, and pagination.

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-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="ContractDeposit_CoworkerContract" type="integer">
  Filter by Coworker Contract Id.
</ParamField>

<ParamField query="ContractDeposit_CoworkerContract_Quantity" type="integer">
  Filter by Coworker Contract Quantity.
</ParamField>

<ParamField query="ContractDeposit_CoworkerContract_FloorPlanDeskIds" type="string">
  Filter by Coworker Contract Floor Plan Desk Ids.
</ParamField>

<ParamField query="ContractDeposit_CoworkerContract_FloorPlanDeskNames" type="string">
  Filter by Coworker Contract Floor Plan Desk Names.
</ParamField>

<ParamField query="ContractDeposit_CoworkerContract_Tariff_Name" type="string">
  Filter by name of the tariff/plan associated with the parent contract.
</ParamField>

<ParamField query="ContractDeposit_CoworkerContract_Coworker_Id" type="integer">
  Filter by Coworker Contract Coworker Id.
</ParamField>

<ParamField query="ContractDeposit_CoworkerContract_Coworker_FullName" type="string">
  Filter by full name of the member holding the parent contract.
</ParamField>

<ParamField query="ContractDeposit_CoworkerContract_Coworker_BillingName" type="string">
  Filter by billing name of the member holding the parent contract.
</ParamField>

<ParamField query="ContractDeposit_Product" type="integer">
  Filter by Product Id.
</ParamField>

<ParamField query="ContractDeposit_Product_Name" type="string">
  Filter by name of the product this deposit is based on.
</ParamField>

<ParamField query="ContractDeposit_Product_Price" type="number">
  Filter by default price of the underlying product (used when Price is not overridden).
</ParamField>

<ParamField query="ContractDeposit_Product_Currency_Code" type="string">
  Filter by iSO currency code of the underlying product.
</ParamField>

<ParamField query="ContractDeposit_Notes" type="string">
  Filter by optional notes or internal comments about this deposit.
</ParamField>

<ParamField query="ContractDeposit_Price" type="number">
  Filter by deposit amount to charge. When set, overrides the default price of the linked product.
</ParamField>

<ParamField query="ContractDeposit_Refundable" type="boolean">
  Filter by when true, cancelling the parent contract automatically generates a credit note for the deposit amount, which can be applied against outstanding fees or damages.
</ParamField>

<ParamField query="ContractDeposit_Invoiced" type="boolean">
  Filter by 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).
</ParamField>

<ParamField query="ContractDeposit_Credited" type="boolean">
  Filter by true once a credit note has been issued for this refundable deposit following contract cancellation.
</ParamField>

<ParamField query="ContractDeposit_InvoicedOn" type="string">
  Filter by date and time when the deposit was included in an invoice.
</ParamField>

### Range Filters

<ParamField query="from_ContractDeposit_CoworkerContractQuantity" type="integer">
  Filter by coworker contract quantity greater than or equal to this value.
</ParamField>

<ParamField query="to_ContractDeposit_CoworkerContractQuantity" type="integer">
  Filter by coworker contract quantity less than or equal to this value.
</ParamField>

<ParamField query="from_ContractDeposit_CoworkerContractCoworkerId" type="integer">
  Filter by coworker contract coworker id greater than or equal to this value.
</ParamField>

<ParamField query="to_ContractDeposit_CoworkerContractCoworkerId" type="integer">
  Filter by coworker contract coworker id less than or equal to this value.
</ParamField>

<ParamField query="from_ContractDeposit_ProductPrice" type="number">
  Filter by default price of the underlying product (used when Price is not overridden) greater than or equal to this value.
</ParamField>

<ParamField query="to_ContractDeposit_ProductPrice" type="number">
  Filter by default price of the underlying product (used when Price is not overridden) less than or equal to this value.
</ParamField>

<ParamField query="from_ContractDeposit_Price" type="number">
  Filter by deposit amount to charge. When set, overrides the default price of the linked product greater than or equal to this value.
</ParamField>

<ParamField query="to_ContractDeposit_Price" type="number">
  Filter by deposit amount to charge. When set, overrides the default price of the linked product less than or equal to this value.
</ParamField>

<ParamField query="from_ContractDeposit_InvoicedOn" type="string">
  Filter by date and time when the deposit was included in an invoice greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ContractDeposit_InvoicedOn" type="string">
  Filter by date and time when the deposit was included in an invoice less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_ContractDeposit_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ContractDeposit_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_ContractDeposit_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ContractDeposit_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractdeposits?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractdeposits?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

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

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

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractdeposits',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractdeposits?ContractDeposit_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractdeposits?' + new URLSearchParams({
      ContractDeposit_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

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

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

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractdeposits',
      params={
          'ContractDeposit_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/contractdeposits?from_ContractDeposit_UpdatedOn=2025-01-01T00:00&to_ContractDeposit_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/contractdeposits?' + new URLSearchParams({
      from_ContractDeposit_UpdatedOn: '2025-01-01T00:00',
      to_ContractDeposit_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

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

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

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/contractdeposits',
      params={
          'from_ContractDeposit_UpdatedOn': '2025-01-01T00:00',
          'to_ContractDeposit_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

## Response

### 200

<ResponseField name="Records" type="ContractDeposit[]">
  The list of ContractDeposit records matching the query. See the [Get one ContractDeposit](/rest-api/billing/get-contractdeposits-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each ContractDeposit. The following fields are **not populated** in the `Records[]` response: `Notes`.

  To get all fields, fetch the full record using the [Get one ContractDeposit](/rest-api/billing/get-contractdeposits-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CoworkerContractId": 0,
      "CoworkerContractQuantity": null,
      "CoworkerContractFloorPlanDeskIds": null,
      "CoworkerContractFloorPlanDeskNames": null,
      "CoworkerContractTariffName": null,
      "CoworkerContractCoworkerId": null,
      "CoworkerContractCoworkerFullName": null,
      "CoworkerContractCoworkerBillingName": null,
      "ProductId": 0,
      "ProductName": null,
      "ProductPrice": 0,
      "ProductCurrencyCode": 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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```