Create Proposal

POST

api

billing

proposals

Create Proposal

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

import requests

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

payload = {
    "IssuedById": 123,
    "ResponsibleId": 123,
    "CoworkerId": 123,
    "Reference": "<string>",
    "ProposalStatus": 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({
    IssuedById: 123,
    ResponsibleId: 123,
    CoworkerId: 123,
    Reference: '<string>',
    ProposalStatus: 123,
    TariffId: 123,
    BillingDay: 123,
    Quantity: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/proposals', 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 Proposal bundles one or more contracts (ProposalContract records) that are presented to a customer for review and acceptance. Each ProposalContract carries the same properties as a CoworkerContract and becomes one when the proposal is accepted. When a Proposal is created, a ProposalContract is automatically created and associated with it. From that point on, the contract-related fields on the Proposal (TariffId, Desks, Variants, Price, StartDate, CancellationLimitDays, ContractTerm, CancellationDate, ExpirationDate, BillingDay, Quantity) become read-only — they are all createOnly. Subsequent edits to those values must be made via the associated ProposalContract. Additional ProposalContract records can also be added. Proposals support three optional attachments:

DocumentToSendId — a DocumentTemplate entity presented to the customer instead of the standard price-schedule table before the proposal is accepted.
DocumentToSignId — a DocumentTemplate entity used to generate a document for e-signature.
ProposalFile — a file shown as a downloadable link before the proposal is accepted.

Set DoNotIssueInvoice to control whether the first invoice is issued automatically when the proposal is accepted.

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

Enums

eProposalStatus — ProposalStatus values

Value	Name
1	Draft
2	Sent
3	Accepted
4	Rejected

Request Body

Required Fields

integer

required

ID of the issued by linked to this record.

integer

required

ID of the responsible linked to this record.

integer

required

ID of the coworker linked to this record.

string

required

Proposal reference.

integer

required

Proposal status. Defaults to eProposalStatus.Draft.

integer

required

ID of the tariff linked to this record.

integer

required

Billing day of month for the initial contract. Becomes read-only after creation; edit via ProposalContract.

integer

required

Quantity for the initial contract. Becomes read-only after creation; edit via ProposalContract.

Optional Fields

string

Optional notes or comments about this proposal.

integer

ID of the document to send linked to this record.

integer

ID of the document to sign linked to this record.

string

The document to sign html value for this proposal.

string

URL of a new file to upload as the document to sign binary document.

boolean

Set to true to remove the current document to sign binary document file.

string

The document to send html value for this proposal.

string

URL of a new file to upload as the document to send binary document.

boolean

Set to true to remove the current document to send binary document file.

string

URL of a new file to upload as the proposal file.

boolean

Set to true to remove the current proposal file file.

integer[]

List of desks linked to this record.

integer[]

List of variants linked to this record.

number

Price override for the initial contract. Becomes read-only after creation; edit via ProposalContract.

string

Start date for the initial contract. Becomes read-only after creation; edit via ProposalContract.

integer

Cancellation limit in days for the initial contract. Becomes read-only after creation; edit via ProposalContract.

string

Contract term end date for the initial contract. Becomes read-only after creation; edit via ProposalContract.

string

Cancellation date for the initial contract. Becomes read-only after creation; edit via ProposalContract.

string

Proposal expiration date. Becomes read-only after creation; edit via ProposalContract.

integer

ID of the discount code linked to this record.

string

Date/time value for start date local.

string

Date/time value for sent on local.

boolean

If true, the first invoice is not issued automatically when the proposal is accepted.

Code Examples

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

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/proposals',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'IssuedById': 0,
        'ResponsibleId': 0,
        'CoworkerId': 0,
        'Reference': '',
        'ProposalStatus': 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 proposal was created successfully.

array

null on success.

Example Response

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

Update ProposalUpdate an existing Proposal record.

Create Proposal

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

import requests

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

payload = {
    "IssuedById": 123,
    "ResponsibleId": 123,
    "CoworkerId": 123,
    "Reference": "<string>",
    "ProposalStatus": 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({
    IssuedById: 123,
    ResponsibleId: 123,
    CoworkerId: 123,
    Reference: '<string>',
    ProposalStatus: 123,
    TariffId: 123,
    BillingDay: 123,
    Quantity: 123
  })
};

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