After you create the API key, login to your Autotask instance, hover over the Autotask button in the top left corner then . Invoice templates define the appearance and content of an invoice generated by Autotask. I know I have correctly authenticated and set the BaseURI because I can get company information for customers. Want to learn about upcoming enhancements? This entity contains the attachments for the TicketNotes entity. In Autotask, sales orders are associated to Opportunities. DocumentConfigurationItemCategoryAssociations. This entity's purpose is to describe a Work Type billing (or allocation) code that has been excluded from a Contract. On notes that can become a notification email, attachments can be included. Field is cleared when ticket comes out of Waiting Customer status and is recalculated every time ticket goes back into Waiting Customer status. The Status field is required on all tickets and project tasks, regardless of category. The REST API permits you to retrieve values for all entity UDFs via the query method. This entity allows you to track the progress of the opportunity and generate sales forecasts. 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. /*]]>*/Want to tell us more? This entity contains the attachments for the ConfigurationItemNotes entity. This entity's purpose is to describe a record of approval for a ticket change request. 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. ExpenseItem.AccountID is updated and ExpenseItem.ProjectID, ExpenseItem.TaskID, or ExpenseItem.TicketID is set to Null. The value you select will be set as the status of the parent entity when the dialog box or page is saved. Integration vendors The DomainRegistrars entity contains WHOISdetails for Domain assets. ProjectID must be associated with the same Account as the Ticket (Ticket.AccountID). 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. Invoices include Billing Items that have been approved and posted and are being billed to a customer or presented for information purposes only. This entity contains attachments for the Companies entity. TicketType must = Incident before the ticket can be associated with a ProblemTicketID. This check box is enabled when the Internal check box is selected. 1. If the Contract is associated to an SLA, then use that ID. This entity describes an Autotask Contract Rate. Any entities or attachments that the account creates will be attributed to "APIUser." If the ticket category was configured to display them, additional ticket fields appear in this section on time entries and notes. This object describes list items added to a check list on an Autotask ticket. When a SubIssueType value is provided, the associated IssueType value must also be provided. Open the Kaseya Helpdesk. This entity describes notes created by an Autotask user and associated with a Product entity. [CDATA[*/ NOTE If the Ticket Note or Ticket Time Entry page is opened from the Edit Ticket page, Forward/Modify is disabled. Notes published to All Autotask Users are visible to customers. This object describes Autotask Assets (previously known as Configuration Items), other than the primary Assets (Ticket.configurationItemID). This entity's purpose is to describe a billing milestone for an Autotask Fixed Price type Contract. The change request approval process is part of the Autotask Change Management feature set. A Contact is an individual associated with a Company. The selected recipients are added to the To: field; CC: and BCC: fields are not populated. Yep tried that - on the example given by Autotask it included "Id": "0" on the first line - but it doesn't make any difference. Review the setting of the Internal Only check box. Visit the Ideas forum! In addition, a stumbling block I noted was to double check the AssignedResourceID has the actual role assigned via AssignedResourceRoleID. } A place where magic is studied and practiced? 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. 5. Visit the Ideas forum! Read-Only:Read-Only fields cannot be changed by, Required: Required fields must be present when you attempt a. 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. To obtain extended information about entities and their field data, use the GET API call. Autotask users manage Tickets through a number of modules including Service Desk, Home, CRM, and Contracts. The API user security level has access to contact impersonation for tickets. Every attempt gives me a 500 server error. Did any DOS compatibility layers exist for any UNIX-like systems before DOS started to become outmoded? This entity describes an Autotask ticket assigned to a service call. Basic Incoming Email Processing is available to all Autotask customers at no additional cost, and includes: The Add Ticket Email Service (ATES) mailbox, which is already set up One additional active custom mailbox. Form templates follow the limitations of the currently applied category and the user's security settings. } > Service Desk >Search >Tickets >click Search > open a ticket >Quick Add bar > select Note (Alt+2), NAVIGATION > Projects >Projects > search for a project >click on the Project Name > Schedule > task context menu > General > View Details > Quick Add bar > select Note (Alt+2). This entity's purpose is to describe a cost associated with an Autotask Project. Ticket User-Defined Field: When you select a User-Defined Field, the extension call will be triggered only for tickets that . Easily create an Autotask survey Easy copy/paste process takes less than 5 minutes Including survey in existing notifications means no extra emails for your clients Sync Autotask ticket details with feedback Gain further context about feedback by retrieving ticket info through the Autotask API. /**/Want to tell us more? Append to Resolution on # incident(s) (tickets only). This entity describes an Autotask Inventory location, that is, a physical or virtual place where your company stores or assigns inventory items. Currently, the API provides the following actions: GET, PUT, PATCH, POST, and DELETE. This entity describes an Autotask Task. They can click New Ticket on the Autotask interface sub-navigation menu to open the New Ticket window. 'Mine + Accounts' will be treated as 'None.' Also create Note/Attachment on # incident(s) (tickets only). This check box only appears for notes and time entries on problem tickets associated with one or more incidents. This entity's purpose is to describe a location associated with an Autotask Quote that defines address information for a shipToLocationID and/or billToLocationID. TicketCategory default values will be applied unless another value is passed in. This entity describes an Autotask Service added to a Recurring Service contract. Find centralized, trusted content and collaborate around the technologies you use most. A new inactive ContactID value cannot be assigned on create() or update(). This article provides a general technical overview and index of the resources (entities)that you can access via the AutotaskRESTAPI. IssueType and SubIssueType are never required in the API. If recipients are added or removed from the To: field on the Notification panel, the matching role-based check boxes will become selected or cleared. Getting an API User setup, along with the keys, will set us up to establish a link between CloudRadial and Autotask so that they can share information back and forth. import requests. 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. The note will only be added to the incidents of problem tickets, not incidents of Change Request tickets. Have an idea for a new feature? You can also retrieve this information with the Web Services API call The getEntityInfo() SOAPAPIcall. This entity's purpose is to describe a configurable alert message, associated with an account, that appears on different account-related pages. Can Query is not included because non-queryable fields are listed under a separate heading. You can create additional mailboxes, but you won't be able to activate them. This entity's purpose is to describe a line item associated with an Expense Report entity. Changes made to the Contract by using the ContractServiceAdjustment entity affect only the quantity of units. [CDATA[*/ This entity describes a ticket category applied to tickets in Autotask to specify features and fields that appear on the ticket detail. The Autotask REST API presents selected Autotask resources as programming objects that allow the client to perform actions on them. If the user sends content back to an unsupported entity, the Rich Text and all images it contains will be lost. Do new devs get fired if they can't solve a certain bug? Where developers & technologists share private knowledge with coworkers, Reach developers & technologists worldwide, Read the instructions and follow the path. The instructions in this topic help you create an Autotask API user account, configure configuration items and monitors, and configure ticket management in Autotask for your Firebox integration. To learn more, see our tips on writing great answers. 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 POSTAPI call, the create will fail. If a law is new but its interpretation is vague, can the courts directly ask the drafters the intent and official interpretation of their law? ServiceLevelAgreementPausedNextEventHours (read only) is calculated as the time differential between the most recent time the ticket status changed to Waiting Customer and the time of the next SLA target. What is a word for the arcane equivalent of a monastery? The function of this entity is to describe the default settings for fields associated with the specified ticket category. This entity describes the Resource Role and Department association. Autotask users manage Tickets through a number of modules including Service Desk, Home, CRM, and Contracts. window.open(uri); You may also update UDFs for entity types that allow update and create. The ticket SLA is defaulted in using the following logic: Check the asset. 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. ConfigurationItemWebhookExcludedResources. This object describes notes created by an Autotask user and associated with a Asset entity. As you save each attachment, it will appear on the attachment grid. To attach the new attachment to the notification email, select Include Attachments in Email on the notification panel. If ChangeApprovalStatus = Requested, user can change it to Assigned (only). You might want to work with Autotask API's own Visual Studio solutions which are linked on their web services page. function SendLinkByMail(href) { Security: This check box is available even if users do not have permission to edit tickets. This field is editable for tickets whose ticket category is 'RMA.' A Resource + Role combination assigned to a ticket must be associated with at least one Service Desk Queue.