Search ProposalSchedules

GET

api

billing

proposalschedules

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

import requests

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

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/proposalschedules', 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 ProposalSchedule is a future price change quoted on a proposal: a new unit price and the date it takes effect. Schedules are copied into the quoted contract at the moment the proposal is created, and become the customer contract’s own scheduled price changes when the proposal is accepted, so a schedule added to a proposal that already has its quoted contract must be added to that contract instead.

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

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 price change belongs to; required, and the proposal’s issuing location owns this record..

integer

Filter by display value for Proposal.Quantity..

string

Filter by display value for Proposal.Tariff.Name..

integer

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

string

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

string

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

string

Filter by free-text note explaining the price change; it is copied onto the quoted contract’s schedule..

number

Filter by new per-unit price that takes effect on ApplyOn, in the issuing location’s currency..

string

Filter by date the new price takes effect; required, and each price change on the same proposal needs its own date..

boolean

Filter by read-only flag recording whether this price change has already been applied; the billing run sets it and it is not changed through proposal administration..

Range Filters

integer

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

integer

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

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 new per-unit price that takes effect on ApplyOn, in the issuing location’s currency. greater than or equal to this value.

number

Filter by new per-unit price that takes effect on ApplyOn, in the issuing location’s currency. less than or equal to this value.

string

Filter by date the new price takes effect; required, and each price change on the same proposal needs its own date. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date the new price takes effect; required, and each price change on the same proposal needs its own date. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

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/proposalschedules?page=1&size=15&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/proposalschedules?' + 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/proposalschedules',
    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/proposalschedules?ProposalSchedule_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/proposalschedules?' + new URLSearchParams({
    ProposalSchedule_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/proposalschedules',
    params={
        'ProposalSchedule_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/proposalschedules?from_ProposalSchedule_UpdatedOn=2025-01-01T00:00&to_ProposalSchedule_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/proposalschedules?' + new URLSearchParams({
    from_ProposalSchedule_UpdatedOn: '2025-01-01T00:00',
    to_ProposalSchedule_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/proposalschedules',
    params={
        'from_ProposalSchedule_UpdatedOn': '2025-01-01T00:00',
        'to_ProposalSchedule_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

ProposalSchedule[]

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

Partial records — The listing endpoint returns a summary representation of each ProposalSchedule. The following fields are not populated in the Records[] response: Notes.To get all fields, fetch the full record using the Get one ProposalSchedule 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,
      "ProposalQuantity": null,
      "ProposalTariffName": null,
      "ProposalCoworkerId": null,
      "ProposalCoworkerFullName": null,
      "ProposalCoworkerBillingName": null,
      "Price": null,
      "ApplyOn": "2025-01-15T10:30:00Z",
      "Applied": 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": "ProposalSchedule 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 ProposalSchedules

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

import requests

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

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/proposalschedules', 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

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by CreatedOn

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200