Search ProposalContracts - Nexudus Platform

GET

api

billing

proposalcontracts

Search ProposalContracts

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

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

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

Query Parameters

Pagination & Sorting

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

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

dir

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

ProposalContract_Proposal

integer

Filter by iD of the proposal linked to this record.

ProposalContract_Proposal_Coworker_Id

string

Filter by proposal coworker ID.

ProposalContract_Proposal_Coworker_Email

string

Filter by proposal coworker email.

ProposalContract_Proposal_Coworker_FullName

string

Filter by proposal coworker full name.

ProposalContract_Tariff

integer

Filter by iD of the tariff linked to this record.

ProposalContract_Tariff_Name

string

Filter by tariff name.

ProposalContract_Tariff_InvoiceEvery

string

Filter by tariff invoice frequency.

ProposalContract_Tariff_InvoiceEveryWeeks

string

Filter by tariff invoice frequency in weeks.

ProposalContract_Tariff_Price

number

Filter by tariff price.

ProposalContract_Tariff_Business_Currency_Code

string

Filter by tariff business currency code.

ProposalContract_Price

number

Filter by price override.

ProposalContract_StartDate

string

Filter by contract start date.

ProposalContract_CancellationLimitDays

integer

Filter by cancellation limit in days.

ProposalContract_ContractTerm

string

Filter by contract term end date.

ProposalContract_CancellationDate

string

Filter by cancellation date.

ProposalContract_BillingDay

integer

Filter by billing day of month.

ProposalContract_Quantity

integer

Filter by number of units.

ProposalContract_DiscountCode

integer

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

ProposalContract_FloorPlanDeskIds

string

Filter by floor plan desk IDs.

ProposalContract_FloorPlanDeskNames

string

Filter by floor plan desk names.

ProposalContract_FloorPlanDeskVariantIds

string

Filter by floor plan desk variant IDs.

ProposalContract_FloorPlanDeskVariantNames

string

Filter by floor plan desk variant names.

Range Filters

from_ProposalContract_TariffPrice

number

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

to_ProposalContract_TariffPrice

number

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

from_ProposalContract_Price

number

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

to_ProposalContract_Price

number

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

from_ProposalContract_StartDate

string

Filter by contract start date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_ProposalContract_StartDate

string

Filter by contract start date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_ProposalContract_CancellationLimitDays

integer

Filter by cancellation limit in days greater than or equal to this value.

to_ProposalContract_CancellationLimitDays

integer

Filter by cancellation limit in days less than or equal to this value.

from_ProposalContract_ContractTerm

string

Filter by contract term end date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_ProposalContract_ContractTerm

string

Filter by contract term end date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_ProposalContract_CancellationDate

string

Filter by cancellation date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_ProposalContract_CancellationDate

string

Filter by cancellation date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_ProposalContract_BillingDay

integer

Filter by billing day of month greater than or equal to this value.

to_ProposalContract_BillingDay

integer

Filter by billing day of month less than or equal to this value.

from_ProposalContract_Quantity

integer

Filter by number of units greater than or equal to this value.

to_ProposalContract_Quantity

integer

Filter by number of units less than or equal to this value.

from_ProposalContract_CreatedOn

string

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

to_ProposalContract_CreatedOn

string

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

from_ProposalContract_UpdatedOn

string

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

to_ProposalContract_UpdatedOn

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"

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"

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"

Response

200

Records

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.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

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

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

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": 0,
      "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
}

Get one ProposalContractRetrieve a single ProposalContract record by its Id.

Search ProposalContracts

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

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

​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