Update ContractDeposit

PUT

api

billing

contractdeposits

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Id: 123, 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>"
    }
  ]
}

Updates an existing ContractDeposit record. You must include the Id of the record to update along with all required fields.

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

Request Body

Required Fields

integer

required

The Id of the ContractDeposit record to update.

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 PUT \
  "https://spaces.nexudus.com/api/billing/contractdeposits" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerContractId": 0,
    "ProductId": 0,
    "Id": 87654321
}'

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

const data = await response.json();

import requests

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

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the contractdeposit was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ContractDeposit was successfully updated.",
  "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
}

Delete ContractDepositDelete an existing ContractDeposit record by its Id.

Update ContractDeposit

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Id: 123, 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