Get one ProposalSchedule

GET

api

billing

proposalschedules

{id}

Get one ProposalSchedule

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

import requests

url = "https://spaces.nexudus.com/api/billing/proposalschedules/{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/proposalschedules/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ProposalId": 123,
  "ProposalQuantity": 123,
  "ProposalTariffName": "<string>",
  "ProposalCoworkerId": 123,
  "ProposalCoworkerFullName": "<string>",
  "ProposalCoworkerBillingName": "<string>",
  "Notes": "<string>",
  "Price": 123,
  "ApplyOn": "<string>",
  "Applied": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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

Path Parameters

integer

required

The Id of the ProposalSchedule record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the proposal this price change belongs to; required, and the proposal’s issuing location owns this record..

integer

Display value for Proposal.Quantity..

string

Display value for Proposal.Tariff.Name..

integer

Display value for Proposal.Coworker.Id..

string

Display value for Proposal.Coworker.FullName..

string

Display value for Proposal.Coworker.BillingName..

string

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

number

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

string

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

boolean

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

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,
  "ProposalQuantity": null,
  "ProposalTariffName": null,
  "ProposalCoworkerId": null,
  "ProposalCoworkerFullName": null,
  "ProposalCoworkerBillingName": null,
  "Notes": 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
}

Get one ProposalSchedule

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

import requests

url = "https://spaces.nexudus.com/api/billing/proposalschedules/{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/proposalschedules/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ProposalId": 123,
  "ProposalQuantity": 123,
  "ProposalTariffName": "<string>",
  "ProposalCoworkerId": 123,
  "ProposalCoworkerFullName": "<string>",
  "ProposalCoworkerBillingName": "<string>",
  "Notes": "<string>",
  "Price": 123,
  "ApplyOn": "<string>",
  "Applied": true,
  "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