Location is a dimension that can be defined by the company and set on transactions to expand report functionality and insight.


List Locations

readByQuery

<readByQuery>
    <object>LOCATION</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use LOCATION
fields Required string Comma separated list of fields on the object to list. Use * to return all fields.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Set a custom page size between 1 and 1000 items (Default: 100)

query

Name Required Type Description
STATUS Optional string Status. Use T for Active and F for Inactive.

Get Location

read

<read>
    <object>LOCATION</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use LOCATION
keys Required string The location RECORDNO to get
fields Required string Comma separated list of fields on the object to get. Use * to return all fields.

Get Location by Name

readByName

<readByName>
    <object>LOCATION</object>
    <keys>110-SJC</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use LOCATION
keys Required string The location LOCATIONID to get
fields Required string Comma separated list of fields on the object to get. Use * to return all fields.

Create Location

create

<create>
    <LOCATION>
        <LOCATIONID>110-SJC</LOCATIONID>
        <NAME>San Jose CA</NAME>
        <PARENTID>100-US</PARENTID>
        <SUPERVISORID>E1010</SUPERVISORID>
        <CONTACTINFO>
            <CONTACTNAME>Smith, John</CONTACTNAME>
        </CONTACTINFO>
        <SHIPTO>
            <CONTACTNAME>Smith, Jane</CONTACTNAME>
        </SHIPTO>
        <STARTDATE>01/01/2000</STARTDATE>
        <ENDDATE></ENDDATE>
        <CUSTTITLE></CUSTTITLE>
        <STATUS>active</STATUS>
    </LOCATION>
</create>

Parameters

Name Required Type Description
LOCATION Optional object The object to create

LOCATION

Name Required Type Description
LOCATIONID Required string The location ID to create
NAME Required string Location name
PARENTID Optional string Parent location ID
SUPERVISORID Optional string Manager employee ID
CONTACTINFO Optional object Primary contact info
SHIPTO Optional object Ship to contact info
STARTDATE Optional string Start date in format mm/dd/yyyy
ENDDATE Optional string End date in format mm/dd/yyyy
CUSTTITLE Optional string Location title for reporting
STATUS Optional string Location status. Use active for Active otherwise use inactive for Inactive (Default: active)

CONTACTINFO

Name Required Type Description
CONTACTNAME Required string Contact name

SHIPTO

Name Required Type Description
CONTACTNAME Required string Contact name

Update Location

update

<update>
    <LOCATION>
        <RECORDNO>212</RECORDNO>
        <NAME>San Jose CA</NAME>
        <PARENTID></PARENTID>
        <SUPERVISORID></SUPERVISORID>
        <CONTACTINFO>
            <CONTACTNAME></CONTACTNAME>
        </CONTACTINFO>
        <SHIPTO>
            <CONTACTNAME></CONTACTNAME>
        </SHIPTO>
        <STARTDATE></STARTDATE>
        <ENDDATE></ENDDATE>
        <CUSTTITLE></CUSTTITLE>
        <STATUS>active</STATUS>
    </LOCATION>
</update>

Parameters

Name Required Type Description
LOCATION Optional object The object to update

LOCATION

Name Required Type Description
RECORDNO Required integer Record number of location
NAME Required string Location name
PARENTID Optional string Parent location ID
SUPERVISORID Optional string Manager employee ID
CONTACTINFO Optional object Primary contact info
SHIPTO Optional object Ship to contact info
STARTDATE Optional string Start date in format mm/dd/yyyy
ENDDATE Optional string End date in format mm/dd/yyyy
CUSTTITLE Optional string Location title for reporting
STATUS Optional string Location status. Use active for Active otherwise use inactive for Inactive (Default: active)

CONTACTINFO

Name Required Type Description
CONTACTNAME Required string Contact name

SHIPTO

Name Required Type Description
CONTACTNAME Required string Contact name

Delete Location

delete

<delete>
    <object>LOCATION</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use LOCATION
keys Required string The location RECORDNO to delete

Provide feedback