ContractNote
IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will be deactivated.
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.
Entity details
You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.
| Entity Name: | ContractNote |
| Can Create: |
|
| Can Update: |
|
| Can Query: |
|
| Can Delete: | |
| Can Have UDFs: |
Conditions and requirements
General
- Resources with limited contract view permissions can create and update the ContractNote entity, 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
About this table
The following table describes the standard Autotask field objects for this entity.
- To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
- For information on entity UDFs, use getUDFInfo().
- For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
- LT indicates Local Term.
For more information about fields marked as picklists, review our Understanding picklists article.
| Field Name | Label | Datatype | Read Only | Is Required | Reference Name | Picklist |
|---|---|---|---|---|---|---|
| ContractID | Contract ID | integer |
|
|
Contract | |
| CreateDateTime | Create Date Time | datetime |
|
|||
| CreatorResourceID | Resource ID | integer |
|
Resource | ||
| Description | Journal | string (8000) |
|
|||
| id | id | integer |
|
|
||
| LastActivityDate | Date Added | datetime |
|
|||
| Title | Title | string (250) |
|
|||
| ImpersonatorCreatorResourceID | Impersonator Creator Resource ID | integer |
|
Resource | ||
| ImpersonatorUpdaterResourceID | Impersonator Updater Resource ID | integer |
|
Resource |
