SalesOrders
This entity describes an Autotask Sales Order. In Autotask, a sales order is associated with an Opportunity and provides an option to track cost items generated from an Autotask Quote.
Sales orders are created automatically in Autotask when an Opportunity is closed using the Won Opportunity Wizard. Procurement must be enabled. Users can edit a sales order but cannot not manually create one.
NOTE In Autotask, Sales Orders are only available to users when the Procurement module is enabled. The SalesOrder entity is always available in the API.
NOTE You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.
Entity details
Entity Name: | SalesOrders |
Entity Path: |
/atservicesrest/v1.0/SalesOrders |
Parent Entity: |
|
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
Conditions and requirements
The ownerResourceID must reference an active, standard Autotask resource with security level access to the CRM module. A resource with a non-standard security level, for example, API user (API only), is not a valid selection for ownerResourceID.
Field definitions
The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:
- The entityInformation REST API call
- Making basic query calls to the REST API
- Advanced query features of the REST API
To learn how to query picklist endpoints, refer to Understanding picklists.
Notes
- For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
- LT indicates Local Term.
- If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
- You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name | Datatype |
Read-Only | Is Required | Reference Name | Picklist |
---|---|---|---|---|---|
additionalBillToAddressInformation | string (100) | ||||
additionalShipToAddressInformation | string (100) | ||||
billingAddress1 | string (150) | ||||
billingAddress2 | string (150) | ||||
billToCity | string (50) | ||||
billToCountryID | integer | Countries | |||
billToPostalCode | string (50) | ||||
billToState | string (50) | ||||
companyID | integer | Companies | |||
contactID | integer | Contacts | |||
id | integer | ||||
impersonatorCreatorResourceID | integer | Resources |
|
||
opportunityID | integer | Opportunities | |||
organizationalLevelAssociationID |
integer |
|
|
|
|
ownerResourceID | integer | Resources | |||
promisedFulfillmentDate | datetime | ||||
salesOrderDate | datetime | ||||
shipToAddress1 | string (150) | ||||
shipToAddress2 | string (150) | ||||
shipToCity | string (50) | ||||
shipToCountryID | integer | Countries | |||
shipToPostalCode | string (50) | ||||
shipToState | string (50) | ||||
status | integer | ||||
title | string (128) |