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

Request Body

Required Fields

integer

required

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

integer

required

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

Optional Fields

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 this deposit is charged during the customer’s online checkout instead of waiting for the contract’s next eligible invoice..

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
}

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