Selecting a Note Type populates the Publish To field of the note, but this default can be overridden. 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). Access to version 1.6 will deactivate in Q4 2024. resource and child collection access URLs, Resource and child collection access URLs, Finding resource and child access URLs of REST API entities, Allow impersonation of resources with this security level, ArticleConfigurationItemCategoryAssociations, WebhookExcludedResources (REST), ConfigurationItemBillingProductAssociations, Using Swagger UIto explore REST API requests, Need troubleshooting help? Refer to. A subreddit for users of Autotask Professional Services Automation tool. ProjectID must be associated with the same Account as the Ticket (Ticket.AccountID). ChangeInfoFields are available regardless of whether they are Active or Inactive. Come try it. The Entities list provides a link to additional information about the entity and its standard Autotask fields. This entity's purpose is to describe a list item associated with a UserDefinedFieldDefinition entity that has dataType = List. This entity describes an Autotask Block Hour Factor, an option used with Block Hour type Contracts. Verify you support email. Refer to Autotask Integration and Monitors. Visit the Ideas forum! This is an event a Zap performs. Tracks updates to any field except changes to the LastActivityDate, LastCustomerNotificationDateTime, LastCustomerVisibleActivityDateTime. window.open(uri); It has code to get popular entities like accounts, tickets, contacts etc. Refer to Running a global notes search. Set up the Autotask trigger, and make magic happen automatically in Microsoft Excel. The client can access and act on the entity's field parameters: supplying, updating, or deleting the field data. This entity describes an Autotask Company. This entity describes an Autotask Company Contact that has access permissions for the Client Access Portal. For information about dialog boxes and how they differ from browser pages, refer to Minimizing Dialog Boxes. Such ticket categories are hidden everywhere you select a ticket category . This check box is enabled when the Internal check box is selected. If the API receives an invalid prefix, it will automatically generate one and assign it to the resource. Best Practice but optional: Set up Workplace-specific queue, ticket source, issues and sub-issues in Autotask. This entity's purpose is to describe a location associated with an Autotask Quote that defines address information for a shipToLocationID and/or billToLocationID. Everything else looks correct! The Autotask REST API presents selected Autotask resources as programming objects that allow the client to perform actions on them. The stopwatch starts running as soon as you open the task, ticket or time entry page. window.open(uri); Configure your support email address. This entity enables you to decrease inventory counts associated with the InventoryProducts entity. Select OK to apply; Setup Extension Callout. Entity details You can also retrieve this information with the Web Services API call The getEntityInfo () SOAP API call. Incidents on Change Request tickets will not be updated. This entity's purpose is to describe a Service entity assigned to a ServiceBundle entity. Access deactivation for version 1.5 began in Q1 2022 and will enter its concluding phases in October 2022. Billing milestones define tangible work or measured progress that must be completed before billing can take place. When you enable the Organizational Structure feature in Autotask, this object describes an organizational structure Line of Business. Three read only fields, MonitorID, MonitorTypeID, and RMMAlertID are currently available for use by the Autotask RMM integration only. 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. This data will not change during update operations. Refer to Creating Knowledgebase articles from tickets. Within Autotask navigate to Homepage > Admin > Features & Settings; Tip - click the images to make them larger. This entity contains the attachments for the TicketNotes entity. window.open(uri); In addition, a stumbling block I noted was to double check the AssignedResourceID has the actual role assigned via AssignedResourceRoleID. If the current priority is inactive, update() is allowed if the Priority value is not changed, or if Priority is changed to an active value. 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. The attachments will only be added to the incidents of problem tickets, not incidents of Change Request tickets. NAVIGATION Find centralized, trusted content and collaborate around the technologies you use most. If you send the content back, the Rich Text and all images that it contains will be lost. Set up a mailbox in Autotask. If the Contract Service or Bundle is associated to an SLA, then use that ID. This entity represents associations between assets and documents in Autotask. If a value is not provided for ChangeApprovalType: For the ContactID field, Contact.AccountID must = Ticket.AccountID or the ParentAccountID of Ticket.AccountID. Refer to Finding resource and child access URLs of REST API entities to learn how to locate these paths. If a form template uses a value or provides content that is not allowed in a field by the category or the user's security settings, the field will not be updated. If the ticket has at least one incomplete to-do, and the value in this field is changed to, Time entries only: If the status is changed to, If you have not changed the status, clicking this link will update the, If the note was created by a Client Portal user, only the value, If the note was created by a Taskfire user, only the value. Any entities or attachments that the account creates will be attributed to "APIUser." /*]]>*/Want to tell us more? You can individually configure the following entities to allow querying, adding, editing, and deleting (bold items only): For more information about impersonation security levels, refer to Allow impersonation of resources with this security level. 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. 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. This entity describes an internal cost created for a resource-role combination for time entries on a specified contract. Have an idea for a new feature? /*]]>*/Want to tell us more? 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. This entity describes one or more Autotask Assets (previously known as Configuration Items) assigned to a Ticket beyond the primary asset(ticket.configurationItemID). You may also update UDFs for entity types that allow update and create. You can also retrieve this information with the Web Services API call The getEntityInfo() SOAPAPIcall. For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed. We're using Power Apps to capture information and then Flow passes it to Autotask, i can pull information using GET but unable to create anything. 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. It allows you to configure tiered or volume pricing for the billing product. The Deleted Ticket Activity log provides a list of ticket time entries, notes, and attachments that were deleted from your system. Access deactivation for version 1.5 began in Q1 2022 and will enter its concluding phases in October 2022. This entity allows all items in a checklist library to be added to a ticket. Update Status on {#} incident(s) (tickets only). All active note types of the category Task are available, plus the current selection even if it is inactive. The current data is loaded when the section is first expanded. 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. function SendLinkByMail(href) { This entity contains the attachments for the ContractNotes entity. This article provides a general technical overview and index of the resources (entities)that you can access via the AutotaskRESTAPI. If the time entry dialog box is open for a long time, the Quick Edit fields can be changed by another user or a workflow rule. Thanks for your feedback. They are saved as replies to the note or time entry they are added to. Roles are associated with a department, have a standard billing rate, and are assigned to resources for billing purposes. https://www.autotask.com/, Press J to jump to the feed. User-defined fields are custom fields that each Autotask customer can add to their Company, Contact, Opportunity, Sales Order, Projects, Products, Assets, Ticket, and Tasktables. Assets are products that are associated with a Company entity. This entity describes an Attachment in Autotask. Changes made to the Contract by using the ContractServiceBundleAdjustment entity affect only the quantity of Contract Service units. 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. Saves the note or time entry and closes the dialog box. Review the setting of the Internal Only check box. Access to version 1.6 will deactivate in Q4 2024. } If the ticket category = 'RMA', and no value is supplied for the Contact field, it will be set to the contact of the supplied asset. Entity details You can also retrieve this information with the Web Services API call The getEntityInfo () SOAP API call. This entity's purpose is to describe a billing Role that has been excluded from a Contract. ExpenseItem.AccountID is updated and ExpenseItem.ProjectID, ExpenseItem.TaskID, or ExpenseItem.TicketID is set to Null. This entity's purpose is to describe a transaction where a specified quantity of one Inventory Item entity transfers from the items currently assigned Inventory location to another Inventory location. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; NOTE When opened from the Ticket Time Entry dialog box or page, you can select the Internal Only check box. [CDATA[*/ If the ticket category has only the due date or only the due time configured, then the API Ticket.DueDateTime will be required, and not supplying a value will return an error message. window.open(uri); When an inventory product is manually created, stocked items are also created. 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. window.open(uri); 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 includes the category field itself. This entity contains attachments for the Opportunities entity. Create Quote. This entity describes an Autotask Allocation Code. Creating titles using key words will allow you to find notes later in lists and searches. The allowed actions are specific to the object. Notes published to All Autotask Users are visible to customers. /*]]>*/Want to tell us more? You cannot use the API to create items that contain Rich Text, but you can add Rich Text later via a supported method. How do I align things in the following tabular environment? Resolution: After playing with some items and looking through the module code and Postman, everything needs to be treated as a string: Thanks to u/nutter91 for the assistance with submitting a record ID of 0 for new records and reminding me to simplify things. If the ticket category was configured to display them, additional ticket fields appear in this section on time entries and notes. ConfigurationItemWebhookExcludedResources. This entity describes visual identifiers that you can use to categorize and search for Companies. Quote Items define a line item added to an Autotask Quote. Action. This entity describes an Autotask Contract Block which represents a block of hours purchased for a Block Hour type Contract. Need troubleshooting help? Contracts specify a billing arrangement with a Company. The ArticleTicketAssociations entity records existing associations between tickets and Knowledgebase articles in Autotask. This entity's purpose is to describe a Contact associated with a ContactGroup. Every attempt gives me a 500 server error. 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. This entity describes the pricing and costing tiers for a specific billing product on the Product table. A place where magic is studied and practiced? This entity's purpose is to describe a billing role that is excluded from the contract to which the set applies. If an association is removed from a resource and that pairing is set as the default, that default is not removed. Please open the solution (the C# one) in Visual Studio and work with the sample code there. This entity describes an Autotask Department. 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. Autotask users manage Tickets through a number of modules including Service Desk, Home, CRM, and Contracts. /*]]>*/Want to tell us more? Provide feedback for the Documentation team. Please see the general Autotask PSA Web Services On-line help at: https://ww2.autotask.net/help/DeveloperHelp/Content/AdminSetup/2ExtensionsIntegrations/APIs/SOAP/SOAPHome.htm About Examples using the Autotask API Readme MIT license 25 stars 11 watching 13 forks Releases No releases published Packages No packages published Contributors 3 Languages This entity describes an Autotask Appointment,a scheduled calendar time that is not a service call. This entity describes an instance of hardware, software, or a material item in Autotask that a company sells or supports for customers. Open the Kaseya Helpdesk. The note will only be added to the incidents of problem tickets, not incidents of Change Request tickets. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; NOTE Although the Autotask interface now allows multiple resources on a ticket, the current versions of the Web Services API do not support this feature. Making statements based on opinion; back them up with references or personal experience. Open the Kaseya Helpdesk. You can modify the ticket category to ensure that the section is expanded when the time entry or note is first opened and that required fields are completed. Is there any way for you to see what the response from Autotask is? I know I have correctly authenticated and set the BaseURI because I can get company information for customers. This entity's purpose is to describe a billing milestone for an Autotask Fixed Price type Contract. This entity contains attachments for documents in Autotask. . This entity's purpose is to describe a geographic area where billing items have the same tax rate. The Web Services API stores and returns all time data in Coordinated Universal Time (UTC). On the Note dialog box or page, this check box is missing and the attachment inherits the setting of the note. The following results have been performed on the sandbox of Autotask, to which I have a RTT of about 150-180MS. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; IMPORTANT Fields that are not visible cannot be validated. This entity is only used by multi-currency databases. Provide feedback for the Documentation team. } This entity describes list items added to a check list on an Autotask ticket or task. The following table describes the standard Autotask field objects for this entity. Need troubleshooting help? /*]]>*/Want to tell us more? If setting equals 'Always', the API will always require the QueueID value. This entity describes an Autotask Quote Template that defines the content and appearance of an Autotask Quote. It allows users to track and manage Inventory Items created from Autotask Products that require a unique serial number. This entity represents documents associated with Knowledgebase articles in Autotask. Changes made to the Contract by using the ContractServiceAdjustment entity affect only the quantity of units. To subscribe to this RSS feed, copy and paste this URL into your RSS reader. These accounts are free of charge, but they do not provide access to the Autotask UI. The function of this entity is to describe the mapping of the Asset (Configuration Item) to the contract billing rule. For more information or technical support about how to configure settings on the Autotask website, see the Autotask documentation. For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed. This entity surfaces the Autotaskversion number. /**/Want to tell us more? This entity represents ticket tag groups in Autotask. Visit our SOAPAPIlifecycle FAQ article to learn more. 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 RESTAPI. If setting equals 'RequiredWhenPrimaryResourceIdBlank', then the API will produce an error when both the QueueID and ResourceID fields are empty. The Autotask REST API presents selected Autotask resources as programming objects that allow the client to perform actions on them. /**/Want to tell us more? There were some field name changes between the Soap and REST API, can you try all the same but replace the accountId field with companyId? It allows you to create, query, and update expense line items through the API. IMPORTANT By default, notes and time entry pages launched from a task or ticket in New, Edit, or View mode open in a modal dialog box. This entity describes an approved and posted billable item in Autotask. The time zone and holiday set of the associated location are applied to the resource's time entries and schedules. This object describes notes created by an Autotask user and associated to a Project entity. How can I explain to my manager that a project he wishes to undertake cannot be performed by the team? 1. ProblemTicketID cannot = TicketID of a ticket that is already associated with a ProblemTicketID; that is, an incident ticket already associated with a problem ticket cannot become a problem ticket. This entity's purpose is to describe a template that defines the content and appearance of an Autotask Invoice. Cost items can be billable or non-billable. function SendLinkByMail(href) { 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. A Resource + Role combination assigned to a ticket must be associated with at least one Service Desk Queue. This entity represents checklist libraries related to documents in Autotask. function SendLinkByMail(href) { The function of this entity is to describe the mapping of the contact to the contract billing rule. This entity is only used by multi-currency databases. Notes can be searched and viewed from one place using the Global Notes Search, accessed from > Home >Search > Global Notes Search or > Reports > Other >General. NOTE If the Ticket Note or Ticket Time Entry page is opened from the Edit Ticket page, Forward/Modify is disabled. 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. From the main navigation menu click Admin/Features & Settings. This entity contains the attachments for the. Some resources contain additional objects in child collections; these resources have an additional Child collection access URLs field in their Online Help articles. If selected, only internal Autotask resources will be able to view the note, and the, you opened the Time Entry or Note page from the Edit Ticket page, you don't have permission to edit tickets. Thanks for your feedback. This entity contains attachments for the Tickets entity. I use the Powershell API to create tickets based on an Excel spreadsheet. NOTE Not all entities use UDFs. A time entry allows an Autotask resource to enter ticket and task time (Labor) and general or regular time (non-customer facing time). [CDATA[*/ This entity's purpose is to describe a line item associated with an Expense Report entity. An attempt to create a Ticket using a Resource + Role combination with an inactive Role will trigger an error. Refer to WebhookUdfFields (RESTAPI). A Department is an association the application can use to manage resources, especially when assigning project tasks. For the OpportunityID field, Opportunity.AccountID must = Ticket.AccountID. This check box only appears for notes and time entries on problem tickets associated with one or more incidents. This entity is only used by multi-currency databases. This entity is only used by multi-currency databases. LOB security is respected in the API. [CDATA[*/ This entity describes an Autotask Service added to a Recurring Service contract. Does ZnSO4 + H2 at high pressure reverses to Zn + H2SO4? Click on Service Desk/Ticket Categories. The function of this entity is to describe the relationship between an asset category and a specific UDF. If it is selected, you can update the status of all incidents. Site design / logo 2023 Stack Exchange Inc; user contributions licensed under CC BY-SA. This entity's purpose is to describe a Country as defined in the Autotask CRM module. Ticket.AccountID cannot be changed if the ticket has an associated and posted TimeEntry, TicketCost, or Expense. The following table describes the standard Autotask field objects for this entity. This resource describes contract billing rules that generate charges which allow you to bill your customer by the end user or by the asset. For more information, refer to Notification panel. } This entity describes an Autotask Role. If there is no Contract Service or Bundle SLA, then check the Contract.