Skip to main content
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>'
{
  "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

​
id
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"

​
Response

​
200

​
ProposalId
integer
ID of the proposal linked to this record.
​
ProposalCoworkerId
string
Proposal coworker ID.
​
ProposalCoworkerEmail
string
Proposal coworker email.
​
ProposalCoworkerFullName
string
Proposal coworker full name.
​
ProductId
integer
ID of the product linked to this record.
​
ProductName
string
Product name.
​
ProductPrice
number
Product price.
​
ProductApplyProRating
string
Whether product applies pro-rating.
​
ProductBusinessCurrencyCode
string
Product business currency code.
​
Quantity
integer
Number of units.
​
Price
number
Price override.
​
IsDeposit
boolean
Whether this is a deposit.
​
IsContractProduct
boolean
Whether this is a contract product.
​
RegularCharge
boolean
Whether this is a regular charge.
​
RepeatCycle
integer
Repeat cycle pattern. See eRecurrentChargePattern enum values: 1 = PricePlan, 2 = Day, 3 = Week, 4 = Month, 5 = Year, 6 = LastDayOfMonth.
​
InvoiceOn
string
Invoice on date.
​
RepeatFrom
string
Repeat from date.
​
RepeatUntil
string
Repeat until date.
​
RepeatUnit
integer
Number of repeat units.
​
ApplyProRating
boolean
Apply pro-rating.
​
Notes
string
Optional notes or comments about this proposal product.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
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
}