It allows you to create, query, and update expense line items through the API. /*Ticket - Autotask Ticket Date Completed by Complete Project Wizard, Ticket Department Name OR Ticket Queue Name, Service Level Agreement Paused Next Event Hours, This entity will be read-only if the module with which it is associated is not active. Refer to Adding and managing attachments. This entity describes an adjustment to the quantity of units of a Service Bundle that are added to a Recurring Service Contract. You can use notes to track information, update the status of the associated contract, and communicate with resources and customers. Refer to WebhookExcludedResources (REST). Refer to Webhooks (REST API). If ChangeApprovalStatus = Requested, user can change it to Assigned (only). The Entities list provides a link to additional information about the entity and its standard Autotask fields. If TicketType = ChangeRequest, ProblemTicketID cannot have a value. IMPORTANT Except in the case of certain entities, when the APIreceives a request to update a field that contains Rich Text, the APIwill update the text-only version of the field and overwrite the data in the Rich Text field with plain text. The function of this entity is to describe the Webhook error log where errors are kept by the application for 30 days. A shipping type defines a carrier for a product shipment. Three read only fields, MonitorID, MonitorTypeID, and RMMAlertID are currently available for use by the Autotask RMM integration only. These are referred to as Reference fields. By accepting all cookies, you agree to our use of cookies to deliver and maintain our services and site, improve the quality of Reddit, personalize Reddit content and advertising, and measure the effectiveness of advertising. This entity contains notes for documents in Autotask. For additional information, refer to. Here is the code I tried (after authenticating). NOTE If Knowledgebase is enabled and the ticket is used to create a Knowledgebase article, the contents of the Resolution field appear in the article. Thanks for your feedback. 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. If you want your integration users' names to show on the entity, follow these steps: This example adds an impersonated user to a request's headers. This includes the category field itself. Although the data will remain intact and will be reportable, it will not be viewable in the ticket in Autotask. The integration uses the Autotask Web Services API for automatic ticket creation in Autotask. } Visit the Ideas forum! Review the setting of the Internal Only check box. You can make this a default setting. Changes made to the Contract by using the ContractServiceBundleAdjustment entity affect only the quantity of Contract Service units. This entity describes an Autotask Inventory module Purchase Order. In addition, a stumbling block I noted was to double check the AssignedResourceID has the actual role assigned via AssignedResourceRoleID. This entity contains notes for Knowledgebase articles in Autotask. Calculated in hours only. Append to Resolution on # incident(s) (tickets only). Implementing the time entry portion wouldn't be terrible. This check box is enabled when the Internal check box is selected. If TicketType = Problem and incidents are associated with the ticket, TicketType cannot be changed to Incident or Service Request until the incidents are disassociated from the ticket. Service calls are instances of time, with specified start and stop times, that are scheduled to perform work for a Company. 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). IMPORTANT When this feature is released, we will change the Publish settings of ticket and task notes and attachments to Internal &Co-managed for all tickets and tasks where the Co-managed Visibility is set to Visible. All active note types of the category Task are available, plus the current selection even if it is inactive. Enter the recipient email address in the Email API Token to (optional) field and click Email Token (Optional) The sent email includes the API Key and the server URL to query. Some entities support file attachments. This entity describes an Autotask Opportunity. 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. The status code getting printed here is 401! Autotask API Ticket Creation with PowerShell Does anyone have sample code for how to create a ticket using the REST API. Access to version 1.6 will deactivate in Q4 2024. Where developers & technologists share private knowledge with coworkers, Reach developers & technologists worldwide, Read the instructions and follow the path. The date/time stamp indicates the date and time the status was last refreshed from the task or ticket. Don't assume anything incl. For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed. Refer to Note Titles. It determines a customer's total taxes on billing items. [CDATA[*/ To make calls to the entities of the AutotaskRESTAPI, you will need to use their resource access URLs or child collection access URLs. That InstalledProduct must also reference a Product that is EligibleForRma. This selection opens a page that contains a subset of the fields documented above. 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. If the setting Enable [Entity] Stopwatch is cleared for the entity category, the stopwatch will not appear. Each entity type object contains an array of properties that describe instances of the entity type. Thanks for your feedback. 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. This entity's purpose is to describe a Contact associated with a ContactGroup. The purchase approval option is available through Autotask procurement. This entity's purpose is to describe a Resource - Role relationship. This entity describes detailed information about on-hand. function SendLinkByMail(href) { 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. This object describes Autotask Assets (previously known as Configuration Items), other than the primary Assets (Ticket.configurationItemID). 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. Press question mark to learn the rest of the keyboard shortcuts. This entity contains SSLSubject Alternative Name (SAN) records associated with the ConfigurationItemsentity in Autotask. Mass ticket creation : r/Autotask - reddit An API user is a special type of account required for communication with the Autotask API. Set up the Autotask trigger, and make magic happen automatically in Microsoft Excel. Task & Ticket Statuses - Autotask On the Note dialog box or page, this check box is missing and the attachment inherits the setting of the note. /*GitHub - KelvinTegelaar/AutotaskAPI: Autotask 2020.2 REST API If cleared (default setting), all Autotask resources, Outsourcing partners, and customers with access to the item in the Client Portal can view the note. When it is expanded on the New Note or New Time Entry form, the New Attachment dialog box will open automatically. Head on over to our Community Forum! This entity's purpose is to describe a line item associated with an Expense Report entity. A Contract Rate is associated with a Role and is specific to a contract. Both the integration user and the API-only user must have security level permission to add or edit the entity. To learn more, refer to The Rich Text editor. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; A Resource + Role combination assigned to a ticket must be associated with at least one Service Desk Queue. It describes Price List information associated with a WorkTypeModifier entity. Visit the Ideas forum! TicketCategory default values will be applied unless another value is passed in. } The entity exists for billing use purposes. This entity's purpose is to describe a configurable alert message, associated with an account, that appears on different account-related pages. Some users wanted a benchmark of the new API. If the API receives an invalid prefix, it will automatically generate one and assign it to the resource. Autotask administrators create UDFs in the Administration Settings of the Autotask system. The entity provides an efficient way to access the details, via the API, to assist with the customer's Autotask implementation. /*]]>*/Want to tell us more? Although you can query this entity, it contains one or more fields that are not queryable. This entity describes an Autotask Quote Item. This entity describes an Autotask Payment Term. This entity contains attachments for the Opportunities entity. Want to learn about upcoming enhancements? 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. This entity enables your authorized third-party apps or modules to query the categories that can be associated with an opportunity in Autotask. Zapier's automation tools make it easy to connect Autotask and Microsoft Excel. /*]]>*/Want to tell us more? Does ZnSO4 + H2 at high pressure reverses to Zn + H2SO4? One of these entities exists for every UDF that is set as visible on each asset category. For the Autotask REST API, the Read-Only and Required field attributes have the following meanings: It is possible for a field to be both Read-Only and Required. 2. All text formatting and images will be lost. Once you have connected Powershell to Autotask (see my previous post for a howto), you can query, create and update everything that the API allows.In this post I will show you how to create a new ticket, but the method is the . The time zone and holiday set of the associated location are applied to the resource's time entries and schedules. 1. 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. Autotask Customer Satisfaction Surveys, One-Click CSAT or CES Ticket If selected, the text entered into the Summary Notes (on time entries) or Description field (on ticket notes) will be appended to the end of the Resolution field on all of the tickets incidents. You cannot create a ticket with TicketType = Problem and specify a ProblemTicket ID or specify ProblemTicketID for an existing Ticket with TicketType=Problem; that is, a ticket that is already a problem ticket cannot become an incident to another problem ticket. This entity describes an Autotask Subscription. Refer to the About entity fields section of this article for more information. If you have not clicked the Get current Status link, it will be the date and time you opened the page. This entity describes an approved and posted billable item in Autotask. CreatorType specifies whether the CreatorResourceID refers to a Resource or a Contact. They are required in the UI only if the system setting 'Require Issue and Sub-Issue on tickets' is enabled. This entity describes an Autotask project task assigned to a service call. This entity's purpose is to describe a predecessor/successor arrangement between two project schedule items. Visit the Ideas forum! This entity's purpose is to describe a location associated with an Autotask Quote that defines address information for a shipToLocationID and/or billToLocationID. 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. What sort of strategies would a medieval military use against a fantasy giant? Autotask users manage Tickets through a number of modules including Service Desk, Home, CRM, and Contracts. Autotask currently provides five contract types: Time and Materials, Fixed Price, Block Hours, Retainer, and Recurring Service. The AllocationCodeID field must reference a Work Type allocation code. This entity describes notes created by an Autotask user and associated with a Task entity. The DomainRegistrars entity contains WHOISdetails for Domain assets. AllocationCodeID is required on create() and update() if your company has enabled the Autotask system setting that requires a Work Type on a Ticket. On entities like ticket, task, note, and to-do, the Description field is a core part of the data record. In Autotask, the account team associates resources with an account. 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. This entity describes an Autotask Product with an association to an Inventory location in the Autotask Inventory module. This object describes general information for a survey generated by Autotask. A ticket workflow rule with a Create Ticket Note . An attempt to create a Ticket using a Resource + Role combination with an inactive Role will trigger an error. A resource can be associated with multiple LOBs; entities cannot. Autotask now allows Role to be inactivated. This entity's purpose is to describe a billing milestone for an Autotask Fixed Price type Contract. From the pull-down menu, Update/Create Maximum Entities: The Web Service API calls can update or create a maximum of 200 objects with one call. The status field describes how close a ticket is to resolution, or how close a task is to completion. This entity's purpose is to describe a template that defines the content and appearance of an Autotask Invoice. If no asset or contract SLA, then check the Ticket Category. In Autotask, you can create ticket categories that are identified as API-Only. This entity's purpose is to describe an asset category. This entity's purpose is to describe a cost associated with a Change Order to an Autotask Project. This entity describes an Autotask Invoice. https://www.autotask.com/, Press J to jump to the feed. Create a Ticket in Autotask using Powershell 27 Aug 2015. To use a speed code, enter it in the field. NOTE This field is visible only if Co-managed Help Desk is enabled on the Activation page, and only shown to resources who are not co-managed. To open the page, use the path (s) in the Security and navigation section above. The ticket SLA is defaulted in using the following logic: Check the asset. This entity contains the attachments for the TimeEntries entity. Notes have a property called Note Type. If you edit a note or time entry that is associated with existing attachments, they appear in a separate Attachments section. A new inactive ContactID value cannot be assigned on create() or update(). A company's category determines the layout of the entity's pages, which fields are visible, and which picklist options are available. If you use the Kaseya RMM Extension, tickets generate by using Incoming Email Processing. This entity represents the daily availability, hours goal, and travel for a resource. It determines a customer's total taxes on billing items. Click New; Tip - click the images to make them larger Write. Resources receive assignment to one or more roles through their department and queue associations. When querying, a small number of entities contain fields that you cannot query. Autotask users manage Tickets through a number of modules including Service Desk, Home, CRM, and Contracts. What video game is Charlie playing in Poker Face S01E07? Assets are products that are associated with a Company entity. Adding or editing an API user - autotask.net Security: This check box is available even if users do not have permission to edit tickets. 5. The attachments will only be added to the incidents of problem tickets, not incidents of Change Request tickets. The allowed actions are specific to the object. If Ticket.AccountID is updated then Ticket.AccountPhysicalLocation must have AccountID = Ticket.AccountID. Where does this (supposedly) Gibson quote come from? The entity header identifies the parent entity the note or time entry is associated with. Associates a Skill with a Resource to provide information about the skills or abilities of the resource. This entity describes an instance of hardware, software, or a material item in Autotask that a company sells or supports for customers. This entity is only used by multi-currency databases. The Autotask REST API presents selected Autotask resources as programming objects that allow the client to perform actions on them. This entity describes an Autotask project Phase. Adding a note to a task or ticket - Autotask /*]]>*/Want to tell us more? About note types. A WorkTypeModifier entity modifies a given Work Type BillingCode. If you set the status of selected tickets to Complete, and one or more tickets have incomplete to-dos, a confirmation message will ask if you want to complete associated to-dos. Select OK to apply; Setup Extension Callout. The ArticleTicketAssociations entity records existing associations between tickets and Knowledgebase articles in Autotask. Visit the Ideas forum! How to handle a hobby that makes income in US. I am using CyberDrain PowerShell module but I am clearly missing something. The API can complete a ticket that has one or more incomplete 'Important' Checklist items. Asking for help, clarification, or responding to other answers. This entity represents articles created by Knowledgebase users in Autotask. If no TicketCategory is passed in, the API will use the logged in resource's default category; if the resource does not have a default category, the API will use the Company's system default ticket category. Some fields on Entities require an id to a parent Entity. NAVIGATION IssueType and SubIssueType are never required in the API. To obtain complete field information specific to your Autotask implementation, use theGETAPIcalls described in the resource and child collection access URLs section of this document. Changes made to the Contract by using the ContractServiceAdjustment entity affect only the quantity of units. Yep tried that - on the example given by Autotask it included "Id": "0" on the first line - but it doesn't make any difference. On create(), if InstalledProductID is populated, the InstalledProduct.AccountID must = Ticket.AccountID. They can click New Ticket on the Autotask interface sub-navigation menu to open the New Ticket window. This will populate the LOB field with that selection when creating any entities where LOB can be applied. A Contact is an individual associated with a Company. Read-Only:Read-Only fields cannot be changed by, Required: Required fields must be present when you attempt a. This entity's purpose is to describe a Country as defined in the Autotask CRM module. DocumentConfigurationItemCategoryAssociations. Thanks for your feedback. The id field belongs to each entity and acts as the unique identifier. /*]]>*/Want to tell us more? /*TicketCategory - Autotask You cannot use the API to create items that contain Rich Text, but you can add Rich Text later via a supported method. It has code to get popular entities like accounts, tickets, contacts etc. To view attachments uploaded by other users, Can view time entry internal notes, internal notes, and internal attachments (on Ticket Detail and CRM Detail screens) or Can view time entry internal notes, internal notes, and internal attachments (on Task Detail screens)