Skip to main content
POST
/
api
/
billing
/
proposalcontracts
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

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

ProposalId
integer
required
Proposal Id.
TariffId
integer
required
Tariff Id.
BillingDay
integer
required
Billing day of month.
Quantity
integer
required
Quantity.

Optional Fields

Desks
integer[]
Desks.
Variants
integer[]
Variants.
Price
number
Price override.
StartDate
string
Contract start date.
CancellationLimitDays
integer
Cancellation limit in days.
ContractTerm
string
Contract term end date.
CancellationDate
string
Cancellation date.
DiscountCodeId
integer
Discount Code Id.

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

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

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.
WasSuccessful
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
}