Location groups categorize location dimension records, mainly for the purpose of structuring financial reporting.


Get Location Group Object Definition

lookup

List all the fields and relationships for the location group object:

<lookup>
    <object>LOCATIONGROUP</object>
</lookup>

Parameters

Name Required Type Description
object Required string Use LOCATIONGROUP

List Location Groups

query

List the ID, name, and record number for each location group:

<query>
    <object>LOCATIONGROUP</object>
    <select>
        <field>ID</field>
        <field>NAME</field>
        <field>RECORDNO</field>
    </select>
</query>

Parameters

Name Required Type Description
object Required string Use LOCATIONGROUP
select Required sequence One or more field names and an optional aggregate function such as count or sum. Returning all fields is not supported.
filter Optional object Query filter expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
        <field>RECORDNO</field>
        <descending/>
</order>
options Optional object Set the caseinsensitive element to true for a case-insensitive query:
    <caseinsensitive>true</caseinsensitive>
In a multi-entity company, set the showprivate element to true to query data in private entities:
   <showprivate>true</showprivate>
pagesize Optional integer Custom page size between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

List Location Groups (Legacy)

readByQuery

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

Parameters

Name Required Type Description
object Required string Use LOCATIONGROUP
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. The following operators are supported: <, >, >=, <=, =, like, not like, in, not in, IS NOT NULL, IS NULL, AND, OR. Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli'). Joins are not supported.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

Get Location Group

read

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

Parameters

Name Required Type Description
object Required string Use LOCATIONGROUP
keys Required string Group RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Get Location Group by Name

readByName

<readByName>
    <object>LOCATIONGROUP</object>
    <keys>TEST</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use LOCATIONGROUP
keys Required string Group ID to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Provide feedback