Please enable JavaScript to view this site.

Navigation: Schema: CompanyLocationsChild > Tables

CompaniesByParentIdLocationsId

Catalog: Autotask

Schema: CompanyLocationsChild

This is a read-only table function. The Autotask API may not support changing the data or the Invantive SQL driver for Autotask does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Autotask API.

Select Autotask API URL: /V1.0/Companies/{parentId}/Locations/{id}

Insert Autotask API URL: /V1.0/Companies/{parentId}/Locations/{id}

Update Autotask API URL: /V1.0/Companies/{parentId}/Locations/{id}

Delete Autotask API URL: /V1.0/Companies/{parentId}/Locations/{id}

Field Selection Method: NotRequired

Base Path: item

Select Autotask API Operation: get /V1.0/Companies/{parentId}/Locations/{id}

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function CompaniesByParentIdLocationsId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

id

int64

 

 

parentId

int64

 

 

 

Columns of Table Function

The columns of the table function CompaniesByParentIdLocationsId are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

address1

string

Address 1

 

address2

string

Address 2

 

alternatePhone1

string

Alternate Phone 1

 

alternatePhone2

string

Alternate Phone 2

 

city

string

City

 

companyID

int32

Company ID

 

countryID

int32

Country ID

 

description

string

Description

 

fax

string

Fax

 

id

int64

ID

 

isActive

boolean

Is Active

 

isPrimary

boolean

Is Primary

 

isTaxExempt

boolean

Is Tax Exempt

 

name

string

Name

 

overrideCompanyTaxSettings

boolean

Override Company Tax Settings

 

phone

string

Phone

 

postalCode

string

Postal Code

 

roundtripDistance

double

Roundtrip Distance

 

soapParentPropertyId_body_canReduce

boolean

 

 

soapParentPropertyId_body_nodeType

string

 

 

soapParentPropertyId_body_type

string

 

 

soapParentPropertyId_canReduce

boolean

 

 

soapParentPropertyId_name

string

 

 

soapParentPropertyId_nodeType

string

 

 

soapParentPropertyId_returnType

string

 

 

soapParentPropertyId_tailCall

boolean

 

 

soapParentPropertyId_type

string

 

 

state

string

State

 

taxRegionID

int32

Tax Region ID

 

 

22-09-2022 21:52 Version 22.0.355-PROD+3587