CompanyToDos
This entity describes a To-Do created by an Autotask user and associated with an Autotask Company. In Autotask, a To-Do is a scheduled item that appears on the user's Autotask calendar. It can be assigned to the creator or to another resource. It requires an Action Type and can be associated with an Opportunity, Ticket, or Contract that is associated with the same Company as the To-Do. Autotask users manage Company To Dos through the CRM module (CRM > To-Dos).
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: | CompanyToDos |
|
Entity Path: |
/atservicesrest/v1.0/CompanyToDos |
| Parent Entity: | Companies |
| Can Create: |
|
| Can Update: |
|
| Can Query: |
|
| Can Delete: |
|
| Can Have UDFs: |
Conditions and requirements
Special field attributes
| Field | Conditions and Requirements |
|---|---|
| companyID | contactID, contractID, opportunityID, and ticketID must reference a Contact, Contract, Opportunity, or Ticket entity with the same companyID as the CompanyToDo. |
| completedDate | Setting completedDate completes the to-do. The To-Do entity does not include an "isComplete" field. Use the completedDate column to query for completed To-Dos. Completed To-Dos can also be queried using the CompanyNote entity. |
| contactID | contactID must reference an isActive Autotask Contact associated with the Company referenced by the companyID field or from the parentCompany of the Company referenced by the Quote companyID. |
Field definitions
About this table
The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:
- The entityInformation REST API call
- Making basic query calls to the REST API
- Advanced query features of the REST API
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 |
|---|---|---|---|---|---|
| actionType | integer |
|
|
||
| activityDescription | string (32000) |
||||
| assignedToResourceID | long |
|
Resources | ||
| companyID | long |
|
Companies | ||
| completedDate | datetime | ||||
| contactID | long | Contacts | |||
| contractID | long | Contracts | |||
| createDateTime | datetime |
|
|||
| creatorResourceID | long |
|
Resources | ||
| endDateTime | datetime |
|
|||
| id | long |
|
|
||
| impersonatorCreatorResourceID | integer |
|
Resources |
|
|
| lastModifiedDate | datetime |
|
|||
| opportunityID | long | Opportunities | |||
| startDateTime | datetime |
|
|||
| ticketID | long | Tickets |
