Countries
This entity describes a Country as defined in the Autotask CRM module. The Countries entity is referenced by the Company, Contact, and Sales Order entities and specifies the preferred display name for the associated country as well as the default address format and invoice template to be used by accounts, contacts, and sales orders that reference the Country ID.
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: | Countries |
Entity Path: |
/atservicesrest/v1.0/Countries |
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
Conditions and requirements
- There must always be an active default country.
- Setting a new default country will automatically set isDefaultCountry to false for the existing default country (providing no validation errors occur).
Special field attributes
Field | Conditions and Requirements |
---|---|
purchaseOrderTemplateID | If purchaseOrderTemplateID is null in the database, the field will default to the system default purchase order template ID during query. |
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 |
---|---|---|---|---|---|
addressFormatID | long | ||||
countryCode | string (2) | ||||
displayName | string (100) | ||||
id | long | ||||
invoiceTemplateID | integer | InvoiceTemplates | |||
isActive | boolean | ||||
isDefaultCountry | boolean | ||||
name | string (50) | ||||
purchaseOrderTemplateID |
integer |
|
|
|
|
quoteTemplateID | integer | QuoteTemplates |