Skip to main content
GET
/
api
/
billing
/
proposals
/
{id}
{
  "IssuedById": 123,
  "IssuedByName": "<string>",
  "IssuedByCurrencyCode": "<string>",
  "ResponsibleId": 123,
  "ResponsibleFullName": "<string>",
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "Reference": "<string>",
  "Notes": "<string>",
  "ProposalStatus": 123,
  "DocumentToSendId": 123,
  "DocumentToSignId": 123,
  "DocumentToSignHtml": "<string>",
  "DocumentToSignBinaryDocumentFileName": "<string>",
  "NewDocumentToSignBinaryDocumentUrl": "<string>",
  "ClearDocumentToSignBinaryDocumentFile": true,
  "DocumentToSendHtml": "<string>",
  "DocumentToSendBinaryDocumentFileName": "<string>",
  "NewDocumentToSendBinaryDocumentUrl": "<string>",
  "ClearDocumentToSendBinaryDocumentFile": true,
  "ProposalFileFileName": "<string>",
  "NewProposalFileUrl": "<string>",
  "ClearProposalFileFile": true,
  "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>",
  "ExpirationDate": "<string>",
  "BillingDay": 123,
  "Quantity": 123,
  "DiscountCodeId": 123,
  "StartDateLocal": "<string>",
  "SentOn": "<string>",
  "SentOnLocal": "<string>",
  "CustomerLastOpenedDate": "<string>",
  "DoNotIssueInvoice": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
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-Read role.

​
Path Parameters

​
id
integer
required
The Id of the Proposal record to retrieve.

​
Code Examples

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

​
Response

​
200

​
IssuedById
integer
Issued By Id.
​
IssuedByName
string
Issuing business name.
​
IssuedByCurrencyCode
string
Issuing business currency code.
​
ResponsibleId
integer
Responsible Id.
​
ResponsibleFullName
string
Responsible person full name.
​
CoworkerId
integer
Coworker Id.
​
CoworkerCoworkerType
string
Coworker type.
​
CoworkerFullName
string
Coworker full name.
​
CoworkerCompanyName
string
Coworker company name.
​
CoworkerBillingName
string
Coworker billing name.
​
Reference
string
Proposal reference.
​
Notes
string
Notes.
​
ProposalStatus
integer
Proposal status. See eProposalStatus enum values: 1 = Draft, 2 = Sent, 3 = Accepted, 4 = Rejected.
​
DocumentToSendId
integer
Document To Send Id.
​
DocumentToSignId
integer
Document To Sign Id.
​
DocumentToSignHtml
string
Document To Sign Html.
​
DocumentToSignBinaryDocumentFileName
string
Document To Sign Binary Document File Name.
​
NewDocumentToSignBinaryDocumentUrl
string
New Document To Sign Binary Document Url.
​
ClearDocumentToSignBinaryDocumentFile
boolean
Clear Document To Sign Binary Document File.
​
DocumentToSendHtml
string
Document To Send Html.
​
DocumentToSendBinaryDocumentFileName
string
Document To Send Binary Document File Name.
​
NewDocumentToSendBinaryDocumentUrl
string
New Document To Send Binary Document Url.
​
ClearDocumentToSendBinaryDocumentFile
boolean
Clear Document To Send Binary Document File.
​
ProposalFileFileName
string
Proposal File File Name.
​
NewProposalFileUrl
string
New Proposal File Url.
​
ClearProposalFileFile
boolean
Clear Proposal File File.
​
TariffId
integer
Tariff Id.
​
TariffName
string
Tariff name.
​
TariffInvoiceEvery
string
Tariff invoice frequency.
​
TariffInvoiceEveryWeeks
string
Tariff invoice frequency in weeks.
​
TariffPrice
number
Tariff price.
​
TariffBusinessCurrencyCode
string
Tariff business currency code.
​
Desks
integer[]
Desks.
​
Variants
integer[]
Variants.
​
Price
number
Price override for the initial contract. Becomes read-only after creation; edit via ProposalContract.
​
StartDate
string
Start date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
​
CancellationLimitDays
integer
Cancellation limit in days for the initial contract. Becomes read-only after creation; edit via ProposalContract.
​
ContractTerm
string
Contract term end date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
​
CancellationDate
string
Cancellation date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
​
ExpirationDate
string
Proposal expiration date. Becomes read-only after creation; edit via ProposalContract.
​
BillingDay
integer
Billing day of month for the initial contract. Becomes read-only after creation; edit via ProposalContract.
​
Quantity
integer
Quantity for the initial contract. Becomes read-only after creation; edit via ProposalContract.
​
DiscountCodeId
integer
Discount Code Id.
​
StartDateLocal
string
Start Date Local.
​
SentOn
string
Date the proposal was sent.
​
SentOnLocal
string
Sent On Local.
​
CustomerLastOpenedDate
string
Date the customer last opened the proposal.
​
DoNotIssueInvoice
boolean
If true, the first invoice is not issued automatically when the proposal is accepted.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "IssuedById": 0,
  "IssuedByName": null,
  "IssuedByCurrencyCode": null,
  "ResponsibleId": 0,
  "ResponsibleFullName": null,
  "CoworkerId": 0,
  "CoworkerCoworkerType": null,
  "CoworkerFullName": null,
  "CoworkerCompanyName": null,
  "CoworkerBillingName": null,
  "Reference": "",
  "Notes": null,
  "ProposalStatus": 0,
  "DocumentToSendId": null,
  "DocumentToSignId": null,
  "DocumentToSignHtml": null,
  "DocumentToSignBinaryDocumentFileName": null,
  "NewDocumentToSignBinaryDocumentUrl": null,
  "ClearDocumentToSignBinaryDocumentFile": null,
  "DocumentToSendHtml": 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": [],
  "Price": null,
  "StartDate": null,
  "CancellationLimitDays": null,
  "ContractTerm": null,
  "CancellationDate": null,
  "ExpirationDate": null,
  "BillingDay": 0,
  "Quantity": 0,
  "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
}