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

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

## 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 **`ProposalContract-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="ProposalContract_Proposal" type="integer">
  Filter by Proposal Id.
</ParamField>

<ParamField query="ProposalContract_Proposal_Coworker_Id" type="string">
  Filter by proposal coworker ID.
</ParamField>

<ParamField query="ProposalContract_Proposal_Coworker_Email" type="string">
  Filter by proposal coworker email.
</ParamField>

<ParamField query="ProposalContract_Proposal_Coworker_FullName" type="string">
  Filter by proposal coworker full name.
</ParamField>

<ParamField query="ProposalContract_Tariff" type="integer">
  Filter by Tariff Id.
</ParamField>

<ParamField query="ProposalContract_Tariff_Name" type="string">
  Filter by tariff name.
</ParamField>

<ParamField query="ProposalContract_Tariff_InvoiceEvery" type="string">
  Filter by tariff invoice frequency.
</ParamField>

<ParamField query="ProposalContract_Tariff_InvoiceEveryWeeks" type="string">
  Filter by tariff invoice frequency in weeks.
</ParamField>

<ParamField query="ProposalContract_Tariff_Price" type="number">
  Filter by tariff price.
</ParamField>

<ParamField query="ProposalContract_Tariff_Business_Currency_Code" type="string">
  Filter by tariff business currency code.
</ParamField>

<ParamField query="ProposalContract_Price" type="number">
  Filter by price override.
</ParamField>

<ParamField query="ProposalContract_StartDate" type="string">
  Filter by contract start date.
</ParamField>

<ParamField query="ProposalContract_CancellationLimitDays" type="integer">
  Filter by cancellation limit in days.
</ParamField>

<ParamField query="ProposalContract_ContractTerm" type="string">
  Filter by contract term end date.
</ParamField>

<ParamField query="ProposalContract_CancellationDate" type="string">
  Filter by cancellation date.
</ParamField>

<ParamField query="ProposalContract_BillingDay" type="integer">
  Filter by billing day of month.
</ParamField>

<ParamField query="ProposalContract_Quantity" type="integer">
  Filter by quantity.
</ParamField>

<ParamField query="ProposalContract_DiscountCode" type="integer">
  Filter by Discount Code Id.
</ParamField>

<ParamField query="ProposalContract_FloorPlanDeskIds" type="string">
  Filter by floor plan desk IDs.
</ParamField>

<ParamField query="ProposalContract_FloorPlanDeskNames" type="string">
  Filter by floor plan desk names.
</ParamField>

<ParamField query="ProposalContract_FloorPlanDeskVariantIds" type="string">
  Filter by floor plan desk variant IDs.
</ParamField>

<ParamField query="ProposalContract_FloorPlanDeskVariantNames" type="string">
  Filter by floor plan desk variant names.
</ParamField>

### Range Filters

<ParamField query="from_ProposalContract_TariffPrice" type="number">
  Filter by tariff price greater than or equal to this value.
</ParamField>

<ParamField query="to_ProposalContract_TariffPrice" type="number">
  Filter by tariff price less than or equal to this value.
</ParamField>

<ParamField query="from_ProposalContract_Price" type="number">
  Filter by price override greater than or equal to this value.
</ParamField>

<ParamField query="to_ProposalContract_Price" type="number">
  Filter by price override less than or equal to this value.
</ParamField>

<ParamField query="from_ProposalContract_StartDate" type="string">
  Filter by contract start date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ProposalContract_StartDate" type="string">
  Filter by contract start date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_ProposalContract_CancellationLimitDays" type="integer">
  Filter by cancellation limit in days greater than or equal to this value.
</ParamField>

<ParamField query="to_ProposalContract_CancellationLimitDays" type="integer">
  Filter by cancellation limit in days less than or equal to this value.
</ParamField>

<ParamField query="from_ProposalContract_ContractTerm" type="string">
  Filter by contract term end date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ProposalContract_ContractTerm" type="string">
  Filter by contract term end date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_ProposalContract_CancellationDate" type="string">
  Filter by cancellation date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ProposalContract_CancellationDate" type="string">
  Filter by cancellation date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_ProposalContract_BillingDay" type="integer">
  Filter by billing day of month greater than or equal to this value.
</ParamField>

<ParamField query="to_ProposalContract_BillingDay" type="integer">
  Filter by billing day of month less than or equal to this value.
</ParamField>

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

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

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

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

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

<ParamField query="to_ProposalContract_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/proposalcontracts?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/proposalcontracts?' + 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/proposalcontracts',
      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/proposalcontracts?ProposalContract_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/proposalcontracts?' + new URLSearchParams({
      ProposalContract_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/proposalcontracts',
      params={
          'ProposalContract_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/proposalcontracts?from_ProposalContract_UpdatedOn=2025-01-01T00:00&to_ProposalContract_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/proposalcontracts?' + new URLSearchParams({
      from_ProposalContract_UpdatedOn: '2025-01-01T00:00',
      to_ProposalContract_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/proposalcontracts',
      params={
          'from_ProposalContract_UpdatedOn': '2025-01-01T00:00',
          'to_ProposalContract_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="ProposalContract[]">
  The list of ProposalContract records matching the query. See the [Get one ProposalContract](/rest-api/billing/get-proposalcontracts-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 ProposalContract. The following fields are **not populated** in the `Records[]` response: `CancellationLimitDays`, `BillingDay`, `Quantity`.

  To get all fields, fetch the full record using the [Get one ProposalContract](/rest-api/billing/get-proposalcontracts-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": [
    {
      "ProposalId": 0,
      "ProposalCoworkerId": null,
      "ProposalCoworkerEmail": null,
      "ProposalCoworkerFullName": null,
      "TariffId": 0,
      "TariffName": null,
      "TariffInvoiceEvery": null,
      "TariffInvoiceEveryWeeks": null,
      "TariffPrice": 0,
      "TariffBusinessCurrencyCode": null,
      "Desks": [],
      "Variants": [],
      "Price": null,
      "StartDate": null,
      "ContractTerm": null,
      "CancellationDate": null,
      "DiscountCodeId": null,
      "FloorPlanDeskIds": null,
      "FloorPlanDeskNames": null,
      "FloorPlanDeskVariantIds": null,
      "FloorPlanDeskVariantNames": 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": "ProposalContract 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
}
```