Create ContractDeposit

POST

api

billing

contractdeposits

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/contractdeposits \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerContractId": 123,
  "ProductId": 123
}
'

import requests

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

payload = {
    "CoworkerContractId": 123,
    "ProductId": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({CoworkerContractId: 123, ProductId: 123})
};

fetch('https://spaces.nexudus.com/api/billing/contractdeposits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create role.

Request Body

Required Fields

integer

required

ID of the coworker contract linked to this record.

integer

required

ID of the product linked to this record.

Optional Fields

string

Optional notes or internal comments about this deposit.

number

Deposit amount to charge. When set, overrides the default price of the linked product.

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.

boolean

Whether invoice during online checkout is enabled.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/contractdeposits" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerContractId": 0,
    "ProductId": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/contractdeposits',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CoworkerContractId: 0,
      ProductId: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/contractdeposits',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerContractId': 0,
        'ProductId': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the contractdeposit was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ContractDeposit was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Update ContractDepositUpdate an existing ContractDeposit record.

Create ContractDeposit

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/contractdeposits \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerContractId": 123,
  "ProductId": 123
}
'

import requests

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

payload = {
    "CoworkerContractId": 123,
    "ProductId": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({CoworkerContractId: 123, ProductId: 123})
};

fetch('https://spaces.nexudus.com/api/billing/contractdeposits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400