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

> Retrieve a single ProposalProduct record by its Id.

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

## Path Parameters

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

## Code Examples

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

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposalproducts/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/proposalproducts/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

## Response

### 200

<ResponseField name="ProposalId" type="integer">
  ID of the proposal this line belongs to; required, and the proposal's issuing location owns this record..
</ResponseField>

<ResponseField name="ProposalCoworkerId" type="integer">
  Display value for Proposal.Coworker.Id..
</ResponseField>

<ResponseField name="ProposalCoworkerEmail" type="string">
  Display value for Proposal.Coworker.Email..
</ResponseField>

<ResponseField name="ProposalCoworkerFullName" type="string">
  Display value for Proposal.Coworker.FullName..
</ResponseField>

<ResponseField name="ProductId" type="integer">
  ID of the product quoted on this line; required, and it must belong to a location the user can access..
</ResponseField>

<ResponseField name="ProductName" type="string">
  Display value for Product.Name..
</ResponseField>

<ResponseField name="ProductPrice" type="number">
  Display value for Product.Price..
</ResponseField>

<ResponseField name="ProductApplyProRating" type="boolean">
  Display value for Product.ApplyProRating..
</ResponseField>

<ResponseField name="ProductBusinessCurrencyCode" type="string">
  Display value for Product.Business.Currency.Code..
</ResponseField>

<ResponseField name="Quantity" type="integer">
  Number of units of the product quoted, at least 1; it multiplies the unit price in every proposal total..
</ResponseField>

<ResponseField name="Price" type="number">
  Optional per-unit price override in the location's currency; when empty the product's own price is used..
</ResponseField>

<ResponseField name="IsDeposit" type="boolean">
  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..
</ResponseField>

<ResponseField name="IsContractProduct" type="boolean">
  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..
</ResponseField>

<ResponseField name="RegularCharge" type="boolean">
  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..
</ResponseField>

<ResponseField name="RepeatCycle" type="integer">
  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.. See `eRecurrentChargePattern` enum values: `1` = PricePlan, `2` = Day, `3` = Week, `4` = Month, `5` = Year, `6` = LastDayOfMonth.
</ResponseField>

<ResponseField name="InvoiceOn" type="string">
  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..
</ResponseField>

<ResponseField name="RepeatFrom" type="string">
  Optional UTC date on which the recurrence begins; it is carried onto the customer product or contract product created on acceptance..
</ResponseField>

<ResponseField name="RepeatUntil" type="string">
  Optional UTC date after which the product stops recurring; a recurring line that has already ended is left out of the proposal totals..
</ResponseField>

<ResponseField name="RepeatUnit" type="integer">
  Number of RepeatCycle periods between charges; 3 with a Month cycle bills quarterly. Acceptance falls back to 1 when it is empty..
</ResponseField>

<ResponseField name="ApplyProRating" type="boolean">
  Whether the product's first charge is prorated for a partial billing period..
</ResponseField>

<ResponseField name="Notes" type="string">
  Free-text note carried onto the product created for the customer when the proposal is accepted..
</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}
{
  "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,
  "RepeatCycle": 0,
  "InvoiceOn": null,
  "RepeatFrom": null,
  "RepeatUntil": null,
  "RepeatUnit": null,
  "ApplyProRating": false,
  "Notes": 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": "ProposalProduct Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```