Account allocation targets

The account allocation target specifies where the amounts from the source pool are distributed when calculating the account allocation.

List account allocation targets

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

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

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-target/16"
      },
    • {
      • "key": "20",
      • "id": "20",
      • "href": "/objects/general-ledger/account-allocation-target/20"
      },
    • {
      • "key": "21",
      • "id": "21",
      • "href": "/objects/general-ledger/account-allocation-target/21"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get an account allocation target
get/objects/general-ledger/account-allocation-target/{key}
Returns detailed information for a specified account allocation target.


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


 
 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"
      },
    • "journal": {
      • "key": "39",
      • "title": "Accommodation Expenses",
      • "id": "Others",
      • "href": "/objects/general-ledger/journal/39"
      },
    • "exchangeRate": {
      • "typeId": "1"
      },
    • "glAccount": {
      • "id": "1105",
      • "key": "378",
      • "name": "Target",
      • "href": "/objects/general-ledger/account/378"
      },
    • "isBillable": false,
    • "audit": {
      • "createdDateTime": "2024-06-25T12:16:47Z",
      • "modifiedDateTime": "2024-06-25T12:58:12Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "dimensions": {
      • "location": {
        },
      • "department": {
        },
      • "project": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "employee": {
        },
      • "item": {
        },
      • "class": {
        },
      • "contract": {
        },
      • "warehouse": {
        }
      },
    • "href": "/objects/general-ledger/account-allocation-target/21"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an account allocation target
patch/objects/general-ledger/account-allocation-target/{key}
Updates an existing account allocation target by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  178
Request Body schema: application/json
object
Account group to base your allocation split on.


 
key
string
Unique key for the account group.


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


 
 Example:  "1"
isBillable
boolean
 Default:  false
Flag lines in the allocation target as billable.


 
 Example:  false
object
General ledger account.


 
key
string or null
Unique key for the account.


 
 Example:  "378"
id
string or null
Unique identifier for the account.


 
 Example:  "1105"
object
Journal where the allocation will be recorded when generated.


 
key
string
Unique key for the journal.


 
 Example:  "39"
id
string
Unique identifier for the journal.


 
 Example:  "Others"
object
Exchange rate details used to calculate the base amount.


 
typeId
string or null
The type of exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  "1"
object
Dimension overrides for the account allocation target.


 
object
Dimension override for class, applies only if the dimension treatment for class is set to not considered.


 
key
string or null
Unique key for the class.


 
 Example:  "6"
id
string or null
Unique identifier for the class.


 
 Example:  "Professional Services"
object
Dimension override for customer, applies only if the dimension treatment for customer is set to not considered.


 
key
string or null
Unique key for the customer.


 
 Example:  "1"
id
string or null
Unique identifier for the customer.


 
 Example:  "ACME"
object
Dimension override for employee, applies only if the dimension treatment for employee is set to not considered.


 
key
string or null
Unique key for the employee.


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


 
 Example:  "12"
object
Dimension override for department, applies only if the dimension treatment for department is set to not considered.


 
key
string or null
Unique key for the department.


 
 Example:  "12"
id
string or null
Unique identifier for the department.


 
 Example:  "12"
object
Dimension override for location, applies only if the dimension treatment for location is set to not considered.


 
key
string or null
Unique key for the location.


 
 Example:  "72"
id
string or null
Unique identifier for the location.


 
 Example:  "AZ"
object
Dimension override for project, applies only if the dimension treatment for project is set to not considered.


 
key
string or null
Unique key for the project.


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


 
 Example:  "8"
object
Dimension override for vendor, applies only if the dimension treatment for vendor is set to not considered.


 
key
string or null
Unique key for the vendor.


 
 Example:  "48"
id
string or null
Unique identifier for the vendor.


 
 Example:  "202"
object
Dimension override for warehouse, applies only if the dimension treatment for warehouse is set to not considered.


 
key
string or null
Unique key for the warehouse.


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


 
 Example:  "WH02"
object
Dimension override for item, applies only if the dimension treatment for item is set to not considered.


 
key
string or null
Unique key for the item.


 
 Example:  "13"
id
string or null
Unique identifier for the item.


 
 Example:  "Case 13"
href
string
URL endpoint for the item.


 
 Example:  "/objects/inventory-control/item/13"
object
Dimension override for contract, applies only if the dimension treatment for contract is set to not considered.


 
key
string or null
Unique key for the contract.


 
 Example:  "12"
id
string or null
Unique identifier for the contract.


 
 Example:  "CON-0045-1"
Responses 
200
OK


400
Bad Request


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