SOAP API lifecycle FAQ
IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will be deactivated.
This article explains the upcoming end-of-lifecycle milestones for version 1.6 of the Autotask SOAP API. It provides details about the lifecycle initiative, explains key dates and service changes, and provides guidance for migrating your integrations to SOAP 1.6 and REST.
Index
- What is the lifecycle initiative?
- How do I convert my integrations from SOAP to REST?
- BillingItem type and sub-type SOAP to REST mapping
What is the lifecycle initiative?
Version 1.0 of the Autotask SOAP API was originally developed in 2007, and it has enjoyed a long and venerable service life since then, receiving its most recent major updates in version 1.5 and version 1.6. For several years, Datto has kept both of these major versions of the SOAP API available in parallel for customer use.
As part of our ongoing commitment to continual service improvement, we continuously reevaluate our platform offerings to ensure that we're delivering maximum value to our customers. With the advent of more performant, secure, and industry-preferred API technologies such as REST, the Autotask SOAP API has entered its end-of-lifecycle phase.
To ensure continuity of your integration service, we recommend migrating your SOAP API applications to the REST platform.
How do I convert my integrations from SOAP to REST?
While there is no direct conversion path from SOAP to REST, as programming and scripting environments and implementations vary greatly, there are a number of different methods you can use to port your applications. We recommend migrating all of your integrations to REST via the method best suited to your specific needs.
Version 1.0 of the REST API was designed to be very similar to SOAP. It provides endpoints that correspond to SOAP entities so that the structure of an existing application can remain the same when translated to the REST architecture.
To learn more about the REST API, refer to Introduction to the Autotask REST API.
BillingItem type and sub-type SOAP to REST mapping
The type and sub-type picklist values for the BillingItem(s) endpoint differ between the Autotask SOAP and REST APIs. The following tables detail these changes.
Billing type mapping
| SOAP ID & billing type name | REST ID & billing type name |
|---|---|
|
1. Labor |
1. Labor |
|
1. Labor |
2. Labor Adjustment |
|
2. Project Cost |
3. Cost (ticket, project, contract) |
|
3. Ticket Cost |
3. Cost (ticket, project, contract) |
|
4. Expense |
4. Expense |
|
5. Subscription |
5. Subscription |
|
6. Setup Fee |
7. Recurring Contract Setup Fee |
|
7. Recurring Services |
6. Recurring Service/Bundle |
|
8. Recurring Services Adjustment |
6. Recurring Service/Bundle |
|
9. Recurring Service Bundle |
6. Recurring Service/Bundle |
|
10. Recurring Service Bundle Adjustment |
6. Recurring Service/Bundle |
|
11. Milestone |
8. Milestone |
|
12. Contract Block |
3. Cost (ticket, project, contract) |
|
13. Contract Retainer |
3. Cost (ticket, project, contract) |
|
14. Contract Cost |
3. Cost (ticket, project, contract) |
|
15. Contract Incident |
3. Cost (ticket, project, contract) |
Billing sub-type mapping
| SOAP ID & billing sub-type name | REST ID & billing sub-type name |
|---|---|
|
1. Labor |
1. Ticket Labor |
|
1. Labor |
2. Task Labor |
|
2. Milestone Labor |
3. Fixed Price Ticket Labor |
|
2. Milestone Labor |
4. Fixed Price Task Labor |
|
1. Labor |
5. Ticket Labor Adjustment |
|
1. Labor |
6. Task Labor Adjustment |
|
5. Ticket Cost Deductions |
7. Service Desk Ticket Cost |
|
6. Ticket Cost |
7. Service Desk Ticket Cost |
|
3. Project Cost Deductions |
8. Project Cost |
|
4. Project Cost |
8. Project Cost |
|
5. Ticket Cost Deductions |
9. Contract Cost |
|
7. Expense |
10. Expense |
|
8. Expense Deductions |
10. Expense |
|
9. Subscription |
11. Subscription |
|
10. Subscription Cost |
11. Subscription |
|
12. Recurring Services |
12. Recurring Services |
|
13. Recurring Services Adjustment |
13. Recurring Services Adjustment |
|
14. Recurring Service Bundle |
14. Recurring Service Bundle |
|
15. Recurring Service Bundle Adjustment |
15. Recurring Service Bundle Adjustment |
|
11. Setup Fee |
16. Setup Fee |
|
16. Milestones |
17. Milestone |
|
17. Block Purchase |
18. Block Purchase |
|
18. Retainer Purchase |
19. Retainer Purchase |
|
19. Ticket Purchase |
20. Ticket Purchase |
|
No SOAP Mapping |
21. Per Contact Cost |
|
No SOAP Mapping |
22. Per Installed Product Cost |
