Search ContractDeposits

GET

api

billing

contractdeposits

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

import requests

url = "https://spaces.nexudus.com/api/billing/contractdeposits"

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/contractdeposits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

A contract deposit (internally ContractDeposit) is a one-time product charge attached to a customer’s contract, normally created from a plan’s sign-up products. Creating a new contract from a plan with sign-up products creates one deposit for each product and sets the contract’s IncludeSignupFee flag to true. Deposits are charged on the next eligible contract invoice only while IncludeSignupFee is true; that invoicing run then resets the flag to false. A deposit marked InvoiceDuringOnlineCheckout is instead charged during the customer’s online checkout. A refundable deposit can be processed through the dedicated refund workflow after the contract ends.

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

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

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

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the customer’s contract; it determines this deposit’s location, customer, plan, and invoice cycle..

integer

Filter by display value for CoworkerContract.Quantity..

string

Filter by display value for CoworkerContract.FloorPlanDeskIds..

string

Filter by display value for CoworkerContract.FloorPlanDeskNames..

string

Filter by display value for CoworkerContract.Tariff.Name..

integer

Filter by display value for CoworkerContract.Coworker.Id..

string

Filter by display value for CoworkerContract.Coworker.FullName..

string

Filter by display value for CoworkerContract.Coworker.BillingName..

integer

Filter by iD of the location product charged for this deposit; its current price is used when Price is null..

string

Filter by display value for Product.Name..

number

Filter by display value for Product.Price..

string

Filter by display value for Product.Currency.Code..

string

Filter by optional operator notes about this deposit..

number

Filter by optional deposit amount in the location’s currency; when null, the linked product’s current price is used..

boolean

Filter by whether cancelling the contract makes this deposit eligible for the dedicated refund workflow, which creates a negative sale that can be included in a credit note..

boolean

Filter by whether the invoicing process has charged this deposit; it is set during online checkout or when the contract’s next eligible invoice is generated with IncludeSignupFee = true..

boolean

Filter by whether the dedicated refund workflow has created a negative sale for this refundable deposit..

string

Filter by read-only UTC date and time when the invoicing process charged this deposit..

boolean

Filter by whether this deposit is charged during the customer’s online checkout instead of waiting for the contract’s next eligible invoice..

Range Filters

integer

Filter by display value for CoworkerContract.Quantity. greater than or equal to this value.

integer

Filter by display value for CoworkerContract.Quantity. less than or equal to this value.

integer

Filter by display value for CoworkerContract.Coworker.Id. greater than or equal to this value.

integer

Filter by display value for CoworkerContract.Coworker.Id. less than or equal to this value.

number

Filter by display value for Product.Price. greater than or equal to this value.

number

Filter by display value for Product.Price. less than or equal to this value.

number

Filter by optional deposit amount in the location’s currency; when null, the linked product’s current price is used. greater than or equal to this value.

number

Filter by optional deposit amount in the location’s currency; when null, the linked product’s current price is used. less than or equal to this value.

string

Filter by read-only UTC date and time when the invoicing process charged this deposit. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC date and time when the invoicing process charged this deposit. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

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

string

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

string

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

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/contractdeposits?page=1&size=15&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/contractdeposits?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'CreatedOn',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/contractdeposits',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'CreatedOn',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/billing/contractdeposits?ContractDeposit_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/contractdeposits?' + new URLSearchParams({
    ContractDeposit_CreatedOn: 'example-value',
    orderBy: 'CreatedOn',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/contractdeposits',
    params={
        'ContractDeposit_CreatedOn': 'example-value',
        'orderBy': 'CreatedOn',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

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

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/contractdeposits?' + new URLSearchParams({
    from_ContractDeposit_UpdatedOn: '2025-01-01T00:00',
    to_ContractDeposit_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/contractdeposits',
    params={
        'from_ContractDeposit_UpdatedOn': '2025-01-01T00:00',
        'to_ContractDeposit_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

ContractDeposit[]

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

Partial records — The listing endpoint returns a summary representation of each ContractDeposit. The following fields are not populated in the Records[] response: Notes.To get all fields, fetch the full record using the Get one ContractDeposit 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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

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

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

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": null,
      "ProductCurrencyCode": null,
      "Price": null,
      "Refundable": false,
      "Invoiced": false,
      "Credited": false,
      "InvoicedOn": null,
      "InvoiceDuringOnlineCheckout": 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": "ContractDeposit 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
}

Search ContractDeposits

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

import requests

url = "https://spaces.nexudus.com/api/billing/contractdeposits"

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/contractdeposits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

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

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200