NEW!

Account allocation groups support generation of multiple account allocation entries, which is useful for organizations with many allocations that must run on the same interval and/or with dependencies.

You can also use account allocation groups to set up the order for sequential processing, where one allocation is dependent on the results of a prior one.


List Account Allocation Groups

readByQuery

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

Parameters

Name Required Type Description
object Required string Use GLACCTALLOCATIONGRP
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
GRPERRORPROCESSINGMETHOD Optional string Group error processing method in use. Use E for groups set to Stop if a group member in the sequence fails or S for groups set to Skip and continue if a group in the sequence fails.

Get Account Allocation Group

read

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

Parameters

Name Required Type Description
object Required string Use GLACCTALLOCATIONGRP
keys Required string Account allocation 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.

Create Account Allocation Group

create

<create>
    <GLACCTALLOCATIONGRP>
        <NAME>Month end</NAME>
        <DESCRIPTION>All month end allocations for the company</DESCRIPTION>
        <GRPERRORPROCESSINGMETHOD>Skip and continue if a group in the sequence fails</GRPERRORPROCESSINGMETHOD>
        <GLACCTALLOCATIONGRPMEMBERS>
            <GLACCTALLOCATIONGRPMEMBER>
                <GLACCTALLOCATIONID>Allocation-1</GLACCTALLOCATIONID>
            </GLACCTALLOCATIONGRPMEMBER>
            <GLACCTALLOCATIONGRPMEMBER>
                <GLACCTALLOCATIONID>Allocation-2</GLACCTALLOCATIONID>
            </GLACCTALLOCATIONGRPMEMBER>
        </GLACCTALLOCATIONGRPMEMBERS>
    </GLACCTALLOCATIONGRP>
</create>

Parameters

Name Required Type Description
GLACCTALLOCATIONGRP Required object Object to create

GLACCTALLOCATIONGRP

Name Required Type Description
NAME Required string Group name for the account allocation group
DESCRIPTION Required string Description of the account allocation group
STATUS Optional string Status of the group. Use active for Active or inactive for Inactive. (Default: active)
GRPERRORPROCESSINGMETHOD Optional string Group error processing method. If the group contains dependencies where sequential processing is important, use Stop if a group member in the sequence fails. If the grouping is for convenience and sequential processing is not important, you can use Skip and continue if a group in the sequence fails.
GLACCTALLOCATIONGRPMEMBERS Required GLACCTALLOCATIONGRPMEMBER[1...n] Account allocation group members. If one allocation is dependent on the completion of a previous allocation, order the members accordingly.

GLACCTALLOCATIONGRPMEMBER

Name Required Type Description
GLACCTALLOCATIONID Required string Account allocation ID to use

Update Account Allocation Group

update

Building on the example above that creates an allocation group, updates the array of members to include the original ones plus a new one (Allocation-3):

<update>
    <GLACCTALLOCATIONGRP>
        <RECORDNO>1</RECORDNO>
        <GLACCTALLOCATIONGRPMEMBERS>
            <GLACCTALLOCATIONGRPMEMBER>
                <GLACCTALLOCATIONID>Allocation-1</GLACCTALLOCATIONID>
            </GLACCTALLOCATIONGRPMEMBER>
            <GLACCTALLOCATIONGRPMEMBER>
                <GLACCTALLOCATIONID>Allocation-2</GLACCTALLOCATIONID>
            </GLACCTALLOCATIONGRPMEMBER>
            <GLACCTALLOCATIONGRPMEMBER>
                <GLACCTALLOCATIONID>Allocation-3</GLACCTALLOCATIONID>
            </GLACCTALLOCATIONGRPMEMBER>
        </GLACCTALLOCATIONGRPMEMBERS>
    </GLACCTALLOCATIONGRP>
</update>

Parameters

Name Required Type Description
GLACCTALLOCATIONGRP Required object Object to update

GLACCTALLOCATIONGRP

Name Required Type Description
RECORDNO Required integer Account allocation group RECORDNO to update
NAME Optional string Group name for the account allocation group
DESCRIPTION Optional string Description of the account allocation group
STATUS Optional string Status of the group. Use active for Active or inactive for Inactive (Default: active)
GRPERRORPROCESSINGMETHOD Optional string Group error processing method. If the group contains dependencies where sequential processing is important, use Stop if a group member in the sequence fails. If the grouping is for convenience and sequential processing is not important, you can use Skip and continue if a group in the sequence fails.
GLACCTALLOCATIONGRPMEMBERS Optional GLACCTALLOCATIONGRPMEMBER[1...n] Account allocation group members. If one allocation is dependent on the completion of a previous allocation, order the members accordingly. When updating group members, supply all the original members along with the ones to add. To delete a member, supply only the members you want to keep.

GLACCTALLOCATIONGRPMEMBER

Name Required Type Description
GLACCTALLOCATIONID Optional string Account allocation ID to use

Delete Account Allocation Group

delete

<delete>
    <object>GLACCTALLOCATIONGRP</object>
    <keys>14</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use GLACCTALLOCATIONGRP
keys Required string Account allocation group RECORDNO to delete

Provide feedback