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
    }
}
Query account allocation targets
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-target"
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-target",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "123",
      • "id": "123",
      • "href": "/objects/general-ledger/account-allocation-target/123"
      },
    • {
      • "key": "256",
      • "id": "256",
      • "href": "/objects/general-ledger/account-allocation-target/256"
      },
    • {
      • "key": "283",
      • "id": "283",
      • "href": "/objects/general-ledger/account-allocation-target/283"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}