Account allocation groups

When you have several allocations that run on the same interval (for example, at month end), creating an allocation group allows you to process these allocations efficiently. You can also order the members of an allocation group in the sequence they need to be processed in, for example, if an allocation is dependent on a different allocation being processed first.

List account allocation groups

get/objects/general-ledger/account-allocation-group

Returns a collection with a key, ID, and link for each account allocation group. This operation is mostly for use in testing; use the query service to find allocation groups that meet specific criteria and to specify the properties that you want in the response.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/general-ledger/account-allocation-group/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/general-ledger/account-allocation-group/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an account allocation group
post/objects/general-ledger/account-allocation-group
Creates a new account allocation group.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
Create a new account allocation group.


name
required
string
Name of the account allocation group (20 characters max).


 
 Example:  "Month End"
description
required
string
Description of the account allocation group.


 
 Example:  "All month end allocations"
errorProcessingMethod
required
string
How to handle any errors encountered when processing the group allocation members.


    

  • stop - The allocation process will stop and not move forward after a member of the allocation group has encountered errors. This is the recommended setting if sequential processing is important for the group.
    • 

  • skipAndContinue - Skips the allocation member if an error is encountered. Processing then continues starting with the next member of the allocation group. This is the setting recommended if there are no dependencies within the allocation group.
    • 



 Enum: "skipAndContinue" "stop"  
 Example:  "stop"
required
Array of objects  non-empty 
Account allocation group members. If one allocation is dependent on the completion of a previous allocation, order the members accordingly.


 
 Array (non-empty)
object
General Ledger account allocation.


 
object
General Ledger account allocation group.


 
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "name": "Month end",
  • "description": "All month end allocations for the company.",
  • "errorProcessingMethod": "skipAndContinue",
  • "lines": [
    • {
      • "glAccountAllocation": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "28",
    • "id": "28",
    • "href": "/objects/general-ledger/account-allocation-group/28"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get an account allocation group
get/objects/general-ledger/account-allocation-group/{key}
Returns detailed information for a specified account allocation group.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the account allocation group.


 
 Example:  178
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "5",
    • "id": "5",
    • "name": "Month end",
    • "description": "All month end allocations for the company.",
    • "status": "active",
    • "errorProcessingMethod": "skipAndContinue",
    • "audit": {
      • "createdDateTime": "2024-10-08T13:29:18Z",
      • "modifiedDateTime": "2024-10-08T13:29:18Z",
      • "createdByUser": {
        },
      • "modifiedByUser": {
        }
      },
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/general-ledger/account-allocation-group/5"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an account allocation group
patch/objects/general-ledger/account-allocation-group/{key}
Updates an existing account allocation group by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the account allocation group.


 
 Example:  178
Request Body schema: application/json
name
string
Name of the account allocation group (20 characters max).


 
 Example:  "Month End"
description
string
Description of the account allocation group.


 
 Example:  "All month end allocations"
errorProcessingMethod
string
How to handle any errors encountered when processing the group allocation members.


    

  • stop - The allocation process will stop and not move forward after a member of the allocation group has encountered errors. This is the recommended setting if sequential processing is important for the group.
    • 

  • skipAndContinue - Skips the allocation member if an error is encountered. Processing then continues starting with the next member of the allocation group. This is the setting recommended if there are no dependencies within the allocation group.
    • 



 Enum: "skipAndContinue" "stop"  
 Example:  "stop"
Array of objects  non-empty 
Account allocation group members. If one allocation is dependent on the completion of a previous allocation, order the members accordingly.


 
 Array (non-empty)
object
General Ledger account allocation.


 
object
General Ledger account allocation group.


 
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "name": "Interest allocation",
  • "description": "Compute interest allocation."
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "21",
    • "id": "21",
    • "href": "/objects/general-ledger/account-allocation-group/21"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete an account allocation group
delete/objects/general-ledger/account-allocation-group/{key}
Deletes an account allocation group.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the account allocation group.


 
 Example:  178
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}