Create ProposalSchedule

POST

api

billing

proposalschedules

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

import requests

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

payload = {
    "ProposalId": 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({ProposalId: 123, ApplyOn: '<string>'})
};

fetch('https://spaces.nexudus.com/api/billing/proposalschedules', 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 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-Create role.

Request Body

Required Fields

integer

required

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

string

required

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

Optional Fields

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

Code Examples

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

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/proposalschedules',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'ProposalId': 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 proposalschedule was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ProposalSchedule 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 ProposalSchedule

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

import requests

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

payload = {
    "ProposalId": 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({ProposalId: 123, ApplyOn: '<string>'})
};

fetch('https://spaces.nexudus.com/api/billing/proposalschedules', 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

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