Search ProposalProducts - Nexudus Platform

GET

api

billing

proposalproducts

Search ProposalProducts

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-List role.

Enums

eRecurrentChargePattern — RepeatCycle values

Value	Name
1	PricePlan
2	Day
3	Week
4	Month
5	Year
6	LastDayOfMonth

Query Parameters

Pagination & Sorting

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

The property name to sort results by (e.g. Name, CreatedOn).

dir

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

ProposalProduct_Proposal

integer

Filter by iD of the proposal linked to this record.

ProposalProduct_Proposal_Coworker_Id

string

Filter by proposal coworker ID.

ProposalProduct_Proposal_Coworker_Email

string

Filter by proposal coworker email.

ProposalProduct_Proposal_Coworker_FullName

string

Filter by proposal coworker full name.

ProposalProduct_Product

integer

Filter by iD of the product linked to this record.

ProposalProduct_Product_Name

string

Filter by product name.

ProposalProduct_Product_Price

number

Filter by product price.

ProposalProduct_Product_ApplyProRating

string

Filter by whether product applies pro-rating.

ProposalProduct_Product_Business_Currency_Code

string

Filter by product business currency code.

ProposalProduct_Quantity

integer

Filter by number of units.

ProposalProduct_Price

number

Filter by price override.

ProposalProduct_IsDeposit

boolean

Filter by whether this is a deposit.

ProposalProduct_IsContractProduct

boolean

Filter by whether this is a contract product.

ProposalProduct_RegularCharge

boolean

Filter by whether this is a regular charge.

ProposalProduct_RepeatCycle

integer

Filter by repeat cycle pattern.

ProposalProduct_InvoiceOn

string

Filter by invoice on date.

ProposalProduct_RepeatFrom

string

Filter by repeat from date.

ProposalProduct_RepeatUntil

string

Filter by repeat until date.

ProposalProduct_RepeatUnit

integer

Filter by number of repeat units.

ProposalProduct_ApplyProRating

boolean

Filter by apply pro-rating.

ProposalProduct_Notes

string

Filter by optional notes or comments about this proposal product.

Range Filters

from_ProposalProduct_ProductPrice

number

Filter by product price greater than or equal to this value.

to_ProposalProduct_ProductPrice

number

Filter by product price less than or equal to this value.

from_ProposalProduct_Quantity

integer

Filter by number of units greater than or equal to this value.

to_ProposalProduct_Quantity

integer

Filter by number of units less than or equal to this value.

from_ProposalProduct_Price

number

Filter by price override greater than or equal to this value.

to_ProposalProduct_Price

number

Filter by price override less than or equal to this value.

from_ProposalProduct_InvoiceOn

string

Filter by invoice on date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_ProposalProduct_InvoiceOn

string

Filter by invoice on date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_ProposalProduct_RepeatFrom

string

Filter by repeat from date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_ProposalProduct_RepeatFrom

string

Filter by repeat from date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_ProposalProduct_RepeatUntil

string

Filter by repeat until date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_ProposalProduct_RepeatUntil

string

Filter by repeat until date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_ProposalProduct_RepeatUnit

integer

Filter by number of repeat units greater than or equal to this value.

to_ProposalProduct_RepeatUnit

integer

Filter by number of repeat units less than or equal to this value.

from_ProposalProduct_CreatedOn

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_ProposalProduct_CreatedOn

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_ProposalProduct_UpdatedOn

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_ProposalProduct_UpdatedOn

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/billing/proposalproducts?page=1&size=15&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/billing/proposalproducts?ProposalProduct_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

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"

Response

200

Records

ProposalProduct[]

The list of ProposalProduct records matching the query. See the Get one ProposalProduct endpoint for the full list of properties returned for each record.

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 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.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

The sort direction (0 = ascending, 1 = descending).

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "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,
      "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
}

Get one ProposalProductRetrieve a single ProposalProduct record by its Id.

Search ProposalProducts

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by CreatedOn

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200