Autotask icon

Autotask

Interact with Kaseya's Autotask PSA REST API to manage companies, tickets, contracts, and more.

Actions524

Contract Retainer → Create

AI-generated

Overview

This node operation creates a new Contract Retainer in the Autotask PSA system. It is useful for automating the addition of contract retainers, which are financial arrangements or agreements related to contracts, directly from workflows. For example, a business can use this node to programmatically add retainers to contracts when certain conditions are met, such as after a contract is approved or a client signs an agreement.

Use Case Examples

  1. Automatically create a contract retainer when a new contract is created in the system.
  2. Add a retainer to a contract as part of a billing or project setup workflow.

Properties

Name Meaning
Dry Run Whether to return a request preview instead of executing the operation. Useful for testing and validation.
Fields The fields to map for the contract retainer creation. This allows specifying the data to be sent to Autotask for the new contract retainer.

Output

JSON

  • id - The unique identifier of the created contract retainer.
  • contractId - The ID of the contract to which the retainer is associated.
  • amount - The amount specified for the contract retainer.
  • status - The status of the contract retainer after creation.
  • createdDate - The date and time when the contract retainer was created.

Dependencies

  • Autotask PSA REST API
  • API authentication credentials

Troubleshooting

  • Ensure API credentials are correctly configured and have permissions to create contract retainers.
  • If 'Dry Run' is enabled, no changes will be made; disable it to perform actual creation.
  • Check for required fields in the 'Fields' mapping to avoid validation errors from the API.
  • Common errors include authentication failures, missing required fields, or invalid field values. Verify the input data and API access.

Links

Discussion