ContractRetainers

This entity describes a payment amount applied to a Retainer type contract and sets the time period covered by the purchase. For example, a retainer purchase of $500 can be applied to three months of the Retainer contract.

The retainer balance is reduced by services performed at the contract rates, which can be the same or different from the standard billing rates. In addition, Project and Ticket Costs can be deducted from a Retainer contract. The contract maintains the balance of dollars.

NOTE  You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.

Entity details

Entity Name: ContractRetainers

Entity Path:

/atservicesrest/v1.0/ContractRetainers
Parent Entity: Contracts
Can Create:
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

Fields that cannot be queried

The following fields from this entity will return an error when queried.

  • amountApproved

Conditions and requirements

General

  • Resources with security levels that specify limited or no contract visibility cannot create, update, or query this entity.

Special field attributes

Field Conditions and Requirements
Amount

For update, ContractRetainer.Amount must be >= Amount Approved.

If the multi-currency Installed Module is enabled, this field will return the relevant Customer Currency value instead of the Internal Currency value.
amountApproved If the multi-currency Installed Module is enabled, this field will return the relevant Customer Currency value instead of the Internal Currency value.
contractID ContractRetainer.contractID must reference a Retainer type Contract.
DatePaid DatePaid is read-only and defaults to Null. And changes in value are triggered automatically.
internalCurrencyAmount, internalCurrencyAmountApproved The internalCurrencyAmount and internalCurrencyAmountApproved fields will return the saved Internal Currency values.
isPaid

isPaid is Read-Only. It is not required. On create the value defaults to 0. Any changes in value are triggered automatically.
startDate startDate must be < endDate
startDate, endDate

ContractRetainer.startDate and ContractRetainer.endDate must be between the startDate and endDate of the contract referenced by ContractRetainer.contractID; that is, in Autotask the Retainer purchase must start and end within the Contract start and end dates.

startDate and endDate only support date values. The API will not store non-date values (such as time) in these fields.

Field definitions

The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:

To learn how to query picklist endpoints, refer to Understanding picklists.

Notes

  • For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.
  • If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
  • You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name Datatype Read-Only Is Required Reference Name Picklist
amount decimal      
amountApproved decimal      
contractID integer Contracts  
datePurchased datetime      
endDate datetime      
id integer    
internalCurrencyAmount (Multi-currency module only) decimal      
internalCurrencyAmountApproved (Multi-currency module only) decimal      
invoiceNumber string (50)        
isPaid boolean      
paymentID integer      
paymentNumber string (50)        
startDate datetime      
status integer    

Additional resources