Account allocation runs

Account allocations are where transactions are distributed across dimensions. Allocations are processed (run) to reflect accurate and up-to-date account balances.

List account allocation runs

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

Returns a collection with a key, ID, and link for each account allocation run.

SecurityOAuth2
Responses
200

OK

400

Bad Request

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


SecurityOAuth2 
Request 
Request Body schema: application/json
required
Create an account allocation run


asOfDate
required
string <date> 
As of date.


 
 Example:  "2024-01-01"
glPostingDate
required
string <date> 
GL posting date.


 
 Example:  "2024-01-01"
email
required
string
Your email address.


 
 Example:  "[email protected]"
object
 
id
string or null
Unique identifier for the account allocation.


 
 Example:  "Monthly expense allocation"
key
string or null
 
 Example:  "23"
object
 
key
string or null
 
 Example:  "23"
id
string or null
Unique identifier for the account allocation group.


 
 Example:  "23"
object
Account allocation dimensions.


 
object
 
key
string or null
Unique key for the employee.


 
 Example:  "10"
id
string or null
Unique identifier for the employee.


 
 Example:  "EMP-10"
object
 
key
string or null
Unique key for the project.


 
 Example:  "2"
id
string or null
Unique identifier for the project.


 
 Example:  "NET-XML30-2"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "asOfDate": "2024-08-24",
  • "glPostingDate": "2024-10-25",
  • "email": "[email protected]",
  • "accountAllocationGroup": {
    • "id": "5"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "97",
    • "key": "97",
    • "href": "/objects/general-ledger/account-allocation-run/97"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an account allocation run
get/objects/general-ledger/account-allocation-run/{key}
Returns detailed information for the specified account allocation run.


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


 
 Example:  178
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "97",
    • "key": "97",
    • "asOfDate": "2024-08-24",
    • "glPostingDate": "2024-10-25",
    • "email": "[email protected]",
    • "accountAllocation": {
      • "id": null,
      • "key": null
      },
    • "allocationType": null,
    • "accountAllocationGroup": {
      • "name": "Employee allocation group",
      • "id": "5",
      • "key": "5",
      • "href": "/objects/general-ledger/account-allocation-group/5"
      },
    • "parent": {
      • "id": null,
      • "key": null
      },
    • "state": "partialSuccess",
    • "allocationRunType": "regular",
    • "message": null,
    • "audit": {
      • "createdDateTime": "2024-09-20T05:17:09Z",
      • "modifiedDateTime": "2024-09-20T05:17:58Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "entity": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "dimensions": {
      • "project": {
        },
      • "employee": {
        }
      },
    • "href": "/objects/general-ledger/account-allocation-run/97"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete an account allocation run
delete/objects/general-ledger/account-allocation-run/{key}
Deletes an account allocation run.


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


 
 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
    }
}