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

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

A **Proposal** bundles one or more contracts (`ProposalContract` records) that are presented to a customer for review and acceptance. Each `ProposalContract` carries the same properties as a `CoworkerContract` and becomes one when the proposal is accepted.

When a Proposal is created, a `ProposalContract` is automatically created and associated with it. From that point on, the contract-related fields on the Proposal (`TariffId`, `Desks`, `Variants`, `Price`, `StartDate`, `CancellationLimitDays`, `ContractTerm`, `CancellationDate`, `ExpirationDate`, `BillingDay`, `Quantity`) become read-only — they are all `createOnly`. Subsequent edits to those values must be made via the associated `ProposalContract`. Additional `ProposalContract` records can also be added.

Proposals support three optional attachments:

* **DocumentToSendId** — a `DocumentTemplate` entity presented to the customer instead of the standard price-schedule table before the proposal is accepted.
* **DocumentToSignId** — a `DocumentTemplate` entity used to generate a document for e-signature.
* **ProposalFile** — a file shown as a downloadable link before the proposal is accepted.

Set `DoNotIssueInvoice` to control whether the first invoice is issued automatically when the proposal is accepted.

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

## Enums

<Accordion title="eProposalStatus — ProposalStatus values">
  | Value | Name     |
  | ----- | -------- |
  | 1     | Draft    |
  | 2     | Sent     |
  | 3     | Accepted |
  | 4     | Rejected |
</Accordion>

## 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="Proposal_IssuedBy" type="integer">
  Filter by Issued By Id.
</ParamField>

<ParamField query="Proposal_IssuedBy_Name" type="string">
  Filter by issuing business name.
</ParamField>

<ParamField query="Proposal_IssuedBy_Currency_Code" type="string">
  Filter by issuing business currency code.
</ParamField>

<ParamField query="Proposal_Responsible" type="integer">
  Filter by Responsible Id.
</ParamField>

<ParamField query="Proposal_Responsible_FullName" type="string">
  Filter by responsible person full name.
</ParamField>

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

<ParamField query="Proposal_Coworker_CoworkerType" type="string">
  Filter by coworker type.
</ParamField>

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

<ParamField query="Proposal_Coworker_CompanyName" type="string">
  Filter by coworker company name.
</ParamField>

<ParamField query="Proposal_Coworker_BillingName" type="string">
  Filter by coworker billing name.
</ParamField>

<ParamField query="Proposal_Reference" type="string">
  Filter by proposal reference.
</ParamField>

<ParamField query="Proposal_Notes" type="string">
  Filter by notes.
</ParamField>

<ParamField query="Proposal_ProposalStatus" type="integer">
  Filter by proposal status.
</ParamField>

<ParamField query="Proposal_DocumentToSend" type="integer">
  Filter by Document To Send Id.
</ParamField>

<ParamField query="Proposal_DocumentToSign" type="integer">
  Filter by Document To Sign Id.
</ParamField>

<ParamField query="Proposal_DocumentToSignHtml" type="string">
  Filter by Document To Sign Html.
</ParamField>

<ParamField query="Proposal_DocumentToSignBinaryDocumentFileName" type="string">
  Filter by Document To Sign Binary Document File Name.
</ParamField>

<ParamField query="Proposal_NewDocumentToSignBinaryDocumentUrl" type="string">
  Filter by New Document To Sign Binary Document Url.
</ParamField>

<ParamField query="Proposal_ClearDocumentToSignBinaryDocument" type="boolean">
  Filter by Clear Document To Sign Binary Document File.
</ParamField>

<ParamField query="Proposal_DocumentToSendHtml" type="string">
  Filter by Document To Send Html.
</ParamField>

<ParamField query="Proposal_DocumentToSendBinaryDocumentFileName" type="string">
  Filter by Document To Send Binary Document File Name.
</ParamField>

<ParamField query="Proposal_NewDocumentToSendBinaryDocumentUrl" type="string">
  Filter by New Document To Send Binary Document Url.
</ParamField>

<ParamField query="Proposal_ClearDocumentToSendBinaryDocument" type="boolean">
  Filter by Clear Document To Send Binary Document File.
</ParamField>

<ParamField query="Proposal_ProposalFileFileName" type="string">
  Filter by Proposal File File Name.
</ParamField>

<ParamField query="Proposal_NewProposalFileUrl" type="string">
  Filter by New Proposal File Url.
</ParamField>

<ParamField query="Proposal_ClearProposalFile" type="boolean">
  Filter by Clear Proposal File File.
</ParamField>

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

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

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

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

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

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

<ParamField query="Proposal_Price" type="number">
  Filter by price override for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField query="Proposal_StartDate" type="string">
  Filter by start date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField query="Proposal_CancellationLimitDays" type="integer">
  Filter by cancellation limit in days for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField query="Proposal_ContractTerm" type="string">
  Filter by contract term end date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField query="Proposal_CancellationDate" type="string">
  Filter by cancellation date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField query="Proposal_ExpirationDate" type="string">
  Filter by proposal expiration date. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField query="Proposal_BillingDay" type="integer">
  Filter by billing day of month for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

<ParamField query="Proposal_Quantity" type="integer">
  Filter by quantity for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ParamField>

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

<ParamField query="Proposal_StartDateLocal" type="string">
  Filter by Start Date Local.
</ParamField>

<ParamField query="Proposal_SentOn" type="string">
  Filter by date the proposal was sent.
</ParamField>

<ParamField query="Proposal_SentOnLocal" type="string">
  Filter by Sent On Local.
</ParamField>

<ParamField query="Proposal_CustomerLastOpenedDate" type="string">
  Filter by date the customer last opened the proposal.
</ParamField>

<ParamField query="Proposal_DoNotIssueInvoice" type="boolean">
  Filter by if true, the first invoice is not issued automatically when the proposal is accepted.
</ParamField>

### Range Filters

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

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

<ParamField query="from_Proposal_Price" type="number">
  Filter by price override for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value.
</ParamField>

<ParamField query="to_Proposal_Price" type="number">
  Filter by price override for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value.
</ParamField>

<ParamField query="from_Proposal_StartDate" type="string">
  Filter by start date for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Proposal_StartDate" type="string">
  Filter by start date for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Proposal_CancellationLimitDays" type="integer">
  Filter by cancellation limit in days for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value.
</ParamField>

<ParamField query="to_Proposal_CancellationLimitDays" type="integer">
  Filter by cancellation limit in days for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value.
</ParamField>

<ParamField query="from_Proposal_ContractTerm" type="string">
  Filter by contract term end date for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Proposal_ContractTerm" type="string">
  Filter by contract term end date for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Proposal_CancellationDate" type="string">
  Filter by cancellation date for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Proposal_CancellationDate" type="string">
  Filter by cancellation date for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Proposal_ExpirationDate" type="string">
  Filter by proposal expiration date. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Proposal_ExpirationDate" type="string">
  Filter by proposal expiration date. Becomes read-only after creation; edit via ProposalContract less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Proposal_BillingDay" type="integer">
  Filter by billing day of month for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value.
</ParamField>

<ParamField query="to_Proposal_BillingDay" type="integer">
  Filter by billing day of month for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value.
</ParamField>

<ParamField query="from_Proposal_Quantity" type="integer">
  Filter by quantity for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value.
</ParamField>

<ParamField query="to_Proposal_Quantity" type="integer">
  Filter by quantity for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value.
</ParamField>

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

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

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

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

<ParamField query="from_Proposal_SentOnLocal" type="string">
  Filter by sent on local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Proposal_SentOnLocal" type="string">
  Filter by sent on local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Proposal_CustomerLastOpenedDate" type="string">
  Filter by date the customer last opened the proposal greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Proposal_CustomerLastOpenedDate" type="string">
  Filter by date the customer last opened the proposal less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

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

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

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

<ParamField query="to_Proposal_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/proposals?page=1&size=15&orderBy=Reference&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposals?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Reference',
      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/proposals',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Reference',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

### Filtering by Reference

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

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposals?' + new URLSearchParams({
      Proposal_Reference: 'example-value',
      orderBy: 'Reference',
      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/proposals',
      params={
          'Proposal_Reference': 'example-value',
          'orderBy': 'Reference',
          '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/proposals?from_Proposal_UpdatedOn=2025-01-01T00:00&to_Proposal_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/proposals?' + new URLSearchParams({
      from_Proposal_UpdatedOn: '2025-01-01T00:00',
      to_Proposal_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/proposals',
      params={
          'from_Proposal_UpdatedOn': '2025-01-01T00:00',
          'to_Proposal_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="Proposal[]">
  The list of Proposal records matching the query. See the [Get one Proposal](/rest-api/billing/get-proposals-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 Proposal. The following fields are **not populated** in the `Records[]` response: `Notes`, `DocumentToSignHtml`, `DocumentToSendHtml`, `Price`, `StartDate`, `CancellationLimitDays`, `CancellationDate`, `BillingDay`, `Quantity`.

  To get all fields, fetch the full record using the [Get one Proposal](/rest-api/billing/get-proposals-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": [
    {
      "IssuedById": 0,
      "IssuedByName": null,
      "IssuedByCurrencyCode": null,
      "ResponsibleId": 0,
      "ResponsibleFullName": null,
      "CoworkerId": 0,
      "CoworkerCoworkerType": null,
      "CoworkerFullName": null,
      "CoworkerCompanyName": null,
      "CoworkerBillingName": null,
      "Reference": "",
      "ProposalStatus": 0,
      "DocumentToSendId": null,
      "DocumentToSignId": null,
      "DocumentToSignBinaryDocumentFileName": null,
      "NewDocumentToSignBinaryDocumentUrl": null,
      "ClearDocumentToSignBinaryDocumentFile": null,
      "DocumentToSendBinaryDocumentFileName": null,
      "NewDocumentToSendBinaryDocumentUrl": null,
      "ClearDocumentToSendBinaryDocumentFile": null,
      "ProposalFileFileName": null,
      "NewProposalFileUrl": null,
      "ClearProposalFileFile": null,
      "TariffId": 0,
      "TariffName": null,
      "TariffInvoiceEvery": null,
      "TariffInvoiceEveryWeeks": null,
      "TariffPrice": 0,
      "TariffBusinessCurrencyCode": null,
      "Desks": [],
      "Variants": [],
      "ContractTerm": null,
      "ExpirationDate": null,
      "DiscountCodeId": null,
      "StartDateLocal": null,
      "SentOn": null,
      "SentOnLocal": null,
      "CustomerLastOpenedDate": null,
      "DoNotIssueInvoice": false,
      "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": "Proposal Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Reference",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```