Search Proposals

GET

api

billing

proposals

Search Proposals

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

import requests

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

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/proposals', 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 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-List role.

Enums

eProposalStatus — ProposalStatus values

Value	Name
1	Draft
2	Sent
3	Accepted
4	Rejected

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

string

Filter by issuing business name.

string

Filter by issuing business currency code.

integer

Filter by iD of the responsible linked to this record.

string

Filter by responsible person full name.

integer

Filter by iD of the coworker linked to this record.

string

Filter by coworker type.

string

Filter by coworker full name.

string

Filter by coworker company name.

string

Filter by coworker billing name.

string

Filter by proposal reference.

string

Filter by optional notes or comments about this proposal.

integer

Filter by proposal status.

integer

Filter by iD of the document to send linked to this record.

integer

Filter by iD of the document to sign linked to this record.

string

Filter by the document to sign html value for this proposal.

string

Filter by current file name of the document to sign binary document (read-only; upload via the corresponding URL field).

string

Filter by uRL of a new file to upload as the document to sign binary document.

boolean

Filter by set to true to remove the current document to sign binary document file.

string

Filter by the document to send html value for this proposal.

string

Filter by current file name of the document to send binary document (read-only; upload via the corresponding URL field).

string

Filter by uRL of a new file to upload as the document to send binary document.

boolean

Filter by set to true to remove the current document to send binary document file.

string

Filter by current file name of the proposal file (read-only; upload via the corresponding URL field).

string

Filter by uRL of a new file to upload as the proposal file.

boolean

Filter by set to true to remove the current proposal file file.

integer

Filter by iD of the tariff linked to this record.

string

Filter by tariff name.

string

Filter by tariff invoice frequency.

string

Filter by tariff invoice frequency in weeks.

number

Filter by tariff price.

string

Filter by tariff business currency code.

number

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

string

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

integer

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

string

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

string

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

string

Filter by proposal expiration date. Becomes read-only after creation; edit via ProposalContract.

integer

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

integer

Filter by quantity for the initial contract. Becomes read-only after creation; edit via ProposalContract.

integer

Filter by iD of the discount code linked to this record.

string

Filter by date/time value for start date local.

string

Filter by date the proposal was sent.

string

Filter by date/time value for sent on local.

string

Filter by date the customer last opened the proposal.

boolean

Filter by if true, the first invoice is not issued automatically when the proposal is accepted.

Range Filters

number

Filter by tariff price greater than or equal to this value.

number

Filter by tariff price less than or equal to this value.

number

Filter by price override for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value.

number

Filter by price override for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value.

string

Filter by start date for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by start date for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by cancellation limit in days for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value.

integer

Filter by cancellation limit in days for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value.

string

Filter by contract term end date for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by contract term end date for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by cancellation date for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by cancellation date for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by proposal expiration date. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by proposal expiration date. Becomes read-only after creation; edit via ProposalContract less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by billing day of month for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value.

integer

Filter by billing day of month for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value.

integer

Filter by quantity for the initial contract. Becomes read-only after creation; edit via ProposalContract greater than or equal to this value.

integer

Filter by quantity for the initial contract. Becomes read-only after creation; edit via ProposalContract less than or equal to this value.

string

Filter by date/time value for start date local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for start date local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date the proposal was sent greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date the proposal was sent less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for sent on local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for sent on local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date the customer last opened the proposal greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date the customer last opened the proposal less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

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/proposals?page=1&size=15&orderBy=Reference&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const data = await response.json();

import requests

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

data = response.json()

Filtering by Reference

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

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

const data = await response.json();

import requests

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

data = response.json()

Range filters

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

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/proposals?' + new URLSearchParams({
    from_Proposal_UpdatedOn: '2025-01-01T00:00',
    to_Proposal_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/proposals',
    params={
        'from_Proposal_UpdatedOn': '2025-01-01T00:00',
        'to_Proposal_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

Proposal[]

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

Partial records — The listing endpoint returns a summary representation of each Proposal. The following fields are not populated in the Records[] response: Notes, DocumentToSignHtml, DocumentToSendHtml, Price, StartDate, CancellationLimitDays, CancellationDate, BillingDay, Quantity.To get all fields, fetch the full record using the Get one Proposal 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": [
    {
      "IssuedById": 0,
      "IssuedByName": null,
      "IssuedByCurrencyCode": null,
      "ResponsibleId": 0,
      "ResponsibleFullName": null,
      "CoworkerId": 0,
      "CoworkerCoworkerType": null,
      "CoworkerFullName": null,
      "CoworkerCompanyName": null,
      "CoworkerBillingName": null,
      "Reference": "",
      "ProposalStatus": 0,
      "DocumentToSendId": null,
      "DocumentToSignId": null,
      "DocumentToSignBinaryDocumentFileName": null,
      "NewDocumentToSignBinaryDocumentUrl": null,
      "ClearDocumentToSignBinaryDocumentFile": null,
      "DocumentToSendBinaryDocumentFileName": null,
      "NewDocumentToSendBinaryDocumentUrl": null,
      "ClearDocumentToSendBinaryDocumentFile": null,
      "ProposalFileFileName": null,
      "NewProposalFileUrl": null,
      "ClearProposalFileFile": null,
      "TariffId": 0,
      "TariffName": null,
      "TariffInvoiceEvery": null,
      "TariffInvoiceEveryWeeks": null,
      "TariffPrice": 0,
      "TariffBusinessCurrencyCode": null,
      "Desks": [],
      "Variants": [],
      "ContractTerm": null,
      "ExpirationDate": null,
      "DiscountCodeId": null,
      "StartDateLocal": null,
      "SentOn": null,
      "SentOnLocal": null,
      "CustomerLastOpenedDate": null,
      "DoNotIssueInvoice": false,
      "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": "Proposal Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Reference",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one ProposalRetrieve a single Proposal record by its Id.

Search Proposals

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

import requests

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

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/proposals', 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

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Reference

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Reference

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Reference

Range filters

Response

200