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": "<string>",
  "ProposalCoworkerEmail": "<string>",
  "ProposalCoworkerFullName": "<string>",
  "TariffId": 123,
  "TariffName": "<string>",
  "TariffInvoiceEvery": "<string>",
  "TariffInvoiceEveryWeeks": "<string>",
  "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 links a contract configuration to a proposal, defining the pricing plan and terms that will be applied if the proposal is accepted by the customer.

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

string

Proposal coworker ID.

string

Proposal coworker email.

string

Proposal coworker full name.

integer

ID of the tariff linked to this record.

string

Tariff name.

string

Tariff invoice frequency.

string

Tariff invoice frequency in weeks.

number

Tariff price.

string

Tariff business currency code.

integer[]

List of desks linked to this record.

integer[]

List of variants linked to this record.

number

Price override.

string

Contract start date.

integer

Cancellation limit in days.

string

Contract term end date.

string

Cancellation date.

integer

Billing day of month.

integer

Number of units.

integer

ID of the discount code linked to this record.

string

Floor plan desk IDs.

string

Floor plan desk names.

string

Floor plan desk variant IDs.

string

Floor plan desk variant names.

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": 0,
  "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 multiple ProposalContractsRetrieve multiple ProposalContract records by their Ids in a single request.

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": "<string>",
  "ProposalCoworkerEmail": "<string>",
  "ProposalCoworkerFullName": "<string>",
  "TariffId": 123,
  "TariffName": "<string>",
  "TariffInvoiceEvery": "<string>",
  "TariffInvoiceEveryWeeks": "<string>",
  "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