Get one ProposalProduct

GET

api

billing

proposalproducts

{id}

Get one ProposalProduct

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/proposalproducts/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/billing/proposalproducts/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/proposalproducts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ProposalId": 123,
  "ProposalCoworkerId": "<string>",
  "ProposalCoworkerEmail": "<string>",
  "ProposalCoworkerFullName": "<string>",
  "ProductId": 123,
  "ProductName": "<string>",
  "ProductPrice": 123,
  "ProductApplyProRating": "<string>",
  "ProductBusinessCurrencyCode": "<string>",
  "Quantity": 123,
  "Price": 123,
  "IsDeposit": true,
  "IsContractProduct": true,
  "RegularCharge": true,
  "RepeatCycle": 123,
  "InvoiceOn": "<string>",
  "RepeatFrom": "<string>",
  "RepeatUntil": "<string>",
  "RepeatUnit": 123,
  "ApplyProRating": true,
  "Notes": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A ProposalProduct links a product to a proposal, defining additional items or services included in the offer with their pricing and recurrence settings.

Authentication

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.

Path Parameters

integer

required

The Id of the ProposalProduct record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/billing/proposalproducts/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/proposalproducts/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/proposalproducts/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the proposal linked to this record.

string

Proposal coworker ID.

string

Proposal coworker email.

string

Proposal coworker full name.

integer

ID of the product linked to this record.

string

Product name.

number

Product price.

string

Whether product applies pro-rating.

string

Product business currency code.

integer

Number of units.

number

Price override.

boolean

Whether this is a deposit.

boolean

Whether this is a contract product.

boolean

Whether this is a regular charge.

integer

Repeat cycle pattern. See eRecurrentChargePattern enum values: 1 = PricePlan, 2 = Day, 3 = Week, 4 = Month, 5 = Year, 6 = LastDayOfMonth.

string

Invoice on date.

string

Repeat from date.

string

Repeat until date.

integer

Number of repeat units.

boolean

Apply pro-rating.

string

Optional notes or comments about this proposal product.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "ProposalId": 0,
  "ProposalCoworkerId": null,
  "ProposalCoworkerEmail": null,
  "ProposalCoworkerFullName": null,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": 0,
  "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
}

Get multiple ProposalProductsRetrieve multiple ProposalProduct records by their Ids in a single request.

Get one ProposalProduct

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/proposalproducts/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/billing/proposalproducts/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/proposalproducts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ProposalId": 123,
  "ProposalCoworkerId": "<string>",
  "ProposalCoworkerEmail": "<string>",
  "ProposalCoworkerFullName": "<string>",
  "ProductId": 123,
  "ProductName": "<string>",
  "ProductPrice": 123,
  "ProductApplyProRating": "<string>",
  "ProductBusinessCurrencyCode": "<string>",
  "Quantity": 123,
  "Price": 123,
  "IsDeposit": true,
  "IsContractProduct": true,
  "RegularCharge": true,
  "RepeatCycle": 123,
  "InvoiceOn": "<string>",
  "RepeatFrom": "<string>",
  "RepeatUntil": "<string>",
  "RepeatUnit": 123,
  "ApplyProRating": true,
  "Notes": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200