Autotask REST API resources
This article provides a general technical overview and index of the resources (entities) that you can access via the Autotask REST API.
Overview
The Autotask REST API presents selected Autotask resources as programming objects that allow the client to perform actions on them.
Currently, the API provides the following actions: GET, PUT, PATCH, POST, and DELETE. The allowed actions are specific to the object. For example, although the client can create certain resources, not all resources accept a create call. Some resources contain additional objects in child collections; these resources have an additional Child collection access URLs field in their Online Help articles.
IMPORTANT Although you can query all resources, some objects contain fields that you cannot query. Refer to the About entity fields section of this article for more information.
Each entity type object contains an array of properties that describe instances of the entity type. The properties represent data fields. The client can access and act on the entity's field parameters: supplying, updating, or deleting the field data. The allowed actions are specific to the field. For example, when updating an entity, you may not be able to update all fields within the entity. When querying, a small number of entities contain fields that you cannot query. You can find these fields in the entity description under 'Fields that Cannot Be Queried.'
For information about the currently-available entities and fields, consult the individual descriptions in the section of this article. Be aware that some field data, such as picklist values and user-defined fields, may vary between Autotask implementations and cannot be provided in this document. To obtain complete field information specific to your Autotask implementation, use the GET API calls described in the resource and child collection access URLs section of this document.
NOTE The Autotask REST API stores and returns all entity time data in Coordinated Universal Time (UTC). To learn more, refer to our Autotask REST API calls > Timestamp format article.
The id field belongs to each entity and acts as the unique identifier. The id value is set by the system and cannot be changed by the user; for example, if you attempt to specify a value for the id field when using the POST API call, the create will fail.
For the Autotask REST API, the Read-Only and Required field attributes have the following meanings:
- Read-Only: Read-Only fields cannot be changed by PUT or PATCH calls, and will be ignored by the API if a call contains them.
- Required: Required fields must be present when you attempt a POST call.
It is possible for a field to be both Read-Only and Required. Some Read-Only fields must be supplied for a create, so while they are initially required, once the entity has been created, you cannot change them.
Unless otherwise noted, API entities do not support the creation or editing of Rich Text content. If an unsupported entity receives a request to update a field that contains Rich Text, the API will update the text-only version of the field and overwrite the data in the Rich Text field with plain text.
When querying a field that has Rich Text, the API will return the text-only version of the field. If the user sends content back to an unsupported entity, the Rich Text and all images 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.
For a list of all currently available entities, refer to the , or check the Online Help's table of contents. The Entities list provides a link to additional information about the entity and its standard Autotask fields.
Each entity description includes the following information:
- Which actions can be performed on the entity.
Note that actions are governed by the permissions of the logged-in end user; for example, although a Company entity allows a create call, the logged-in end user may not have permission to create a Company entity.
- A listing of Fields that Cannot Be Queried, where applicable.
- A table that lists all standard Autotask fields by Field Name and provides the following information for each field: Field Name, Data Type, Read-Only, Is Required, Reference Name (provided only if the field is a reference), Picklist, and Picklist Parent Column Name (only if the field is a picklist child). Can Query is not included because non-queryable fields are listed under a separate heading. Refer to the previous bullet point.
To obtain extended information about entities and their field data, use the GET API call. Resource access URLs for all entities appear in the next section of this article.
For child collection access URLs and specific entity names, refer to the individual articles linked in the List of Entities section of this article.
Some entities support file attachments. For more information about attachments, including call syntax, thresholds and limits, and a full list of attachment entities, refer to Working with attachments in the REST API.
To make calls to the entities of the Autotask REST API, you will need to use their resource access URLs or child collection access URLs. Refer to Finding resource and child access URLs of REST API entities to learn how to locate these paths.
You can configure API Only security levels to allow the impersonation of other resources on supported endpoints. The API will set the impersonated user’s name and impersonatorCreatorResourceID value as the content creator during create operations. This data will not change during update operations.
You'll need to ensure that you configure the security level of the impersonated resource to allow impersonation. The impersonated resource must have permission to act as configured in the other sections on the Edit Security Level page.
You can individually configure the following entities to allow querying, adding, editing, and deleting (bold items only):
- AttachmentInfo
- Company
- CompanyNote
- CompanyToDo
- Contact
- ContractNote
- ConfigurationItem
- ConfigurationItemNote
- InventoryItem
- InventoryLocation
- Opportunitiy
- Product
- ProductNote
- Projects
- ProjectNote
- PurchaseOrder
- Quote
- SalesOrder
- ServiceCall
- Subscription
- TaskNote
- Ticket
- TicketNote
- TimeEntry
For more information about impersonation security levels, refer to Allow impersonation of resources with this security level.
If you want your integration users' names to show on the entity, follow these steps:
- You must add the id of the person to impersonate as a header on the request with the ImpersonationResourceId key value.
- Both the integration user and the API-only user must have security level permission to add or edit the entity.
- The integration user's security level must allow impersonation of the resource.
- The API-only user's security level must allow impersonation on the entity type.
Example: Impersonation
This example adds an impersonated user to a request's headers.
Username "apiuser@example.com"
Secret "abc123"
APIIntegrationcode "ASHJKLFDKAHKASLFH85LSA905H"
ContentType "application/json"
ImpersonationResourceId 2635
The API currently exposes the following entities. Each of the entities inherits from the Autotask base class Entity.
Entity | Description | Supports webhooks? |
---|---|---|
ActionTypes | This entity describes an Action Type assigned to a CRM Note or To-Do. The Action Type specifies the type of activity scheduled by the to-do or associated with the note and the actionType View controls where the Note or To-do appears in the user interface. | |
AdditionalInvoiceFieldValues | The function of this entity is to describe the values for custom Additional Invoice Fields that users can add to Autotask for use with Autotask Invoice Templates. Invoice templates define the appearance and content of an invoice generated by Autotask. | |
Appointments | This entity describes an Autotask Appointment, a scheduled calendar time that is not a service call. | |
ArticleAttachments | This entity contains attachments for Knowledgebase articles in Autotask. |
|
ArticleConfigurationItemCategoryAssociations | The assets associated with Knowledgebase articles are recorded in this entity. |
|
ArticleNotes | This entity contains notes for Knowledgebase articles in Autotask. |
|
ArticlePlainTextContent | The ArticlePlainTextContent entity contains the plain text version of body content held by a Knowledgebase article. |
|
ArticleTagAssociations | This entity records existing associations between tags and Knowledgebase articles in Autotask. |
|
ArticleTicketAssociations | The ArticleTicketAssociations entity records existing associations between tickets and Knowledgebase articles in Autotask. |
|
ArticleToArticleAssociations | This entity represents associations between Knowledgebase articles within Autotask. |
|
ArticleToDocumentAssociations | This entity represents articles associated with Knowledgebase documents in Autotask. |
|
AttachmentInfo (REST API) | This entity describes an Attachment in Autotask. Attachments are external documents that are associated with an Autotask Account, Task, Ticket, Task or Ticket Note, Time Entry, Asset, Asset Note, Project, or Opportunity entity. | |
BillingCodes |
This entity describes an Autotask Allocation Code. An allocation code represents one of six billing item categories: Work Types and Internal Allocation Codes (Admin > Company Setup), Material Cost Codes and Product Codes (Admin > Products & Services > Products), Milestone Codes (Admin > Contracts), and Recurring Contract Service Codes (Admin > Products and Services > Services). | |
BillingItemApprovalLevels | This entity's purpose is to describe a multi-level approval record for an Autotask time entry. It allows developers to use the API to implement multi-tier approval for Autotask time entries. It is only available through the REST API. | |
BillingItems | This entity describes an approved and posted billable item in Autotask. A billing item may or may not be included in an invoice and billed to the customer. | |
ChangeOrderCharges | This entity's purpose is to describe a cost associated with a Change Order to an Autotask Project. A cost is a billing item for products or materials. Cost items can be billable or non-billable. Billable cost items appear in Approve and Post. | |
ChangeRequestLinks | The function of this entity is to describe the associations between Change Request tickets and both Incidents and Problems. Change request tickets are part of the Autotask Change Management feature set. | |
ChecklistLibraries | This entity's purpose is to describe a modular component that can be added to any ticket or task. It outlines the steps that must be performed to complete the ticket or task. It also tracks the resource and date & time each step was completed. | |
ChecklistLibraryChecklistItems | This entity describes list items added to a check list on an Autotask ticket or task. | |
ClassificationIcons | This entity describes visual identifiers that you can use to categorize and search for Companies. | |
ClientPortalUsers | This entity describes an Autotask Company Contact that has access permissions for the Client Access Portal. | |
ComanagedAssociations | The function of this entity is to describe the link between co-managed accounts and the resources with a co-managed security level who have access to them. | |
Companies | This entity describes an Autotask Company. It represents any organization with which you do business. | |
CompanyAlerts | This entity's purpose is to describe a configurable alert message, associated with an account, that appears on different account-related pages. | |
This entity contains attachments for the Companies entity. |
|
|
CompanyCategories | This entity represents company (account) categories in Autotask. A company's category determines the layout of the entity's pages, which fields are visible, and which picklist options are available. | |
CompanyLocations | This entity describes an individual business unit that has an association with a company in Autotask. It can be a separate physical location or a division or agency operating in the same physical location as the company. The company handles all billing for the business unit. | |
This entity contains the attachments for the CompanyNotes entity. |
|
|
CompanyNotes | This entity's role is to describe any sort of note created by an Autotask user and associated with a Company entity as opposed to a Ticket Note. | |
CompanySiteConfigurations | This entity takes on the UDFs that hold the site setup information for the Company represented by companyID. | |
CompanyTeams | The function of this entity is to describe the resources associated with a Company Team. In Autotask, the account team associates resources with an account. The resources then have access to the account data when their security level allows account access at the Mine level. | |
CompanyToDos | This entity describes an Autotask To-Do, a scheduled item associated with a Company that appears on the user's Autotask calendar. You can assign it to any resource and associate it with a Contract, Ticket, or Opportunity. | |
CompanyWebhookExcludedResources | Refer to <EntityName>WebhookExcludedResources (REST). | |
CompanyWebhookField | Refer to <EntityName>WebhookFields (REST API). | |
CompanyWebhooks | Refer to <EntityName>Webhooks (REST API). | |
CompanyWebhookUdfFields | Refer to <EntityName>WebhookUdfFields (REST API). | |
This entity contains the attachments for the ConfigurationItems entity. |
|
|
ConfigurationItemBillingProductAssociations | The function of this entity is to describe the mapping of the Asset (Configuration Item) to the contract billing rule. | |
ConfigurationItemCategories | This entity's purpose is to describe an asset category. | |
ConfigurationItemCategoryUdfAssociations | The function of this entity is to describe the relationship between an asset category and a specific UDF. One of these entities exists for every UDF that is set as visible on each asset category. | |
This entity describes DNS records associated with Assets in Autotask. |
|
|
ConfigurationItemExts |
|
|
This entity contains the attachments for the ConfigurationItemNotes entity. |
|
|
ConfigurationItemNotes | This object describes notes created by an Autotask user and associated with a Asset entity. Autotask users manage Asset notes on Assets. | |
ConfigurationItemRelatedItems | The ConfigurationItemRelatedItems entity enables you to view, add, and remove related child or parent CIs in Autotask. |
|
ConfigurationItems | This entity describes one or more Autotask Assets (previously known as Configuration Items) assigned to a Ticket beyond the primary asset (ticket.configurationItemID). Assets are products that are associated with a Company entity. A ticket can have additional assets even if there is no primary asset. | |
This entity contains SSL Subject Alternative Name (SAN) records associated with the ConfigurationItems entity in Autotask. |
|
|
ConfigurationItemTypes | This entity's purpose is to describe a type, for example, printer, server, or workstation, assigned to an Asset in Autotask. | |
ConfigurationItemWebhookExcludedResources |
|
|
ConfigurationItemWebhookFields |
Refer to <EntityName>WebhookFields (REST API). |
|
ConfigurationItemWebhooks |
Refer to <EntityName>Webhooks (REST API). |
|
ConfigurationItemWebhookUdfFields |
Refer to <EntityName>WebhookUdfFields (REST API). |
|
ContactBillingProductAssociations | The function of this entity is to describe the mapping of the contact to the contract billing rule. | |
ContactGroupContacts | This entity's purpose is to describe a Contact associated with a ContactGroup. Contact Groups are an association of contacts, from one or more companies, that allow PSA users to send bulk email and create notes and/or to-dos simultaneously for all included contacts. | |
ContactGroups | This entity describes an association of contacts, from one or more companies, which allows PSA users to send bulk email and create notes and/or to-dos simultaneously for all included contacts. | |
Contacts | This entity describes an Autotask Contact. A Contact is an individual associated with a Company. | |
ContactWebhook | Refer to <EntityName>Webhooks (REST API). | |
ContactWebhookExcludedResource | Refer to <EntityName>WebhookExcludedResources (REST). | |
ContactWebhookField | Refer to <EntityName>WebhookFields (REST API). | |
ContactWebhookUdfField | Refer to <EntityName>WebhookUdfFields (REST API). | |
ContractBillingRules | This resource describes contract billing rules that generate charges which allow you to bill your customer by the end user or by the asset. | |
ContractBlockHourFactors | This entity describes an Autotask Block Hour Factor, an option used with Block Hour type Contracts. It allows you to compensate for the Block Hour fixed rate by applying a multiplier to specific role rates. | |
ContractBlocks | This entity describes an Autotask Contract Block which represents a block of hours purchased for a Block Hour type Contract. | |
ContractCharges | This entity's purpose is to describe a cost associated with an Autotask contract. | |
ContractExclusionBillingCodes | This entity's purpose is to describe a Work Type billing (or allocation) code that has been excluded from a Contract. | |
ContractExclusionRoles | This entity's purpose is to describe a billing Role that has been excluded from a Contract. | |
ContractExclusionSetExcludedRoles | This entity's purpose is to describe a billing role that is excluded from the contract to which the set applies. | |
ContractExclusionSetExcludedWorkTypes | This entity's purpose is to describe a billing Work Type (Allocation Code) that is excluded from the contract to which the set applies. | |
ContractExclusionSets | This entity's purpose is to describe a reusable set of roles and work types that are excluded from the contract to which the set applies. | |
ContractMilestones | This entity's purpose is to describe a billing milestone for an Autotask Fixed Price type Contract. Billing milestones define tangible work or measured progress that must be completed before billing can take place. | |
This entity contains the attachments for the ContractNotes entity. |
|
|
ContractNotes | This entity's purpose is to describe a note associated with an Autotask Contract. You can use notes to track information, update the status of the associated contract, and communicate with resources and customers. | |
ContractRates | This entity describes an Autotask Contract Rate. A Contract Rate is associated with a Role and is specific to a contract. You use it to override your company's standard role rate for labor tracked against the contract. | |
ContractRetainers | This entity's purpose is to describe a payment amount applied to a Retainer type contract and sets the time period covered by the purchase. | |
ContractRoleCosts | This entity describes an internal cost created for a resource-role combination for time entries on a specified contract. | |
Contracts | This entity describes an Autotask Contract. Contracts specify a billing arrangement with a Company. Autotask currently provides five contract types: Time and Materials, Fixed Price, Block Hours, Retainer, and Recurring Service. | |
ContractServiceAdjustments | This entity describes an adjustment to the quantity of units of a Contract Service entity that are added to a Recurring Service Contract. You can only create it; you cannot query or update it. Changes made to the Contract by using the ContractServiceAdjustment entity affect only the quantity of units. | |
ContractServiceBundleAdjustments | This entity describes an adjustment to the quantity of units of a Service Bundle that are added to a Recurring Service Contract. You can only create it; you cannot query or update it. Changes made to the Contract by using the ContractServiceBundleAdjustment entity affect only the quantity of Contract Service units. | |
ContractServiceBundles | This entity describes an Autotask Service Bundle added to a Recurring Service contract. Autotask Service Bundles group multiple Services for purchase. | |
ContractServiceBundleUnits | The function of this entity is to describe the number of units of a specific service bundle with an association to a Recurring Service contract for a specific date range. The entity exists for billing use purposes. | |
ContractServices | This entity describes an Autotask Service added to a Recurring Service contract. | |
ContractServiceUnits | The function of this entity is to describe the number of units of a specific service with an association to a Recurring Service contract for a specific date range. The entity exists for billing use purposes. | |
ContractTicketPurchases | This object describes a payment amount applied to the purchase of (or pre-payment for) one or more Service Desk Tickets through a Per Ticket Contract. | |
Countries | This entity's purpose is to describe a Country as defined in the Autotask CRM module. The Country entity is referenced by other entities and specifies the display name, address format, two-letter county code, and ISO standard name associated with the country. | |
Currencies | This entity's purpose is to describe a currency available for use with the Autotask multi-currency installed module. Available in the UI only when the installed module is enabled. Do not confuse it with Currency local term selection, which is not available when using Multi-currency. | |
DeletedTaskActivityLogs | This entity contains the records for the Deleted Task Activity journal located in the Autotask application at > Admin > Features and Settings > Projects & Tasks > Deleted Task Activity Log. The Deleted Task Activity log enables you to view a listing of task time entries, notes, and attachments that were deleted from your system. | |
DeletedTicketActivityLogs |
This entity contains the records for the Deleted Ticket Activity journal located in the Autotask application at > Admin > Features and Settings > Projects & Tasks > Deleted Ticket Activity Log. The Deleted Ticket Activity log provides a list of ticket time entries, notes, and attachments that were deleted from your system. |
|
DeletedTicketLogs | This entity contains the records for the Deleted Ticket log located in the Autotask application at > Admin > Features and Settings > Service Desk (Tickets) > Deleted Ticket Log. The Deleted Ticket log enables you to view a listing of tickets that have been deleted from your system. | |
Departments | This entity describes an Autotask Department. A Department is an association the application can use to manage resources, especially when assigning project tasks. | |
This entity contains attachments for documents in Autotask. |
|
|
DocumentCategories |
This entity represents the categories for documents in Autotask. |
|
This entity contains checklist items related to documents in Autotask. |
|
|
This entity represents checklist libraries related to documents in Autotask. |
|
|
This entity represents associations between assets and documents in Autotask. |
|
|
This entity represents associations between asset categories and documents in Autotask. |
|
|
This entity contains notes for documents in Autotask. |
|
|
Documents |
This entity represents a document in Autotask. |
|
This entity contains tag associations for documents in Autotask. |
|
|
This entity contains ticket associations for documents in Autotask. |
|
|
This entity represents documents associated with Knowledgebase articles in Autotask. |
|
|
The DomainRegistrars entity contains WHOIS details for Domain assets. |
|
|
ExpenseItemAttachment | This entity contains the attachments for the ExpenseItems entity. |
|
ExpenseItems | This entity's purpose is to describe a line item associated with an Expense Report entity. It allows you to create, query, and update expense line items through the API. | |
This entity contains the attachments for the ExpenseReports entity. |
|
|
ExpenseReports | This object describes Expense Reports created in Autotask; its purpose is for the submission of expense line items for approval and reimbursement. | |
Holidays | This entity's purpose is to describe a day specified as a Holiday (usually counted as paid time off) and included in an Autotask Internal location Holiday Set. | |
HolidaySets | This entity's purpose is to describe a grouped set of Holiday entities assigned to an Autotask Internal location and used in tracking internal time off. | |
InternalLocations | This entity's purpose is to describe a location defined in Company Setup in the Autotask Admin module. Every resource is associated with a location. The time zone and holiday set of the associated location are applied to the resource's time entries and schedules. | |
InternalLocationWithBusinessHours | This resource describes key business details for the Autotask Company 0, the Autotask user's company account. The entity provides an efficient way to access the details, via the API, to assist with the customer's Autotask implementation. | |
InventoryItems | This entity describes an Autotask Product with an association to an Inventory location in the Autotask Inventory module. | |
InventoryItemSerialNumbers | This entity's purpose is to describe a serial number associated with an Inventory Item. It allows users to track and manage Inventory Items created from Autotask Products that require a unique serial number. | |
InventoryLocations | This entity describes an Autotask Inventory location, that is, a physical or virtual place where your company stores or assigns inventory items. | |
InventoryProducts | An inventory product represents a set of stocked items that share a product and a location. When an inventory product is manually created, stocked items are also created. The InventoryProducts entity is the container where you define inventory location, minimum and maximum stocking levels, and can see the summary of the product (Available, Reserved, etc.). | |
InventoryStockedItemsAdd |
This entity enables you to increase inventory counts associated with the InventoryProducts entity. |
|
InventoryStockedItems | This entity describes detailed information about on-hand InventoryProducts at a location. | |
InventoryStockedItemsRemove |
This entity enables you to decrease inventory counts associated with the InventoryProducts entity. |
|
InventoryStockedItemsTransfer |
This entity describes a transaction where a specified quantity of an InventoryProducts or an InventoryStockedItems entity is transferred from the item’s current InventoryLocation to a different InventoryLocation. |
|
InventoryTransfers | This entity's purpose is to describe a transaction where a specified quantity of one Inventory Item entity transfers from the item’s currently assigned Inventory location to another Inventory location. It does not describe transactions where an Inventory Item is associated with a Company as an Asset. | |
Invoices | This entity describes an Autotask Invoice. Invoices include Billing Items that have been approved and posted and are being billed to a customer or presented for information purposes only. | |
InvoiceTemplates | This entity's purpose is to describe a template that defines the content and appearance of an Autotask Invoice. | |
KnowledgeBaseArticles | This entity represents articles created by Knowledgebase users in Autotask. |
|
KnowledgeBaseCategories | This entity contains the categories that hold Knowledgebase articles in Autotask. |
|
Modules | The Modules entity surfaces the availability and active status of modules (such as the Procurement module and the Inventory module) in Autotask. |
|
NotificationHistory | This entity describes an Autotask Notification, as listed in the Notification History page. | |
Opportunities | This entity describes an Autotask Opportunity. An opportunity is a forecasted piece of business; an identifiable prospect that needs a product or service and offers a potential sale, project, or contract. This entity allows you to track the progress of the opportunity and generate sales forecasts. | |
This entity contains attachments for the Opportunities entity. |
|
|
This entity enables your authorized third-party apps or modules to query the categories that can be associated with an opportunity in Autotask. |
|
|
OrganizationalLevel1 | When the Organizational Structure is enabled in Autotask, this object describes an organizational structure Branch. | |
OrganizationalLevel2 | When you enable the Organizational Structure feature in Autotask, this object describes an organizational structure Line of Business. | |
OrganizationalLevelAssociations | When you enable the Organizational Structure feature in Autotask, this object describes the association between an organizational structure Branch and Line of Business. | |
OrganizatonalResources | When you enable the Organizational Structure feature in Autotask, this object describes an Autotask Resource association with an organizational structure pairing of OrganizationalLevel1 and OrganizationalLevel2 (OrganizationalLevelAssociation entity). | |
PaymentTerms | This entity describes an Autotask Payment Term. A payment term specifies conditions and requirements for payment due on an Autotask invoice; for example, Net 30 days. | |
Phases | This entity describes an Autotask project Phase. Phases allow users to break projects into sub-groups of project tasks. | |
PriceListMaterialCodes | This entity is only used by multi-currency databases. It describes whether an Allocation Code of type Material Code on the Price List uses the internal currency or an external currency, and if it is external, lets you set the price in that currency. | |
PriceListProducts | This entity is only used by multi-currency databases. It describes whether a Product on the Price List uses the internal currency or an external currency, and if it is external, lets you set the price in that currency. | |
PriceListProductTiers | This entity is only used by multi-currency databases. It describes whether a Product on the Price List uses the internal currency or an external currency for a Product Tier, and if it is external, lets you set the price in that currency. | |
PriceListRoles | This entity is only used by multi-currency databases. It describes whether a Role Hourly Rate on the Price List uses the internal currency or an external currency, and if it is external, lets you set the price in that currency. | |
PriceListServiceBundles | This entity is only used by multi-currency databases. It describes whether a ServiceBundle on the Price List uses the internal currency or an external currency, and if it is external, lets you set the price in that currency. | |
PriceListServices | This entity is only used by multi-currency databases. It describes whether a Service on the Price List uses the internal currency or an external currency, and if it is external, lets you set the price in that currency. | |
PriceListWorkTypeModifiers |
This entity is only used by multi-currency databases. It describes Price List information associated with a WorkTypeModifier entity. A WorkTypeModifier entity modifies a given Work Type BillingCode. |
|
This entity describes notes created by an Autotask user and associated with a Product entity. |
|
|
Products | This entity describes an instance of hardware, software, or a material item in Autotask that a company sells or supports for customers. | |
ProductTiers | This entity describes the pricing and costing tiers for a specific billing product on the Product table. It allows you to configure tiered or volume pricing for the billing product. | |
ProductVendors | This entity's purpose is to describe a Vendor type Company with an association to an Autotask Product. | |
This entity contains attachments for the Projects entity. |
|
|
ProjectCharges | This entity's purpose is to describe a cost associated with an Autotask Project. | |
This entity contains the attachments for the ProjectNotes entity. |
|
|
ProjectNotes | This object describes notes created by an Autotask user and associated to a Project entity. | |
Projects | This entity describes an Autotask Project. A project defines and organizes a group of related tasks, events, and documents. | |
PurchaseApprovals | The function of this entity is to describe the approval status of a project, ticket, or contract purchase cost created in Autotask. The purchase approval option is available through Autotask procurement. | |
PurchaseOrderItemReceiving | This entity's purpose is to describe a transaction where a specified quantity of a Purchase Order Item is 'received,' that is, debited from the Quantity value of the associated Purchase Order Item and added to the Quantity On Hand value of the Inventory Item. | |
PurchaseOrderItems | This object associates a Product entity with a PurchaseOrder entity. | |
PurchaseOrders | This entity describes an Autotask Inventory module Purchase Order. | |
QuoteItems | This entity describes an Autotask Quote Item. Quote Items define a line item added to an Autotask Quote. | |
QuoteLocations | This entity's purpose is to describe a location associated with an Autotask Quote that defines address information for a shipToLocationID and/or billToLocationID. | |
Quotes | This entity's purpose is to describe a Quote in Autotask. It must have an association with an Autotask Opportunity entity, and it allows users to specify and track multiple products, services, labor items, etc., that further define the Opportunity. | |
QuoteTemplates | This entity describes an Autotask Quote Template that defines the content and appearance of an Autotask Quote. | |
This entity contains the attachments for the Resources entity. |
|
|
ResourceDailyAvailabilities | This entity represents the daily availability, hours goal, and travel for a resource. It mirrors the fields found on the HR tab of the Resource Management section in the Autotask UI. | |
ResourceRoleDepartments | This entity's purpose is to describe a Resource - Role - Department relationship. A resource must have at least one role assignment. Resources receive assignment to one or more roles through their department and queue associations. This entity describes the Resource Role and Department association | |
ResourceRoleQueues | This entity's purpose is to describe a Resource - Role - Queue relationship. A resource must have at least one role assignment. Resources receive assignment to one or more roles through their department and queue associations. This entity describes the Resource and Role through the Queue association. | |
ResourceRoles | This entity's purpose is to describe a Resource - Role relationship. | |
Resources | This entity describes an Autotask Resource. Autotask Resources are employees, contractors, or consultants with access to a company's Autotask system. | |
ResourceServiceDeskRoles | The function of this entity is to describe the Resource - Service Desk Role association and takes some functionality from the ResourceRoleQueue entity, since Resource - Queue associations no longer require a Role association. | |
ResourceSkills | Associates a Skill with a Resource to provide information about the skills or abilities of the resource. | |
This entity describes the remaining time off a resource has accrued or has been allotted, according to their assigned Time Off Policy. |
|
|
This entity describes time off the resource has been granted for the current and next year in addition to their assigned Time Off Policy. |
|
|
This entity describes the resources who are allowed to be timesheet approvers, and their approval levels. |
|
|
Roles | This entity describes an Autotask Role. Roles are associated with a department, have a standard billing rate, and are assigned to resources for billing purposes. | |
This entity contains the attachments for the SalesOrders entity. |
|
|
SalesOrders | In Autotask, sales orders are associated to Opportunities. This entity provides a method to track cost items generated from an Autotask Quote. | |
ServiceBundles | This entity's purpose is to describe a group of Service entity items that are priced and billed as one component of Recurring Service type contract. | |
ServiceBundleServices | This entity's purpose is to describe a Service entity assigned to a ServiceBundle entity. | |
ServiceCalls | This entity describes an Autotask service call and its relationship to four other service call related entities. Service calls are instances of time, with specified start and stop times, that are scheduled to perform work for a Company. | |
ServiceCallTaskResources | This entity describes an Autotask resource assigned to a task that is assigned to a service call. | |
ServiceCallTasks | This entity describes an Autotask project task assigned to a service call. | |
ServiceCallTicketResources | This entity describes an Autotask resource assigned to a ticket that is assigned to a service call. | |
ServiceCallTickets | This entity describes an Autotask ticket assigned to a service call. | |
ServiceLevelAgreementResults | This entity describes time and completion data related to service level events tracked for a service level agreement associated with a ticket. All fields are read-only. | |
Services | This entity's purpose is to describe a deliverable item that represents a pre-defined unit of work performed for a set price and billed at regular intervals; for example, a 'Disk Backup' performed for one computer. | |
ShippingTypes | This entity describes an Autotask Shipping Type. A shipping type defines a carrier for a product shipment. You can only associate it with a Quote entity. | |
Skills | This entity's purpose is to describe a skill or ability that you can associate with a Resource via the ResourceSkill entity. | |
SubscriptionPeriods | This entity describes an Autotask SubscriptionPeriod. A SubscriptionPeriod stores the information for an individual billing period item associated with an Autotask Subscription. | |
Subscriptions | This entity describes an Autotask Subscription. A Subscription creates recurring billing items for Assets when there is no need to track labor costs against subscription revenue; for example, when billing in installments. | |
SurveyResults | This entity describes results and information for a survey generated by Autotask. | |
Surveys | This object describes general information for a survey generated by Autotask. | |
This entity represents aliases for ticket and article tags in Autotask. |
|
|
This entity represents ticket tag groups in Autotask. |
|
|
This entity represents ticket and article tags in Autotask. |
|
|
This entity contains attachments for the Tasks entity. |
|
|
This entity contains the attachments for the TaskNotes entity. |
|
|
TaskNotes | This entity describes notes created by an Autotask user and associated with a Task entity. | |
TaskPredecessors | This entity's purpose is to describe a predecessor/successor arrangement between two project schedule items. | |
Tasks | This entity describes an Autotask Task. Tasks are associated with a Project and define work that must be done. | |
TaskSecondaryResources | This entity's purpose is to describe a resource assigned to a task but not as the primary resource. | |
TaxCategories | The function of this entity is to describe the tax rate for a specific billing item. It determines a customer's total taxes on billing items. | |
Taxes | The function of this entity is to describe the tax rate charged to a customer for specific goods or services purchased in a specified tax region. | |
TaxRegions | This entity's purpose is to describe a geographic area where billing items have the same tax rate. It determines a customer's total taxes on billing items. | |
TicketAdditionalConfigurationItems | This object describes Autotask Assets (previously known as Configuration Items), other than the primary Assets (Ticket.configurationItemID). Assets are Products with an association to a Company entity. | |
TicketAdditionalContacts | This entity describes one or more account contacts assigned to a Ticket, other than the Ticket Contact (Ticket.contactID). | |
This entity contains attachments for the Tickets entity. |
|
|
TicketCategories | This entity's purpose is to describe a ticket category, applied to tickets in Autotask to specify features and fields that appear on the ticket detail. | |
TicketCategoryFieldDefaults | The function of this entity is to describe the default settings for fields associated with the specified ticket category. | |
TicketChangeRequestApprovals | This entity's purpose is to describe a record of approval for a ticket change request. The change request approval process is part of the Autotask Change Management feature set. | |
This entity describes a cost associated with an Autotask Ticket. A cost is a billing item for products or materials. |
|
|
TicketChecklistItems | This object describes list items added to a check list on an Autotask ticket. Checklists are an optional feature on the ticket page that display numbered items to be completed in order to finish work on a ticket. | |
TicketChecklistLibraries | This entity allows all items in a checklist library to be added to a ticket. If a ticket already has checklist items, the checklist library is appended to the end of the list of checklist items. | |
TicketHistory | The function of this entity is to describe the Ticket History, which tracks changes to the fields of the ticket entity, as well as the fields of any Service Level Agreement associated with the ticket. | |
This entity contains the attachments for the TicketNotes entity. |
|
|
TicketNotes | This entity's purpose is to describe a note created by an Autotask user and associated with a Ticket entity. | |
TicketNoteWebhookExcludedResources |
|
|
TicketNoteWebhookFields |
Refer to <EntityName>WebhookFields (REST API). |
|
TicketNoteWebhooks |
Refer to <EntityName>Webhooks (REST API). |
|
TicketRmaCredits |
This entity describes the refund or credit charge that generates when the RMA is set as Authorized on a ticket with the RMA ticket category. |
|
Tickets | This entity describes an Autotask Ticket. Tickets define service requests within the Autotask system. | |
TicketSecondaryResources | This entity's purpose is to describe a resource assigned to a ticket but not as the primary resource. | |
TicketTagAssociations |
This entity manages the tags associated with tickets in Autotask. |
|
TicketWebhookExcludedResources |
|
|
TicketWebhookFields |
Refer to <EntityName>WebhookFields (REST API). |
|
TicketWebhooks |
Refer to <EntityName>Webhooks (REST API). |
|
TicketWebhookUdfFields |
Refer to <EntityName>WebhookUdfFields (REST API). |
|
TimeEntries | This entity describes an Autotask Time Entry. A time entry allows an Autotask resource to enter ticket and task time (Labor) and general or regular time (non-customer facing time). | |
This entity contains the attachments for the TimeEntries entity. |
|
|
This entity describes time off the resource has been granted for the current and next year in addition to their assigned Time Off Policy. |
|
|
This entity describes the approval of a specific time off request. |
|
|
Autotask includes a time off policy management feature that enables your company to track employee time off benefits. This entity represents time off requests submitted by Autotask users. |
|
|
This entity describes the rejection of a specific time off request. |
|
|
UserDefinedFieldDefinitions | This entity defines a user-defined field (UDF) in Autotask. User-defined fields are custom fields that each Autotask customer can add to their Company, Contact, Opportunity, Sales Order, Projects, Products, Assets, Ticket, and Task tables. | |
UserDefinedFieldListItems | This entity's purpose is to describe a list item associated with a UserDefinedFieldDefinition entity that has dataType = List | |
Version |
This entity surfaces the Autotask version number. |
|
WebhookEventErrorLogs | The function of this entity is to describe the Webhook error log where errors are kept by the application for 30 days. The application records an error when the maximum number of retries (5) have occurred for an event, but the payload could not be delivered. | |
WorkTypeModifiers | This entity's purpose is to describe a modifier for a given Work Type BillingCode. |