ContractNotes

This entity describes a note associated with an Autotask Contract. Notes are used to track information, update the status of the associated contract, and communicate with resources and customers. In Autotask, you create and manage Contract Notes from the Options or Notes features found on the Contract Summary page in the Contract module.

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: ContractNotes

Entity Path:

/atservicesrest/v1.0/ContractNotes
Can Create:
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

IMPORTANT  Requests to this entity require special handling. Refer to the Entity URLs and relationships section of this article for details.

Conditions and requirements

General

  • Resource with limited contract view permissions can create and update ContractNotes, but only if their Autotask resourceID = ContractNote.creatorResourceID.

Special field attributes

Field Conditions and Requirements
description

When you use the API to update this field, the REST API will return the text-only version of its content. If you send the content back, the Rich Text and all images that it contains will be lost. You cannot use the API to create items that contain Rich Text, but you can add Rich Text later via a supported method.

To learn more, refer to The Rich Text editor.

Field definitions

Field Name Datatype Read-Only Is Required Reference Name Picklist
contractID integer Contracts  
createDateTime datetime      
creatorResourceID integer   Resources  
description string (8000)      
id integer    
impersonatorCreatorResourceID integer   Resources  
impersonatorUpdaterResourceID integer   Resources  
lastActivityDate datetime      
title string (250)      

Additional resources