Create Proposal - Nexudus Platform

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
}
'

{
  "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

IssuedById

integer

required

ID of the issued by linked to this record.

ResponsibleId

integer

required

ID of the responsible linked to this record.

CoworkerId

integer

required

ID of the coworker linked to this record.

Reference

string

required

Proposal reference.

ProposalStatus

integer

required

Proposal status. Defaults to eProposalStatus.Draft.

TariffId

integer

required

ID of the tariff linked to this record.

BillingDay

integer

required

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

Quantity

integer

required

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

Optional Fields

Notes

string

Optional notes or comments about this proposal.

DocumentToSendId

integer

ID of the document to send linked to this record.

DocumentToSignId

integer

ID of the document to sign linked to this record.

DocumentToSignHtml

string

The document to sign html value for this proposal.

NewDocumentToSignBinaryDocumentUrl

string

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

ClearDocumentToSignBinaryDocumentFile

boolean

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

DocumentToSendHtml

string

The document to send html value for this proposal.

NewDocumentToSendBinaryDocumentUrl

string

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

ClearDocumentToSendBinaryDocumentFile

boolean

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

NewProposalFileUrl

string

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

ClearProposalFileFile

boolean

Set to true to remove the current proposal file file.

Desks

integer[]

List of desks linked to this record.

Variants

integer[]

List of variants linked to this record.

Price

number

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

StartDate

string

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

CancellationLimitDays

integer

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

ContractTerm

string

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

CancellationDate

string

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

ExpirationDate

string

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

DiscountCodeId

integer

ID of the discount code linked to this record.

StartDateLocal

string

Date/time value for start date local.

SentOnLocal

string

Date/time value for sent on local.

DoNotIssueInvoice

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
}'

Response

200

Status

integer

HTTP status code. 200 on success.

Message

string

A human-readable message confirming the creation.

Value

object

Contains the Id of the newly created record.

WasSuccessful

boolean

true if the proposal was created successfully.

Errors

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

Message

string

A summary of the validation error(s), in the format PropertyName: error message.

Value

any

null on validation failure.

Errors

object[]

Array of validation errors.

Show child attributes

AttemptedValue

any

The value that was submitted for the field, or null if missing.

Message

string

The validation error message.

PropertyName

string

The name of the property that failed validation.

WasSuccessful

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
}
'

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

​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