Account allocation basis

The account allocation basis defines how the allocation splits your source pool amount into each allocation focused dimension, it is the blueprint used when calculating dynamic allocations.

List account allocation basis objects

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

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

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "16",
      • "id": "16",
      • "href": "/objects/general-ledger/account-allocation-basis/16"
      },
    • {
      • "key": "20",
      • "id": "20",
      • "href": "/objects/general-ledger/account-allocation-basis/20"
      },
    • {
      • "key": "21",
      • "id": "21",
      • "href": "/objects/general-ledger/account-allocation-basis/21"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get an account allocation basis
get/objects/general-ledger/account-allocation-basis/{key}
Returns detailed information for a specified account allocation basis.


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


 
 Example:  178
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "21",
    • "key": "21",
    • "glAccountAllocation": {
      • "id": "29",
      • "key": "29",
      • "href": "/objects/general-ledger/account-allocation/29"
      },
    • "glAccountGroup": {
      • "id": "Basis",
      • "key": "623",
      • "href": "/objects/general-ledger/account-group/623"
      },
    • "accumulation": "activity",
    • "timePeriod": {
      • "id": "Current Month",
      • "key": "395",
      • "href": "/objects/general-ledger/reporting-period/395"
      },
    • "allocationMethod": "dynamicRelativeAccountFinancial",
    • "reportingBook": "accrual",
    • "useAmountsFrom": "mainReportingBookAndAlternateBooks",
    • "skipNegative": false,
    • "dimensions": {
      • "location": {
        },
      • "department": {
        },
      • "project": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "employee": {
        },
      • "item": {
        },
      • "class": {
        },
      • "contract": {
        },
      • "warehouse": {
        }
      },
    • "href": "/objects/general-ledger/account-allocation-basis/21"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an account allocation basis
patch/objects/general-ledger/account-allocation-basis/{key}
Updates an existing account allocation basis object by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  178
Request Body schema: application/json
accumulation
string
 Default:  "activity"
Determines how the amounts within the basis accounts are interpreted to derive amounts for the allocation split.


 Enum: "activity" "endingBalance"  
 Example:  "activity"
object
Time period used to get the basis information.


 
key
string
Unique key for the time period.


 
 Example:  "395"
id
string
Unique identifier for the time period.


 
 Example:  "Current Month"
reportingBook
string
 Default:  "accrual"
Accounting method used in the basis calculation.


 Enum: "accrual" "cash"  
 Example:  "accrual"
allocationMethod
string
 Default:  "dynamicRelativeAccountFinancial"
Method used to to distribute the source pool in the basis calculation.


 Enum: "dynamicRelativeAccountFinancial" "dynamicRelativeAccountStatistical"  
 Example:  "dynamicRelativeAccountFinancial"
skipNegative
boolean
 Default:  false
Excludes negative balances from the basis calculation.


 
 Example:  false
useAmountsFrom
string
 Default:  "mainReportingBookAndAlternateBooks"
Uses amounts from specified reporting book in the basis calculation.


 Enum: "alternateBooksOnly" "mainReportingBookAndAlternateBooks"  
 Example:  "mainReportingBookAndAlternateBooks"
object
Account group to base your allocation split on.


 
key
string
Unique key for the account group.


 
 Example:  "623"
id
string
Unique identifier for the account group.


 
 Example:  "Basis"
object
Account allocation basis dimensions.


 
object
Location dimension.


 
key
string or null
Location key


 
 Example:  "22"
id
string or null
Location ID


 
 Example:  "LOC-22"
object
Department dimension.


 
key
string or null
Department key


 
 Example:  "11"
id
string or null
Department ID


 
 Example:  "DEP-11"
object
 
key
string or null
Employee key


 
 Example:  "10"
id
string or null
Employee ID


 
 Example:  "EMP-10"
object
 
key
string or null
Project key


 
 Example:  "2"
id
string or null
Project ID


 
 Example:  "NET-XML30-2"
object
 
key
string or null
Customer key


 
 Example:  "13"
id
string or null
Customer ID


 
 Example:  "CUST-13"
object
 
key
string or null
Vendor key


 
 Example:  "357"
id
string or null
Vendor ID


 
 Example:  "1605212096809"
object
 
key
string or null
Item key


 
 Example:  "13"
id
string or null
Item ID


 
 Example:  "Case 13"
object
 
key
string or null
Warehouse key


 
 Example:  "6"
id
string or null
Warehouse ID


 
 Example:  "WH01"
object
 
key
string or null
Class key


 
 Example:  "731"
id
string or null
Class ID


 
 Example:  "REST_CLS_001"
object
 
id
string or null
Task ID


 
 Example:  "1"
key
string or null
Task key


 
 Example:  "1"
object
 
id
string or null
Cost Type ID


 
 Example:  "2"
key
string or null
Cost Type key


 
 Example:  "2"
object
 
id
string or null
Asset ID


 
 Example:  "A001"
key
string or null
Asset key


 
 Example:  "1"
object
 
id
string or null
Contract ID


 
 Example:  "CON-0045-1"
key
string or null
Contract key


 
 Example:  "12"
object
 
key
string or null
Affiliate entity key


 
 Example:  "23"
id
string or null
Affiliate entity ID


 
 Example:  "AFF-23"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "skipNegative": true,
  • "allocationMethod": "dynamicRelativeAccountFinancial"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "21",
    • "id": "21",
    • "href": "/objects/general-ledger/account-allocation-basis/21"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}