Country
IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. Access deactivation for version 1.5 began in Q1 2022 and will enter its concluding phases in October 2022. Access to version 1.6 will be deactivated in Q4 2024. Visit our SOAP API lifecycle FAQ article to learn more.
This entity describes a Country as defined in the Autotask CRM module. The Country entity is referenced by the Account, 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.
Entity details
You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.
| Entity Name: | Country |
| 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
About this table
The following table describes the standard Autotask field objects for this entity.
- To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
- For information on entity UDFs, use getUDFInfo().
- For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
- LT indicates Local Term.
For more information about fields marked as picklists, review our Understanding picklists article.
| Field Name | Label | Datatype | Read Only | Is Required | Reference Name | Picklist |
|---|---|---|---|---|---|---|
| Active | Active | boolean | ||||
| AddressFormatID | Address Format ID | long |
|
|
||
| CountryCode | Country Code | string (2) |
|
|||
| DisplayName | Display Name | string (100) |
|
|||
| id | Country ID | long |
|
|
||
| InvoiceTemplateID | Invoice Template ID | integer | InvoiceTemplate | |||
| IsDefaultCountry | Default Country | boolean | ||||
| Name | ISO Standard Name | string (50) |
|
|||
| PurchaseOrderTemplateID | Purchase Order Template ID | integer |
|
|
|
|
| QuoteTemplateID | Quote Template ID | integer | QuoteTemplate |
