Search ProposalProducts

GET

api

billing

proposalproducts

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

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

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

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

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

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the proposal this line belongs to; required, and the proposal’s issuing location owns this record..

integer

Filter by display value for Proposal.Coworker.Id..

string

Filter by display value for Proposal.Coworker.Email..

string

Filter by display value for Proposal.Coworker.FullName..

integer

Filter by iD of the product quoted on this line; required, and it must belong to a location the user can access..

string

Filter by display value for Product.Name..

number

Filter by display value for Product.Price..

boolean

Filter by display value for Product.ApplyProRating..

string

Filter by display value for Product.Business.Currency.Code..

integer

Filter by number of units of the product quoted, at least 1; it multiplies the unit price in every proposal total..

number

Filter by optional per-unit price override in the location’s currency; when empty the product’s own price is used..

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

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

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

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

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

string

Filter by optional UTC date on which the recurrence begins; it is carried onto the customer product or contract product created on acceptance..

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

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

boolean

Filter by whether the product’s first charge is prorated for a partial billing period..

string

Filter by free-text note carried onto the product created for the customer when the proposal is accepted..

Range Filters

integer

Filter by display value for Proposal.Coworker.Id. greater than or equal to this value.

integer

Filter by display value for Proposal.Coworker.Id. less than or equal to this value.

number

Filter by display value for Product.Price. greater than or equal to this value.

number

Filter by display value for Product.Price. less than or equal to this value.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

string

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

string

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

string

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

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"

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();

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()

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"

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();

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()

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"

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();

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()

Response

200

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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

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

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

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": 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
}

Search ProposalProducts

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

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

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200