Get one ProposalContractSchedule

GET

api

billing

proposalcontractschedules

{id}

Get one ProposalContractSchedule

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

import requests

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

{
  "ProposalContractId": 123,
  "ProposalContractQuantity": 123,
  "ProposalContractTariffName": "<string>",
  "ProposalContractProposalCoworkerId": 123,
  "ProposalContractProposalCoworkerFullName": "<string>",
  "ProposalContractProposalCoworkerBillingName": "<string>",
  "Notes": "<string>",
  "Price": 123,
  "ApplyOn": "<string>",
  "Applied": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A ProposalContractSchedule is a future price change on one quoted contract inside a proposal: a new unit price and the date it takes effect. Each one becomes a scheduled price change on the customer’s real contract when the proposal is accepted. This is where scheduled price changes are managed once a proposal has been created.

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

Path Parameters

integer

required

The Id of the ProposalContractSchedule record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

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

integer

Display value for ProposalContract.Quantity..

string

Display value for ProposalContract.Tariff.Name..

integer

Display value for ProposalContract.Proposal.Coworker.Id..

string

Display value for ProposalContract.Proposal.Coworker.FullName..

string

Display value for ProposalContract.Proposal.Coworker.BillingName..

string

Free-text note explaining the price change; it is carried onto the customer contract’s schedule on acceptance..

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 quoted contract 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

{
  "ProposalContractId": 0,
  "ProposalContractQuantity": null,
  "ProposalContractTariffName": null,
  "ProposalContractProposalCoworkerId": null,
  "ProposalContractProposalCoworkerFullName": null,
  "ProposalContractProposalCoworkerBillingName": 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": "ProposalContractSchedule Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one ProposalContractSchedule

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

import requests

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

{
  "ProposalContractId": 123,
  "ProposalContractQuantity": 123,
  "ProposalContractTariffName": "<string>",
  "ProposalContractProposalCoworkerId": 123,
  "ProposalContractProposalCoworkerFullName": "<string>",
  "ProposalContractProposalCoworkerBillingName": "<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

Get one ProposalContractSchedule

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200