Entity is a type of location (a dimension) that is available in multi-entity shared companies only.

An entity can represent a business unit, company, division, legal entity, offices, and so forth.


List Entities

readByQuery

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

Parameters

Name Required Type Description
object Required string Use LOCATIONENTITY
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. 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 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 Entity

read

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

Parameters

Name Required Type Description
object Required string Use LOCATIONENTITY
keys Required string Department 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 Entity by Name

readByName

<readByName>
    <object>LOCATIONENTITY</object>
    <keys>100-US</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use LOCATIONENTITY
keys Required string Department DEPARTMENTID 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.

List Entity Details

NEW!

readEntityDetails

Provides information about the entities that the current user can access.

<readEntityDetails/>

Parameters

No parameters

Response

The above function returns data structured like this:

<entity>
    <id>Corporate</id>
    <name>Corporate</name>
    <recordno>7</recordno>
    <currency>USD</currency>
    <firstfiscalmonth>10</firstfiscalmonth>
    <firstfiscaltaxmonth></firstfiscaltaxmonth>
    <weekstart></weekstart>
</entity>

Parameters

Name Type Description
id string Unique entity ID
name string Entity name
recordno integer Record number of the entity
currency string Base currency for the entity (or the top level base currency if no currency is set for the entity)
firstfiscalmonth string First fiscal month
firstfiscaltaxmonth string First tax month
weekstart string Week begins on

Provide feedback