Skip to main content
GET
/
api
/
billing
/
contractdeposits
/
{id}
{
  "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>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A ContractDeposit represents a security deposit or retainer associated with a plan contract (CoworkerContract). Each deposit is based on a Product and is charged to the member either on the first invoice generated for the contract, or on the next invoice for any contract that has IncludeSignupFee = true. ContractDeposits are created automatically when a contract is signed for a plan (Tariff) that includes one or more TariffSignupProducts. Each TariffSignupProduct on the plan becomes a corresponding ContractDeposit on the new contract. When Refundable = true, cancelling the parent contract automatically generates a credit note for the deposit amount. That credit note can then be applied — fully or partially — against any outstanding fees or damage charges raised via a separate invoice.

​
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

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

​
Response

​
200

​
CoworkerContractId
integer
Coworker Contract Id.
​
CoworkerContractQuantity
integer
Coworker Contract Quantity.
​
CoworkerContractFloorPlanDeskIds
string
Coworker Contract Floor Plan Desk Ids.
​
CoworkerContractFloorPlanDeskNames
string
Coworker Contract Floor Plan Desk Names.
​
CoworkerContractTariffName
string
Name of the tariff/plan associated with the parent contract.
​
CoworkerContractCoworkerId
integer
Coworker Contract Coworker Id.
​
CoworkerContractCoworkerFullName
string
Full name of the member holding the parent contract.
​
CoworkerContractCoworkerBillingName
string
Billing name of the member holding the parent contract.
​
ProductId
integer
Product Id.
​
ProductName
string
Name of the product this deposit is based on.
​
ProductPrice
number
Default price of the underlying product (used when Price is not overridden).
​
ProductCurrencyCode
string
ISO currency code of the underlying product.
​
Notes
string
Optional notes or internal comments about this deposit.
​
Price
number
Deposit amount to charge. When set, overrides the default price of the linked product.
​
Refundable
boolean
When true, cancelling the parent contract automatically generates a credit note for the deposit amount, which can be applied against outstanding fees or damages.
​
Invoiced
boolean
True once the deposit has been included in an invoice (either the first contract invoice or the next invoice when IncludeSignupFee = true on the contract).
​
Credited
boolean
True once a credit note has been issued for this refundable deposit following contract cancellation.
​
InvoicedOn
string
Date and time when the deposit was included in an invoice.
​
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
{
  "CoworkerContractId": 0,
  "CoworkerContractQuantity": null,
  "CoworkerContractFloorPlanDeskIds": null,
  "CoworkerContractFloorPlanDeskNames": null,
  "CoworkerContractTariffName": null,
  "CoworkerContractCoworkerId": null,
  "CoworkerContractCoworkerFullName": null,
  "CoworkerContractCoworkerBillingName": null,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": 0,
  "ProductCurrencyCode": null,
  "Notes": null,
  "Price": null,
  "Refundable": false,
  "Invoiced": false,
  "Credited": false,
  "InvoicedOn": 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": "ContractDeposit Example",
  "LocalizationDetails": null,
  "CustomFields": null
}