Get one ProposalContract

GET

api

billing

proposalcontracts

{id}

Get one ProposalContract

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/proposalcontracts/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/billing/proposalcontracts/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/proposalcontracts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ProposalId": 123,
  "ProposalCoworkerId": 123,
  "ProposalCoworkerEmail": "<string>",
  "ProposalCoworkerFullName": "<string>",
  "TariffId": 123,
  "TariffName": "<string>",
  "TariffInvoiceEvery": 123,
  "TariffInvoiceEveryWeeks": 123,
  "TariffPrice": 123,
  "TariffBusinessCurrencyCode": "<string>",
  "Desks": [
    123
  ],
  "Variants": [
    123
  ],
  "Price": 123,
  "StartDate": "<string>",
  "CancellationLimitDays": 123,
  "ContractTerm": "<string>",
  "CancellationDate": "<string>",
  "BillingDay": 123,
  "Quantity": 123,
  "DiscountCodeId": 123,
  "FloorPlanDeskIds": "<string>",
  "FloorPlanDeskNames": "<string>",
  "FloorPlanDeskVariantIds": "<string>",
  "FloorPlanDeskVariantNames": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A ProposalContract is one quoted contract inside a proposal. It carries the same plan, unit, price, date, and quantity settings as a customer contract and becomes a real contract for the customer when the proposal is accepted. One is created automatically with the proposal from the proposal’s own contract fields; add more to quote several contracts in a single offer. Changes to the plan, units, price, or dates of an existing proposal belong here rather than on the proposal itself.

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-Read role.

Path Parameters

integer

required

The Id of the ProposalContract record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/billing/proposalcontracts/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/proposalcontracts/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/proposalcontracts/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

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

integer

Display value for Proposal.Coworker.Id..

string

Display value for Proposal.Coworker.Email..

string

Display value for Proposal.Coworker.FullName..

integer

ID of the plan quoted by this contract; required, and its billing interval, price, and policies govern the contract the customer receives on acceptance..

string

Display value for Tariff.Name..

integer

Display value for Tariff.InvoiceEvery..

integer

Display value for Tariff.InvoiceEveryWeeks..

number

Display value for Tariff.Price..

string

Display value for Tariff.Business.Currency.Code..

integer[]

List of IDs of the floor-plan units assigned to this quoted contract; each unit must belong to a location the user can access, an empty list means no unit is attached, and these are the units the customer receives on acceptance..

integer[]

List of IDs of the floor-plan unit packages assigned to this quoted contract; each package must belong to one of the units listed in Desks and to a location the user can access..

number

Optional per-unit price override for this quoted contract, in the issuing location’s currency; when empty the plan’s own price is used before quantity is applied..

string

Date the contract starts once the proposal is accepted; when empty, acceptance starts it the day after the proposal is accepted..

integer

Optional minimum cancellation notice, in days before the next billing day; when empty the plan’s own notice period applies..

string

Optional end date of the minimum contract term, carried onto the customer contract on acceptance; when empty the contract derives its own term from the plan’s default term and start date..

string

Optional date on which the contract ends; leave it empty for an open-ended contract..

integer

Day of the month, from 1 to 28, on which the contract is invoiced after acceptance..

integer

Number of plan units on this quoted contract, at least 1; it multiplies the unit price..

integer

Optional ID of a discount code carried onto the customer contract when the proposal is accepted..

string

Read-only denormalized IDs of the assigned floor-plan units; change Desks rather than this projection..

string

Read-only denormalized names of the assigned floor-plan units; change Desks rather than this projection..

string

Read-only denormalized IDs of the assigned floor-plan unit packages; change Variants rather than this projection..

string

Read-only denormalized names of the assigned floor-plan unit packages; change Variants rather than this projection..

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "ProposalId": 0,
  "ProposalCoworkerId": null,
  "ProposalCoworkerEmail": null,
  "ProposalCoworkerFullName": null,
  "TariffId": 0,
  "TariffName": null,
  "TariffInvoiceEvery": null,
  "TariffInvoiceEveryWeeks": null,
  "TariffPrice": null,
  "TariffBusinessCurrencyCode": null,
  "Desks": [],
  "Variants": [],
  "Price": null,
  "StartDate": null,
  "CancellationLimitDays": null,
  "ContractTerm": null,
  "CancellationDate": null,
  "BillingDay": 0,
  "Quantity": 0,
  "DiscountCodeId": null,
  "FloorPlanDeskIds": null,
  "FloorPlanDeskNames": null,
  "FloorPlanDeskVariantIds": null,
  "FloorPlanDeskVariantNames": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "ProposalContract Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one ProposalContract

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/proposalcontracts/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/billing/proposalcontracts/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/proposalcontracts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ProposalId": 123,
  "ProposalCoworkerId": 123,
  "ProposalCoworkerEmail": "<string>",
  "ProposalCoworkerFullName": "<string>",
  "TariffId": 123,
  "TariffName": "<string>",
  "TariffInvoiceEvery": 123,
  "TariffInvoiceEveryWeeks": 123,
  "TariffPrice": 123,
  "TariffBusinessCurrencyCode": "<string>",
  "Desks": [
    123
  ],
  "Variants": [
    123
  ],
  "Price": 123,
  "StartDate": "<string>",
  "CancellationLimitDays": 123,
  "ContractTerm": "<string>",
  "CancellationDate": "<string>",
  "BillingDay": 123,
  "Quantity": 123,
  "DiscountCodeId": 123,
  "FloorPlanDeskIds": "<string>",
  "FloorPlanDeskNames": "<string>",
  "FloorPlanDeskVariantIds": "<string>",
  "FloorPlanDeskVariantNames": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200