REST API revision history

catalogNumberPartNumber

externalID

internalID

manufacturerServiceProvider

manufacturerServiceProviderProductNumber

sku

url

catalogNumberPartNumber

externalID

internalID

manufacturerServiceProvider

manufacturerServiceProviderProductNumber

sku

url

ImpersonatorApproveRejectResourceID

lastApprovedLevel

This entity entity identifies time off approvers for a resource and their approval level.

On Query(), if the contract service or bundle is configured to Use Standard Invoice Description in the UI, we will return the service/bundle’s invoice description from Admin. Otherwise we will return the custom invoice description value.

On Create() or Update(), if

• no invoiceDescription value is supplied in the request, we will set the ContractService or ContractServiceBundle to Use Standard Invoice Description in the UI.

• Supplying an invoice description value matching the service/bundle’s invoice description in Admin will set the ContractService or ContractServiceBundle to Use Standard Invoice Description in the UI.

• Supplying any other value for invoice description will set the ContractService or ContractServiceBundle to Customize Invoice Description for this Contract” in the UI.

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 remaining time off a resource has accrued or has been allotted, according to their assigned Time Off Policy. You will be able to query the entity by resourceId or a combination of resourceId and year.

We fixed an issue where, when creating a charge associated to an inventory item via the REST API, you automatically received the Items Requested have been APPROVED email message despite the item not being approved.

With the release of Autotask 2023.1, requests to the API now have a thread limit of three per object endpoint and tracking identifier. For more information, refer to API thread limiting.

The length of the below entity fields has been increased to the following values:

• address1: 150 characters

• address2: 128 characters

• city: 30 characters

• state: 40 characters

• postalCode: 30 characters

Previously, due to an inconsistency with the response model generated by Swagger, tools such as Visual Studio and NSwagStudio returned "System.InvalidOperationException" errors when sending Delete requests to Attachment entities. This issue is now resolved.

companyType cannot be changed from vendor if the account is associated with any existing services.

contractHourlyRate, internalCurrencyContractHourlyRate

When a purchase order has been received in full, you can still use the purchaseOrderItemReceive call to receive more items than originally ordered. This enhancement creates parity with the functionality of the Autotask UI.

To create parity with the behavior of the Autotask UI, the API will now round the unitQuantity, unitCost, and unitPrice values for this entity to 4 decimal places prior to any calculations for the total price or extended cost.

createdByResourceID, createdTime

Previously, it was possible to change the serialized value for products associated with existing inventory. Doing so could lead to crashes and the creation of bad data. Now, the API will return an error if it receives a request to change this value when there is existing inventory.

To create parity with the behavior of the Autotask UI, the API will now round the unitQuantity, unitCost, and unitPrice values for this entity to 4 decimal places prior to any calculations for the total price or extended cost.

This release resolves an issue that could cause Autotask to write bad data or crash after receiving non-serialized products on a purchase order.

When a purchase order has been received in full, you can still use the purchaseOrderItemReceive entity to receive more items than originally ordered. This enhancement creates parity with the functionality of the Autotask UI.

To create parity with the behavior of the Autotask UI, the API will now round the unitQuantity, unitCost, and unitPrice values for this entity to 4 decimal places prior to any calculations for the total price or extended cost.

We have resolved an issue that could cause the API to remove time entries upon receipt of an update request containing a value other than 00:00:0. Now, the entity will now set the value of the dateWorked field to midnight upon receiving an update request.

If a time entry is created or updated with a contractID and the ticket's sub-issue type is excluded on the contract, then the time entry's contractID will be updated to that of the exclusion contract, if it exists. If it does not exist, the contractID will be set to null.

productID field: If the configuration item was sourced from an InventoryStockedItems entity, its product ID will be tied to the product ID of the inventory Item and cannot be changed via the API

serialNumber field: If the configuration item was sourced from an InventoryStockedItems entity, the serial number will come from the inventoryStockedItem. If the serial number is updated via the API, the serial number for the related inventoryStockedItem will also be updated.

We have resolved an issue that caused the ContractServices entity to use the Number Format of the API resource when setting the adjusted price instead of assuming a decimal point for the decimal separator.

The inventoryItemID field datatype has changed from long to integer.

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.).

This entity describes detailed information about on-hand InventoryProducts at a location.

This entity enables you to increase inventory counts associated with the InventoryProducts entity.

This entity enables you to decrease inventory counts associated with the InventoryProducts entity.

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.

• During update, the vendorInvoiceNumber field will act as read-only if any items on the purchase order have been received.

• During query, this field will return the vendor invoice number associated directly with the purchase order, if one exists. Otherwise, the field will return the vendor invoice number associated with receipt of the first item on the purchase order.

• When filtering, this field will do so on both the vendorInvoiceNumber and the additionalVendorInvoiceNumbers fields. For more information, refer to PurchaseOrders.

When attempting to delete a UDF from the Contract History page by passing "" in place of a null value, the API would return the error message, "Deleted row information cannot be accessed through the row," while still removing the UDF value. We have updated the tracking history logic for all UDF data types and certain base fields on this entity to resolve the issue.

This entity contains existing associations between Knowledgebase articles and assets.

This entity contains notes for Knowledgebase articles in Autotask.

This entity contains the plain text version of body content held by a Knowledgebase article.

This entity records existing associations between tags and Knowledgebase articles in Autotask.

This entity records existing associations between tickets and Knowledgebase articles in Autotask.

This entity represents associations between Knowledgebase articles within Autotask.

This entity represents articles associated with Knowledgebase documents in Autotask.

We have made several changes to the behavior and fields of SOAP and REST API entities. Future changes will be introduced in maintenance releases. Refer Changes to Attachment entities for more information.

Improvements to the behavior of the AttachmentInfo (REST API) entity have rendered the AttachmentNestedAttachments endpoint unnecessary. This release removes it.

To improve application performance when paginating very large query returns, the API will only retain history for the 50 most recently viewed pages. For more information, refer to Advanced query features of the REST API > Pagination limits.

contractServiceID, contractServiceBundleID, contractServiceAdjustmentID, contractServiceBundleAdjustmentID, contractServiceBundlePeriodID, contractServicePeriodID

To create or update children of this entity, your API user must have Approve permissions for Documents.

This entity represents documents associated with Knowledgebase articles in Autotask.

This entity represents articles created by Knowledgebase users in Autotask.

This entity contains the categories that hold Knowledgebase articles in Autotask.

You can now view API activity and threshold information by using the API Activity by Hour report in Autotask.

This release enhances the API's handling of users who do not have access to view cost data in the UI. The averageCost, cost, extendedCost, highestCost, internalCurrencyUnitCost, ourCost, and vendorCost entity fields will return no data for queries with insufficient privileges. If an update request does not have the necessary permissions, the API will ignore the call's values for these fields even if they are blank or would be otherwise required.

purchaseOrderTemplateID

The actionType field is now required on entity creation.

This entity describes DNS records associated with the ConfigurationItems entity in Autotask.

This entity contains SSL Subject Alternative Name (SAN) records associated with the ConfigurationItemsentity in Autotask.

Refer to <EntityName>WebhookExcludedResources (REST).

Refer to <EntityName>WebhookFields (REST API).

Refer to <EntityName>Webhooks (REST API).

Refer to <EntityName>WebhookUdfFields (REST API).

This release resolves an issue which could allow non-date information to be stored in the entity's startDate and endDate fields.

This release resolves an issue which could allow non-date information to be stored in the entity's startDate and endDate fields.

This release resolves an issue which could allow non-date information to be stored in the entity's startDate and endDate fields.

This entity contains attachments for documents in Autotask.

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.

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 aliases for ticket and article tags in Autotask.

This entity represents ticket and article tags in Autotask.

This entity manages the tags associated with tickets in Autotask.

The attachedByContactID field is no longer required nor read-only.

creatorType

The AttachmentNestedAttachments entity describes a nested attachment in Autotask. A nested attachment is any external document that is attached to a Company, Task, Ticket, Task or Ticket Note, Time Entry, Asset, Asset Note, Project, or Opportunity entity. Attachments in Autotask can be documents uploaded to the server, file links, folder links, and URLs.

The REST API now includes error handling logic for calls to unsupported user-defined fields (UDFs). To learn more about supported UDFs, refer to REST API: User-defined fields (UDFs).

This release introduces error handling for calls containing more than 500 OR conditions. The API will return an error state for calls that exceed this threshold. To learn more, refer to Call conditions limit

This release resolves an issue that caused some JSON responses in Swagger UI to be missing their item or items fields.

If an API user account without the Contacts impersonation option enabled attempts to specify a custom value for the attachedByContactID or the createdByContactID field, any entities or attachments that the account creates will be attributed to "API User." Refer to SOAP API lifecycle FAQ to learn about additional changes in SOAP that may inform your API development strategy.

The lineItemID field is now sortOrderId.

The length of the ItemName field is now 600.

creatorType

The overrideAccountTaxSettings field is now overrideCompanyTaxSettings.

This entity contains the attachments for the CompanyNotes entity.

This entity contains the attachments for the ConfigurationItems entity.

This entity contains the attachments for the ConfigurationItemNotes entity.

This entity contains the attachments for the ContractNotes entity.

This release resolves an issue that could cause requests to the ContractServiceBundleAdjustments entity to fail if a contractID value was not present.

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.

This entity contains the records for the Deleted Ticket Activity journal located in the Autotask application at > Admin > Features and Settings > Projects & Tasks > Deleted Task Activity Log. The Deleted Ticket Activity log provides a list of ticket time entries, notes, and attachments that were deleted from your system.

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.

This entity contains the attachments for the ExpenseReports entity.

creatorType

Previously, when calling the ProductNotes entity, users received the error message, "Value cannot be null." This issue has been resolved.

defaultInstalledProductCategoryID

creatorType

This entity contains the attachments for the ProjectNotes entity.

createdByContactID

opportunityID

sortOrderID

This entity contains the attachments for the Resources entity.

This entity contains the attachments for the SalesOrders entity.

creatorType

This entity contains the attachments for the TaskNotes entity.

createdByContactID

This release resolves an issue that prevented the API from correctly updating the Duration (days) field of the Task page in Autotask.

creatorType

The length of the description field is now 8000.

This entity contains the attachments for the TicketNotes entity.

createdByContactID

createdByContactID

Previously, the datatype for the monitorID field was "integer." It is now "long."

The length of the internalNotes field is now 32000.

The length of the summaryNotes field is now 32000.