Search ContractProducts - Nexudus Platform

GET

api

billing

contractproducts

Search ContractProducts

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/contractproducts \
  --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 ContractProduct is a product added to a contract that is billed every time the contract is invoiced. Use ContractProduct to append product charges to a specific member’s billing cycle alongside the base plan. Price — If Price is not set, the price of the underlying product (ProductPrice) is used instead. Set Price to override the product’s default price for this specific contract line. Billing window — RepeatFrom and RepeatUntil control the date range during which the product is included on invoices. Outside that range the product is silently skipped. Leave both null to bill the product on every invoice. Pro-rating — ApplyProRating distributes the charge proportionally across the billing period, but only takes effect when the linked location plan has prorating enabled (Tariff.ProrateDaysBefore > 0). If the plan does not have prorating configured, ApplyProRating is ignored.

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 ContractProduct-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

ContractProduct_CoworkerContract

integer

Filter by contract to add this product to.

ContractProduct_CoworkerContract_Quantity

integer

Filter by quantity associated with the contract.

ContractProduct_CoworkerContract_FloorPlanDeskIds

string

Filter by floor plan desk IDs assigned to the contract.

ContractProduct_CoworkerContract_FloorPlanDeskNames

string

Filter by floor plan desk names assigned to the contract.

ContractProduct_CoworkerContract_Tariff_Name

string

Filter by coworker contract tariff name.

ContractProduct_CoworkerContract_Coworker_Id

integer

Filter by iD of the member on the contract.

ContractProduct_CoworkerContract_Coworker_FullName

string

Filter by contract coworker full name.

ContractProduct_CoworkerContract_Coworker_BillingName

string

Filter by contract coworker billing name.

ContractProduct_Product

integer

Filter by product to bill on each contract invoice.

ContractProduct_Product_Name

string

Filter by product name.

ContractProduct_Product_Price

number

Filter by product price.

ContractProduct_Product_ApplyProRating

boolean

Filter by whether the underlying product applies pro-rating by default.

ContractProduct_Product_Currency_Code

string

Filter by product currency code.

ContractProduct_Notes

string

Filter by notes.

ContractProduct_Quantity

integer

Filter by quantity.

ContractProduct_Price

number

Filter by price override.

ContractProduct_RepeatFrom

string

Filter by repeat from date.

ContractProduct_RepeatUntil

string

Filter by repeat until date.

ContractProduct_ApplyProRating

boolean

Filter by apply pro-rating to this product charge. Only takes effect when the location plan has prorating enabled (Tariff.ProrateDaysBefore > 0)..

Range Filters

from_ContractProduct_CoworkerContractQuantity

integer

Filter by quantity associated with the contract greater than or equal to this value.

to_ContractProduct_CoworkerContractQuantity

integer

Filter by quantity associated with the contract less than or equal to this value.

from_ContractProduct_CoworkerContractCoworkerId

integer

Filter by iD of the member on the contract greater than or equal to this value.

to_ContractProduct_CoworkerContractCoworkerId

integer

Filter by iD of the member on the contract less than or equal to this value.

from_ContractProduct_ProductPrice

number

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

to_ContractProduct_ProductPrice

number

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

from_ContractProduct_Quantity

integer

Filter by quantity greater than or equal to this value.

to_ContractProduct_Quantity

integer

Filter by quantity less than or equal to this value.

from_ContractProduct_Price

number

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

to_ContractProduct_Price

number

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

from_ContractProduct_RepeatFrom

string

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

to_ContractProduct_RepeatFrom

string

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

from_ContractProduct_RepeatUntil

string

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

to_ContractProduct_RepeatUntil

string

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

from_ContractProduct_CreatedOn

string

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

to_ContractProduct_CreatedOn

string

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

from_ContractProduct_UpdatedOn

string

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

to_ContractProduct_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/contractproducts?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/contractproducts?ContractProduct_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

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

Response

200

Records

ContractProduct[]

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

Partial records — The listing endpoint returns a summary representation of each ContractProduct. The following fields are not populated in the Records[] response: Notes.To get all fields, fetch the full record using the Get one ContractProduct 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": [
    {
      "CoworkerContractId": 0,
      "CoworkerContractQuantity": null,
      "CoworkerContractFloorPlanDeskIds": null,
      "CoworkerContractFloorPlanDeskNames": null,
      "CoworkerContractTariffName": null,
      "CoworkerContractCoworkerId": null,
      "CoworkerContractCoworkerFullName": null,
      "CoworkerContractCoworkerBillingName": null,
      "ProductId": 0,
      "ProductName": null,
      "ProductPrice": 0,
      "ProductApplyProRating": null,
      "ProductCurrencyCode": null,
      "Quantity": 0,
      "Price": null,
      "RepeatFrom": null,
      "RepeatUntil": null,
      "ApplyProRating": 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": "ContractProduct 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 ContractProductRetrieve a single ContractProduct record by its Id.

Search ContractProducts

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/contractproducts \
  --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
}

Documentation Index

​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