SOAP API revision history

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

AccountType cannot be changed from Vendor if the account is associated with any existing services.

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.

ContractHourlyRate, InternalCurrencyContractHourlyRate

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.

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.

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

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.

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.

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.

• The AlertText field is now required.

• The entity now supports Delete functionality.

• Users may only create, update, and delete alerts for accounts to which they have edit access.

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.

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.

ContractServiceID, ContractServiceBundleID, ContractServiceAdjustmentID, ContractServiceBundleAdjustmentID, ContractServiceBundlePeriodID, ContractServicePeriodID

The ActionType field is now required on entity creation.

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

This release ends support for the "sounds like" QueryXML function.

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.

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.

Refer to <EntityName>Webhook (SOAP API).

Refer to <EntityName>WebhookField (SOAP API).

Refer to <EntityName>WebhookUdfField (SOAP API).

This entity represents aliases for ticket and article tags in Autotask.

This entity represents ticket tag groups in Autotask.

This entity manages the tags associated with tickets in Autotask.

AttachmentInfo calls now support nested attachments on the Opportunity, Time Entry, Task or Ticket, Task or Ticket Note, Asset, and Asset Note entities.

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

CreatorType

The SOAP API now includes error handling logic for calls to unsupported user-defined fields (UDFs). To learn more about supported UDFs, refer to SOAP 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

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.

This release resolves an issue that could cause requests to the ContractServiceBundleAdjustment 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 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. The Deleted Ticket log enables you to view a listing of tickets that have been deleted from your system.

The ProductID field no longer requires a value if the DefaultInstalledProductCategoryID field on the Product entity contains one.

DefaultInstalledProductCategoryID

OpportunityID

CreatedByContactID

SortOrderID

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

CreatedByContactID

CreatedByContactID

The length of the Description field is now 8000.

CreatedByContactID

The length of the InternalNotes field is now 32000.

Changed reference for "ParentAccountID" from "InvoiceTemplate" to "Account"

LastTrackedModifiedDateTime

OverrideAccountTaxSettings

TaxRegionID

IsTaxExempt

Removed check mark for "Can update"

ApprovedTime

Changed data type for "id" from Int64 to "long"

Changed Datatype for "CreatorResourceID" from "long" to "integer"

ExecutionMethod

BusinessDivisionSubdivisionID

BusinessDivisionSubdivisionID

Cost, InternalCurrencyPrice and Price were changed from double to float

Calls no longer require a valid ID value to create a new asset. Upon receipt of a valid ID, the entity will copy the InstalledProductCategory value associated with that ID. If the call contains a zero/none/invalid ID value, the API will copy the default system category.

When associating the CI with a ContractService that contains no reference to ContractID, you can either supply info for the service (ServiceID or ContractServiceID) or the bundle (ServiceBundleID or ContractServiceBundleID) but not both.

If the API 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. All text formatting and images will be lost.

If the API 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. All text formatting and images will be lost.

CreatorResourceID

The SalesProcessPercentComplete data type has changed from "integer" to "double."

This entity describes notes created by an Autotask user and associated with a Product entity. Users can create, update, and query product notes via the API. The ability to create and update ProductNote entities in the API is governed by the user's security level permissions.

CreatedByResourceId

CreateDateTime

LastModifiedDateTime

LastModifiedByResourceID

CreatedByResourceId

CreateDateTime

CreatedByResourceId

CreateDateTime

LastModifiedByResourceID

LastModifiedDateTime

If the API 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. All text formatting and images will be lost.

This release resolves an issue which caused the Ticket Date user-defined field (UDF) to populate data in the American format (MM\DD\YYYY) instead of the DD/MM/YYYY format.

If the API 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. All text formatting and images will be lost.

Resources activated via the API, who have not yet set an account password, will now receive a Welcome email upon activation which instructs them to do so.

The API operators "IsNotNull" and "IsNull" will now treat fields containing spaces as null values.

InstalledProductType

InstalledProductTypeUdfAssociation

ImpersonatorCreatorResourceID

NOTE  All entities support query(), create(), and update() by the impersonator. Contact, AccountToDo, Subscription, AttachmentInfo (SOAP API) also support delete().

InstalledProductCategoryID
SourceCostType
SourceCostID

ReferenceNumber

Length value for the Comments field changed from 4000 to 2000.

Description
ImpersonatorCreatorResourceID

EligibleForRma

TaskCategoryID

ApprovedTime - this field was replaced by two new fields:
• PostedOnTime (records the date/time the billing item was actually posted
• PostedDate (indicates the date the user entered when the billing item was posted)