Search ProposalContracts

GET

api

billing

proposalcontracts

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

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

integer

Filter by display value for Proposal.Coworker.Id..

string

Filter by display value for Proposal.Coworker.Email..

string

Filter by display value for Proposal.Coworker.FullName..

integer

Filter by 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

Filter by display value for Tariff.Name..

integer

Filter by display value for Tariff.InvoiceEvery..

integer

Filter by display value for Tariff.InvoiceEveryWeeks..

number

Filter by display value for Tariff.Price..

string

Filter by display value for Tariff.Business.Currency.Code..

number

Filter by 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

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

integer

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

string

Filter by 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

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

integer

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

integer

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

integer

Filter by optional ID of a discount code carried onto the customer contract when the proposal is accepted..

string

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

string

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

string

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

string

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

Range Filters

integer

Filter by display value for Proposal.Coworker.Id. greater than or equal to this value.

integer

Filter by display value for Proposal.Coworker.Id. less than or equal to this value.

integer

Filter by display value for Tariff.InvoiceEvery. greater than or equal to this value.

integer

Filter by display value for Tariff.InvoiceEvery. less than or equal to this value.

integer

Filter by display value for Tariff.InvoiceEveryWeeks. greater than or equal to this value.

integer

Filter by display value for Tariff.InvoiceEveryWeeks. less than or equal to this value.

number

Filter by display value for Tariff.Price. greater than or equal to this value.

number

Filter by display value for Tariff.Price. less than or equal to this value.

number

Filter by 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. greater than or equal to this value.

number

Filter by 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. less than or equal to this value.

string

Filter by date the contract starts once the proposal is accepted; when empty, acceptance starts it the day after the proposal is accepted. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date the contract starts once the proposal is accepted; when empty, acceptance starts it the day after the proposal is accepted. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by optional minimum cancellation notice, in days before the next billing day; when empty the plan’s own notice period applies. greater than or equal to this value.

integer

Filter by optional minimum cancellation notice, in days before the next billing day; when empty the plan’s own notice period applies. less than or equal to this value.

string

Filter by optional date on which the contract ends; leave it empty for an open-ended contract. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional date on which the contract ends; leave it empty for an open-ended contract. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by day of the month, from 1 to 28, on which the contract is invoiced after acceptance. greater than or equal to this value.

integer

Filter by day of the month, from 1 to 28, on which the contract is invoiced after acceptance. less than or equal to this value.

integer

Filter by number of plan units on this quoted contract, at least 1; it multiplies the unit price. greater than or equal to this value.

integer

Filter by number of plan units on this quoted contract, at least 1; it multiplies the unit price. less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/billing/proposalcontracts?page=1&size=15&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/proposalcontracts?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'CreatedOn',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/proposalcontracts',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'CreatedOn',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/billing/proposalcontracts?ProposalContract_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/proposalcontracts?' + new URLSearchParams({
    ProposalContract_CreatedOn: 'example-value',
    orderBy: 'CreatedOn',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/proposalcontracts',
    params={
        'ProposalContract_CreatedOn': 'example-value',
        'orderBy': 'CreatedOn',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/billing/proposalcontracts?from_ProposalContract_UpdatedOn=2025-01-01T00:00&to_ProposalContract_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/proposalcontracts?' + new URLSearchParams({
    from_ProposalContract_UpdatedOn: '2025-01-01T00:00',
    to_ProposalContract_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/proposalcontracts',
    params={
        'from_ProposalContract_UpdatedOn': '2025-01-01T00:00',
        'to_ProposalContract_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

ProposalContract[]

The list of ProposalContract records matching the query. See the Get one ProposalContract endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each ProposalContract. The following fields are not populated in the Records[] response: CancellationLimitDays, BillingDay, Quantity.To get all fields, fetch the full record using the Get one ProposalContract endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "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,
      "ContractTerm": null,
      "CancellationDate": null,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search ProposalContracts

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by CreatedOn

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200