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 links a product to a proposal, defining additional items or services included in the offer with their pricing and recurrence settings.

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 linked to this record.

integer

required

ID of the product linked to this record.

integer

required

Number of units.

integer

required

Repeat cycle pattern. Defaults to eRecurrentChargePattern.PricePlan.

Optional Fields

number

Price override.

boolean

Whether this is a deposit.

boolean

Whether this is a contract product.

boolean

Whether this is a regular charge.

string

Invoice on date.

string

Repeat from date.

string

Repeat until date.

integer

Number of repeat units.

boolean

Apply pro-rating.

string

Optional notes or comments about this proposal product.

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
}

Update ProposalProductUpdate an existing ProposalProduct record.

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