Create ProposalProduct

POST

api

billing

proposalproducts

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

import requests

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

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

fetch('https://spaces.nexudus.com/api/billing/proposalproducts', 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 ProposalProduct is one extra item quoted alongside the plan in a proposal: an add-on product, a plan component, or a refundable deposit. IsDeposit and IsContractProduct decide what happens on acceptance - a deposit attaches to the first contract and switches on its sign-up fee, a contract product attaches to every contract in the proposal, and anything else becomes a standalone product on the customer’s account.

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

Enums

eRecurrentChargePattern — RepeatCycle values

Value	Name
1	PricePlan
2	Day
3	Week
4	Month
5	Year
6	LastDayOfMonth

Request Body

Required Fields

integer

required

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

integer

required

ID of the product quoted on this line; required, and it must belong to a location the user can access..

integer

required

Number of units of the product quoted, at least 1; it multiplies the unit price in every proposal total..

integer

required

Recurrence interval used when RegularCharge is true: PricePlan follows the contract’s own billing cycle, Day, Week, Month and Year repeat every RepeatUnit of that period, and LastDayOfMonth charges on the final day of each month.. Defaults to eRecurrentChargePattern.PricePlan.

Optional Fields

number

Optional per-unit price override in the location’s currency; when empty the product’s own price is used..

boolean

Whether this line is a refundable deposit. On acceptance a deposit is attached to the first contract only and switches on that contract’s sign-up fee, and it counts towards the one-off sign-up total rather than the recurring total..

boolean

Whether this line is attached to the contracts rather than sold on its own. On acceptance a contract product is added to every contract in the proposal; when this and IsDeposit are both false, the line becomes a standalone product on the customer’s account..

boolean

Whether the product recurs with the customer’s billing instead of being charged once; it also decides whether the line counts towards the proposal’s recurring total or its one-off sign-up total..

string

Optional UTC date from which this product starts being invoiced; a recurring line whose invoice date falls after a contract’s start date is left out of that contract’s totals..

string

Optional UTC date on which the recurrence begins; it is carried onto the customer product or contract product created on acceptance..

string

Optional UTC date after which the product stops recurring; a recurring line that has already ended is left out of the proposal totals..

integer

Number of RepeatCycle periods between charges; 3 with a Month cycle bills quarterly. Acceptance falls back to 1 when it is empty..

boolean

Whether the product’s first charge is prorated for a partial billing period..

string

Free-text note carried onto the product created for the customer when the proposal is accepted..

Code Examples

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

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

const data = await response.json();

import requests

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

array

null on success.

Example Response

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

Create ProposalProduct

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

import requests

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

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

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

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400