Create ProposalContract

POST

api

billing

proposalcontracts

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

import requests

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

payload = {
    "ProposalId": 123,
    "TariffId": 123,
    "BillingDay": 123,
    "Quantity": 123
}
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, TariffId: 123, BillingDay: 123, Quantity: 123})
};

fetch('https://spaces.nexudus.com/api/billing/proposalcontracts', 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 ProposalContract links a contract configuration to a proposal, defining the pricing plan and terms that will be applied if the proposal is accepted by the customer.

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 ProposalContract-Create role.

Request Body

Required Fields

integer

required

ID of the proposal linked to this record.

integer

required

ID of the tariff linked to this record.

integer

required

Billing day of month.

integer

required

Number of units.

Optional Fields

integer[]

List of desks linked to this record.

integer[]

List of variants linked to this record.

number

Price override.

string

Contract start date.

integer

Cancellation limit in days.

string

Contract term end date.

string

Cancellation date.

integer

ID of the discount code linked to this record.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/proposalcontracts" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ProposalId": 0,
    "TariffId": 0,
    "BillingDay": 0,
    "Quantity": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/proposalcontracts',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      ProposalId: 0,
      TariffId: 0,
      BillingDay: 0,
      Quantity: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/proposalcontracts',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'ProposalId': 0,
        'TariffId': 0,
        'BillingDay': 0,
        'Quantity': 0
    }
)

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 proposalcontract was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ProposalContract 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": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Update ProposalContractUpdate an existing ProposalContract record.

Create ProposalContract

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

import requests

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

payload = {
    "ProposalId": 123,
    "TariffId": 123,
    "BillingDay": 123,
    "Quantity": 123
}
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, TariffId: 123, BillingDay: 123, Quantity: 123})
};

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