Create ProposalContractSchedule

POST

api

billing

proposalcontractschedules

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/proposalcontractschedules \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ProposalContractId": 123,
  "ApplyOn": "<string>"
}
'

import requests

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

payload = {
    "ProposalContractId": 123,
    "ApplyOn": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ProposalContractId: 123, ApplyOn: '<string>'})
};

fetch('https://spaces.nexudus.com/api/billing/proposalcontractschedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create role.

Request Body

Required Fields

integer

required

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

string

required

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

Optional Fields

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

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/proposalcontractschedules" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ProposalContractId": 0,
    "ApplyOn": "2025-01-15T10:30:00Z"
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/proposalcontractschedules',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      ProposalContractId: 0,
      ApplyOn: '2025-01-15T10:30:00Z'
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/proposalcontractschedules',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'ProposalContractId': 0,
        'ApplyOn': '2025-01-15T10:30:00Z'
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the proposalcontractschedule was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ProposalContractSchedule was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "ApplyOn: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "ApplyOn"
    }
  ],
  "WasSuccessful": false
}

Create ProposalContractSchedule

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/proposalcontractschedules \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ProposalContractId": 123,
  "ApplyOn": "<string>"
}
'

import requests

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

payload = {
    "ProposalContractId": 123,
    "ApplyOn": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ProposalContractId: 123, ApplyOn: '<string>'})
};

fetch('https://spaces.nexudus.com/api/billing/proposalcontractschedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Create ProposalContractSchedule

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400