Get multiple Proposals

GET

api

billing

proposals

?id=[

{id1}

{id2}

{id3}

]

Get multiple Proposals

curl --request GET \
  --url 'https://spaces.nexudus.com/api/billing/proposals/?id=%5B{id1}%2C{id2}%2C{id3}%5D' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/billing/proposals/?id=%5B{id1}%2C{id2}%2C{id3}%5D"

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/?id=%5B{id1}%2C{id2}%2C{id3}%5D', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Fetch several Proposal records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

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

Query Parameters

integer[]

required

A comma-separated list of Proposal Ids enclosed in square brackets, e.g. [123,456,789].

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/billing/proposals/?id=[87654321,87654322,87654323]" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/proposals/?id=[87654321,87654322,87654323]',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const records = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/proposals/',
    params={
        'id': '[87654321,87654322,87654323]'
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

records = response.json()

Response

200

Returns an array of Proposal records. Each record has the same structure as the response from the Get one Proposal endpoint.

Partial records — This endpoint returns a summary representation of each Proposal. The following fields are not populated in the 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 this endpoint as the base for a PUT request, as missing fields may be unintentionally cleared.

Example Response

[
  {
    "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
  }
]

Create ProposalCreate a new Proposal record.

Get multiple Proposals

curl --request GET \
  --url 'https://spaces.nexudus.com/api/billing/proposals/?id=%5B{id1}%2C{id2}%2C{id3}%5D' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/billing/proposals/?id=%5B{id1}%2C{id2}%2C{id3}%5D"

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/?id=%5B{id1}%2C{id2}%2C{id3}%5D', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

Code Examples

Response

200

​Authentication

​Query Parameters

​Code Examples

​Response

​200

Authentication

Query Parameters

Code Examples

Response

200