Get one ContractDeposit

GET

api

billing

contractdeposits

{id}

Get one ContractDeposit

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

import requests

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

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

{
  "CoworkerContractId": 123,
  "CoworkerContractQuantity": 123,
  "CoworkerContractFloorPlanDeskIds": "<string>",
  "CoworkerContractFloorPlanDeskNames": "<string>",
  "CoworkerContractTariffName": "<string>",
  "CoworkerContractCoworkerId": 123,
  "CoworkerContractCoworkerFullName": "<string>",
  "CoworkerContractCoworkerBillingName": "<string>",
  "ProductId": 123,
  "ProductName": "<string>",
  "ProductPrice": 123,
  "ProductCurrencyCode": "<string>",
  "Notes": "<string>",
  "Price": 123,
  "Refundable": true,
  "Invoiced": true,
  "Credited": true,
  "InvoicedOn": "<string>",
  "InvoiceDuringOnlineCheckout": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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

Path Parameters

integer

required

The Id of the ContractDeposit record to retrieve.

Code Examples

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

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/contractdeposits/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/contractdeposits/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

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

integer

Display value for CoworkerContract.Quantity..

string

Display value for CoworkerContract.FloorPlanDeskIds..

string

Display value for CoworkerContract.FloorPlanDeskNames..

string

Display value for CoworkerContract.Tariff.Name..

integer

Display value for CoworkerContract.Coworker.Id..

string

Display value for CoworkerContract.Coworker.FullName..

string

Display value for CoworkerContract.Coworker.BillingName..

integer

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

string

Display value for Product.Name..

number

Display value for Product.Price..

string

Display value for Product.Currency.Code..

string

Optional operator notes about this deposit..

number

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

boolean

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

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

Whether the dedicated refund workflow has created a negative sale for this refundable deposit..

string

Read-only UTC date and time when the invoicing process charged this deposit..

boolean

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

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "CoworkerContractId": 0,
  "CoworkerContractQuantity": null,
  "CoworkerContractFloorPlanDeskIds": null,
  "CoworkerContractFloorPlanDeskNames": null,
  "CoworkerContractTariffName": null,
  "CoworkerContractCoworkerId": null,
  "CoworkerContractCoworkerFullName": null,
  "CoworkerContractCoworkerBillingName": null,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": null,
  "ProductCurrencyCode": null,
  "Notes": 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
}

Get one ContractDeposit

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

import requests

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

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

{
  "CoworkerContractId": 123,
  "CoworkerContractQuantity": 123,
  "CoworkerContractFloorPlanDeskIds": "<string>",
  "CoworkerContractFloorPlanDeskNames": "<string>",
  "CoworkerContractTariffName": "<string>",
  "CoworkerContractCoworkerId": 123,
  "CoworkerContractCoworkerFullName": "<string>",
  "CoworkerContractCoworkerBillingName": "<string>",
  "ProductId": 123,
  "ProductName": "<string>",
  "ProductPrice": 123,
  "ProductCurrencyCode": "<string>",
  "Notes": "<string>",
  "Price": 123,
  "Refundable": true,
  "Invoiced": true,
  "Credited": true,
  "InvoicedOn": "<string>",
  "InvoiceDuringOnlineCheckout": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200