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
    }
}
Query account allocation groups
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "general-ledger/account-allocation-group"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or has (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "general-ledger/account-allocation-group",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "name",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "name": "Daily Close",
      • "href": "/objects/general-ledger/account-allocation-group/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "name": "Month End",
      • "href": "/objects/general-ledger/account-allocation-group/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}