This entity describes an Autotask SubscriptionPeriod. } This entity contains the attachments for the TicketNotes entity. Thanks for your feedback. The name of the user who is filling the role is added to the role name. . Is there a proper earth ground point in this switch box? For child collection access URLs and specific entity names, refer to the individual articles linked in the List of Entities section of this article. This field is editable for tickets whose ticket category is 'RMA.' If a status or quick edit field supplied by the dialog fields conflicts with an unsaved change on the Edit Ticket page, the dialogs value will be used.Information on the Insights panel will not be updated until that task or ticket is saved. It determines a customer's total taxes on billing items. This entity enables you to decrease inventory counts associated with the InventoryProducts entity. This entity contains the attachments for the ExpenseReports entity. On create(), Priority must be an active priority. 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. This selection opens a page that contains a subset of the fields documented above. If it is selected, the note is created with the Internal & Co-managed publish type. This entity represents the categories for documents in Autotask. NAVIGATION If the Quick Ticket Edits section remains collapsed, you can save the note or time entry without completing required fields. Each entity type object contains an array of properties that describe instances of the entity type. Tasks are associated with a Project and define work that must be done. This entity contains SSLSubject Alternative Name (SAN) records associated with the ConfigurationItemsentity in Autotask. You get internal server error when it's not happy about something, but in the returned body it normally expands on the particular error. If a ticket has TicketType not equal to 'Change Request' and it has data in one or more the fields that are exclusive to Change Request tickets, then the ticket can be saved. This entity describes list items added to a check list on an Autotask ticket or task. Where developers & technologists share private knowledge with coworkers, Reach developers & technologists worldwide, Read the instructions and follow the path. /*WebhookExcludedResources (REST), ConfigurationItemBillingProductAssociations, Using Swagger UIto explore REST API requests, Need troubleshooting help? 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. Autotask users manage Tickets through a number of modules including Service Desk, Home, CRM, and Contracts. IssueType and SubIssueType are never required in the API. This entity describes an Autotask Opportunity. This entity describes an Autotask Project. The API does not respect the TicketCategory's 'required' and 'available list item' settings, with the exception of the 'Queue is Required' setting. 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. This entity's purpose is to describe a Work Type billing (or allocation) code that has been excluded from a Contract. Integration vendors To use a speed code, enter it in the field. For more information, refer to. This entity represents documents associated with Knowledgebase articles in Autotask. On ticket grids, you can select the Add Note to Selected Tickets option from the bulk menu. They can click New Ticket on the Autotask interface sub-navigation menu to open the New Ticket window. 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. I know I have correctly authenticated and set the BaseURI because I can get company information for customers. If there is already text in the Resolution field, two line breaks will separate the existing text from the text added. After you create the API key, login to your Autotask instance, hover over the Autotask button in the top left corner then . Open the Kaseya Helpdesk. Want to learn about upcoming enhancements? This entity is only used by multi-currency databases. 4. Create Workflow Rules to Set Ticket Severity Level In Autotask, you can set the ticket severity level by creating workflow rules using information provided in the Ticket Title or Description fields. Can airtags be tracked from an iMac desktop, with no iPhone? To learn more, refer to The Rich Text editor. Need troubleshooting help? This entity contains ticket associations for documents in Autotask. This resource describes contract billing rules that generate charges which allow you to bill your customer by the end user or by the asset. It describes Price List information associated with a WorkTypeModifier entity. If the ticket type = Change Request, then ChangeApprovalType is set to the default value. Namely the VS solutions are here. Autotask Resources are employees, contractors, or consultants with access to a company's Autotask system. Form templates follow the limitations of the currently applied category and the user's security settings. Did any DOS compatibility layers exist for any UNIX-like systems before DOS started to become outmoded? You can only create it; you cannot query or update it. Each entity description includes the following information: 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. Every attempt gives me a 500 server error. By rejecting non-essential cookies, Reddit may still use certain cookies to ensure the proper functionality of our platform. This entity describes an Autotask Ticket. If no value is provided for Ticket.Source when a ticket is created via the API, the default Source value is returned on update. 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. Want to talk about it? Ticket cannot be created with an inactive TicketCategory. Entity details You can also retrieve this information with the Web Services API call The getEntityInfo () SOAP API call. The Autotask REST API presents selected Autotask resources as programming objects that allow the client to perform actions on them. The function of this entity is to describe the associations between Change Request tickets and both Incidents and Problems. In Autotask, sales orders are associated to Opportunities. Where does this (supposedly) Gibson quote come from? This entity represents associations between assets and documents in Autotask. window.open(uri); IMPORTANT Selecting a form template is the equivalent of manually populating the form. /*]]>*/Want to tell us more? It does not describe transactions where an Inventory Item is associated with a Company as an Asset. This entity describes an internal cost created for a resource-role combination for time entries on a specified contract. It shows the Task Number or Ticket Number, Task Title or Ticket Title, and Company fields, plus the quick copy icons. Resource access URLs for all entities appear in the next section of this article. Refer to Web Services APIsecurity settings. 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. 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. Each of the entities inherits from the Autotask base class Entity. 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. UDF changes are included in the criteria for updating LastTrackedModificationDate. 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. Incidents on Change Request tickets will not be updated. 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. For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed. Press question mark to learn the rest of the keyboard shortcuts. From the main navigation menu click Admin/Features & Settings. The nature of simulating nature: A Q&A with IBM Quantum researcher Dr. Jamie We've added a "Necessary cookies only" option to the cookie consent popup. update() is allowed on a Ticket with an inactive ContactID value if that value is not being changed, or if a new active value is assigned. Some fields on Entities require an id to a parent Entity. This entity's purpose is to describe a configurable alert message, associated with an account, that appears on different account-related pages. For more information about fields marked as picklists, review our Understanding picklists article. Review the setting of the Internal Only check box. When you enable the Organizational Structure feature in Autotask, this object describes an organizational structure Line of Business. When an inventory product is manually created, stocked items are also created. Any entities or attachments that the account creates will be attributed to "APIUser." One of these entities exists for every UDF that is set as visible on each asset category. This includes the category field itself. /*]]>*/Want to tell us more? Refer to the About entity fields section of this article for more information. Click on the context menu bar to the left of the Standard category the, click Edit. 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 describes an Autotask Quote Item. 5. The following table describes the standard Autotask field objects for this entity. The REST API permits you to retrieve values for all entity UDFs via the query method. This entity's purpose is to describe a cost associated with an Autotask contract. window.open(uri); Field is cleared when ticket comes out of Waiting Customer status and is recalculated every time ticket goes back into Waiting Customer status. Select OK to apply; Setup Extension Callout. You can configure API Only security levels to allow the impersonation of other resources on supported endpoints. Cost items can be billable or non-billable. 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. A new inactive ContactID value cannot be assigned on create() or update(). 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. function SendLinkByMail(href) { var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; 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. The value you select will be set as the status of the parent entity when the dialog box or page is saved. Action. Zapier's automation tools make it easy to connect Autotask and Microsoft Excel. Tickets and project tasks share the same list of statuses. You can only create it; you cannot query or update it. Tickets define service requests within the Autotask system. 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. In Picklist, an inactive TicketCategory displays in italic text. To subscribe to this RSS feed, copy and paste this URL into your RSS reader. Autotask Service Bundles group multiple Services for purchase. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; 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. 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. Access to version 1.6 will deactivate in Q4 2024. [CDATA[*/ This entity contains the categories that hold Knowledgebase articles in Autotask. 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. If a ticket already has checklist items, the checklist library is appended to the end of the list of checklist items. The selected recipients are added to the To: field; CC: and BCC: fields are not populated. Do new devs get fired if they can't solve a certain bug? By clicking Post Your Answer, you agree to our terms of service, privacy policy and cookie policy. Although you can query this entity, it contains one or more fields that are not queryable. Verify you support email. 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. /*]]>*/Want to tell us more? The AllocationCodeID field must reference a Work Type allocation code. Refer to The Rich Text editor to learn more. They can click New Ticket on the Autotask interface sub-navigation menu to open the New Ticket window. Tickets where Type = Service Request cannot be associated with a ProblemTicket ID. NOTE If the InstalledProduct value is not being updated, and for some reason it is already associated with an Account that is different from the Ticket Account, the update() will not fail. permission is required. This entity describes an Autotask Task. Contracts specify a billing arrangement with a Company. From the pull-down menu, When it is expanded on the New Note or New Time Entry form, the New Attachment dialog box will open automatically. Some entities support file attachments. This is an event a Zap performs. The Note Type field defaults to Task Summary. Invoice templates define the appearance and content of an invoice generated by Autotask. You can find these fields in the entity description under 'Fields that Cannot Be Queried.'. Service calls are instances of time, with specified start and stop times, that are scheduled to perform work for a Company.