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

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

A ProposalProduct is one extra item quoted alongside the plan in a proposal: an add-on product, a plan component, or a refundable deposit. IsDeposit and IsContractProduct decide what happens on acceptance - a deposit attaches to the first contract and switches on its sign-up fee, a contract product attaches to every contract in the proposal, and anything else becomes a standalone product on the customer's account.

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

## Enums

<Accordion title="eRecurrentChargePattern — RepeatCycle values">
  | Value | Name |
  | - | - |
  | 1 | PricePlan |
  | 2 | Day |
  | 3 | Week |
  | 4 | Month |
  | 5 | Year |
  | 6 | LastDayOfMonth |
</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="ProposalProduct_Proposal" type="integer">
  Filter by iD of the proposal this line belongs to; required, and the proposal's issuing location owns this record..
</ParamField>

<ParamField query="ProposalProduct_Proposal_Coworker_Id" type="integer">
  Filter by display value for Proposal.Coworker.Id..
</ParamField>

<ParamField query="ProposalProduct_Proposal_Coworker_Email" type="string">
  Filter by display value for Proposal.Coworker.Email..
</ParamField>

<ParamField query="ProposalProduct_Proposal_Coworker_FullName" type="string">
  Filter by display value for Proposal.Coworker.FullName..
</ParamField>

<ParamField query="ProposalProduct_Product" type="integer">
  Filter by iD of the product quoted on this line; required, and it must belong to a location the user can access..
</ParamField>

<ParamField query="ProposalProduct_Product_Name" type="string">
  Filter by display value for Product.Name..
</ParamField>

<ParamField query="ProposalProduct_Product_Price" type="number">
  Filter by display value for Product.Price..
</ParamField>

<ParamField query="ProposalProduct_Product_ApplyProRating" type="boolean">
  Filter by display value for Product.ApplyProRating..
</ParamField>

<ParamField query="ProposalProduct_Product_Business_Currency_Code" type="string">
  Filter by display value for Product.Business.Currency.Code..
</ParamField>

<ParamField query="ProposalProduct_Quantity" type="integer">
  Filter by number of units of the product quoted, at least 1; it multiplies the unit price in every proposal total..
</ParamField>

<ParamField query="ProposalProduct_Price" type="number">
  Filter by optional per-unit price override in the location's currency; when empty the product's own price is used..
</ParamField>

<ParamField query="ProposalProduct_IsDeposit" type="boolean">
  Filter by whether this line is a refundable deposit. On acceptance a deposit is attached to the first contract only and switches on that contract's sign-up fee, and it counts towards the one-off sign-up total rather than the recurring total..
</ParamField>

<ParamField query="ProposalProduct_IsContractProduct" type="boolean">
  Filter by whether this line is attached to the contracts rather than sold on its own. On acceptance a contract product is added to every contract in the proposal; when this and IsDeposit are both false, the line becomes a standalone product on the customer's account..
</ParamField>

<ParamField query="ProposalProduct_RegularCharge" type="boolean">
  Filter by whether the product recurs with the customer's billing instead of being charged once; it also decides whether the line counts towards the proposal's recurring total or its one-off sign-up total..
</ParamField>

<ParamField query="ProposalProduct_RepeatCycle" type="integer">
  Filter by recurrence interval used when RegularCharge is true: PricePlan follows the contract's own billing cycle, Day, Week, Month and Year repeat every RepeatUnit of that period, and LastDayOfMonth charges on the final day of each month..
</ParamField>

<ParamField query="ProposalProduct_InvoiceOn" type="string">
  Filter by optional UTC date from which this product starts being invoiced; a recurring line whose invoice date falls after a contract's start date is left out of that contract's totals..
</ParamField>

<ParamField query="ProposalProduct_RepeatFrom" type="string">
  Filter by optional UTC date on which the recurrence begins; it is carried onto the customer product or contract product created on acceptance..
</ParamField>

<ParamField query="ProposalProduct_RepeatUntil" type="string">
  Filter by optional UTC date after which the product stops recurring; a recurring line that has already ended is left out of the proposal totals..
</ParamField>

<ParamField query="ProposalProduct_RepeatUnit" type="integer">
  Filter by number of RepeatCycle periods between charges; 3 with a Month cycle bills quarterly. Acceptance falls back to 1 when it is empty..
</ParamField>

<ParamField query="ProposalProduct_ApplyProRating" type="boolean">
  Filter by whether the product's first charge is prorated for a partial billing period..
</ParamField>

<ParamField query="ProposalProduct_Notes" type="string">
  Filter by free-text note carried onto the product created for the customer when the proposal is accepted..
</ParamField>

### Range Filters

<ParamField query="from_ProposalProduct_ProposalCoworkerId" type="integer">
  Filter by display value for Proposal.Coworker.Id. greater than or equal to this value.
</ParamField>

<ParamField query="to_ProposalProduct_ProposalCoworkerId" type="integer">
  Filter by display value for Proposal.Coworker.Id. less than or equal to this value.
</ParamField>

<ParamField query="from_ProposalProduct_ProductPrice" type="number">
  Filter by display value for Product.Price. greater than or equal to this value.
</ParamField>

<ParamField query="to_ProposalProduct_ProductPrice" type="number">
  Filter by display value for Product.Price. less than or equal to this value.
</ParamField>

<ParamField query="from_ProposalProduct_Quantity" type="integer">
  Filter by number of units of the product quoted, at least 1; it multiplies the unit price in every proposal total. greater than or equal to this value.
</ParamField>

<ParamField query="to_ProposalProduct_Quantity" type="integer">
  Filter by number of units of the product quoted, at least 1; it multiplies the unit price in every proposal total. less than or equal to this value.
</ParamField>

<ParamField query="from_ProposalProduct_Price" type="number">
  Filter by optional per-unit price override in the location's currency; when empty the product's own price is used. greater than or equal to this value.
</ParamField>

<ParamField query="to_ProposalProduct_Price" type="number">
  Filter by optional per-unit price override in the location's currency; when empty the product's own price is used. less than or equal to this value.
</ParamField>

<ParamField query="from_ProposalProduct_InvoiceOn" type="string">
  Filter by optional UTC date from which this product starts being invoiced; a recurring line whose invoice date falls after a contract's start date is left out of that contract's totals. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ProposalProduct_InvoiceOn" type="string">
  Filter by optional UTC date from which this product starts being invoiced; a recurring line whose invoice date falls after a contract's start date is left out of that contract's totals. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_ProposalProduct_RepeatFrom" type="string">
  Filter by optional UTC date on which the recurrence begins; it is carried onto the customer product or contract product created on acceptance. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ProposalProduct_RepeatFrom" type="string">
  Filter by optional UTC date on which the recurrence begins; it is carried onto the customer product or contract product created on acceptance. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_ProposalProduct_RepeatUntil" type="string">
  Filter by optional UTC date after which the product stops recurring; a recurring line that has already ended is left out of the proposal totals. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_ProposalProduct_RepeatUntil" type="string">
  Filter by optional UTC date after which the product stops recurring; a recurring line that has already ended is left out of the proposal totals. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_ProposalProduct_RepeatUnit" type="integer">
  Filter by number of RepeatCycle periods between charges; 3 with a Month cycle bills quarterly. Acceptance falls back to 1 when it is empty. greater than or equal to this value.
</ParamField>

<ParamField query="to_ProposalProduct_RepeatUnit" type="integer">
  Filter by number of RepeatCycle periods between charges; 3 with a Month cycle bills quarterly. Acceptance falls back to 1 when it is empty. less than or equal to this value.
</ParamField>

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

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

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

<ParamField query="to_ProposalProduct_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/proposalproducts?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/proposalproducts?' + 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/proposalproducts',
      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/proposalproducts?ProposalProduct_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/proposalproducts?' + new URLSearchParams({
      ProposalProduct_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/proposalproducts',
      params={
          'ProposalProduct_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/proposalproducts?from_ProposalProduct_UpdatedOn=2025-01-01T00:00&to_ProposalProduct_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/proposalproducts?' + new URLSearchParams({
      from_ProposalProduct_UpdatedOn: '2025-01-01T00:00',
      to_ProposalProduct_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/proposalproducts',
      params={
          'from_ProposalProduct_UpdatedOn': '2025-01-01T00:00',
          'to_ProposalProduct_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="ProposalProduct[]">
  The list of ProposalProduct records matching the query. See the [Get one ProposalProduct](/rest-api/billing/get-proposalproducts-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 ProposalProduct. The following fields are **not populated** in the `Records[]` response: `RepeatCycle`, `Notes`.

  To get all fields, fetch the full record using the [Get one ProposalProduct](/rest-api/billing/get-proposalproducts-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,
      "ProductId": 0,
      "ProductName": null,
      "ProductPrice": null,
      "ProductApplyProRating": null,
      "ProductBusinessCurrencyCode": null,
      "Quantity": 0,
      "Price": null,
      "IsDeposit": false,
      "IsContractProduct": false,
      "RegularCharge": false,
      "InvoiceOn": null,
      "RepeatFrom": null,
      "RepeatUntil": null,
      "RepeatUnit": null,
      "ApplyProRating": 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": "ProposalProduct 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
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.