Skip to main content
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>'
{
  "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

​
id
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"

​
Response

​
200

​
ProposalId
integer
ID of the proposal linked to this record.
​
ProposalCoworkerId
string
Proposal coworker ID.
​
ProposalCoworkerEmail
string
Proposal coworker email.
​
ProposalCoworkerFullName
string
Proposal coworker full name.
​
TariffId
integer
ID of the tariff linked to this record.
​
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[]
List of desks linked to this record.
​
Variants
integer[]
List of variants linked to this record.
​
Price
number
Price override.
​
StartDate
string
Contract start date.
​
CancellationLimitDays
integer
Cancellation limit in days.
​
ContractTerm
string
Contract term end date.
​
CancellationDate
string
Cancellation date.
​
BillingDay
integer
Billing day of month.
​
Quantity
integer
Number of units.
​
DiscountCodeId
integer
ID of the discount code linked to this record.
​
FloorPlanDeskIds
string
Floor plan desk IDs.
​
FloorPlanDeskNames
string
Floor plan desk names.
​
FloorPlanDeskVariantIds
string
Floor plan desk variant IDs.
​
FloorPlanDeskVariantNames
string
Floor plan desk variant names.
​
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
{
  "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
}