Transaction allocation templates

Transaction allocation templates (definitions) provide a way to save standard allocation combinations that are used routinely. You can define an allocation transaction to distribute amounts across multiple dimensions—such as departments, locations, projects, or classes—automatically.

You can allocate a percentage, a set (absolute) value, or a fixed amount with over/under logic. Each of these methods takes the transaction line amount and allocates it across the dimensions specified in the transaction allocation template.

Transaction allocations are intended for use on single line items, allowing you to distribute amounts during entry of a transaction, usually a one-time action. Transaction allocations are only available for distribution across eight of the standard dimensions and have other restrictions as well.

If you want to automatically pull updated source balances and distribute them across dimensions according to defined basis calculations, you should use the Dynamic Allocations subscription. See Account Allocations for more info.

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List transaction allocation templates

get/objects/general-ledger/txn-allocation-template

Returns a collection with a key, ID, and link for each template. This operation is mostly for use in testing; use the query service to find allocation templates 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": "Fixed Amount Allocation",
      • "href": "/objects/general-ledger/txn-allocation-template/1"
      },
    • {
      • "key": "2",
      • "id": "Percentage Allocation",
      • "href": "/objects/general-ledger/txn-allocation-template/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a transaction allocation template
post/objects/general-ledger/txn-allocation-template
Creates a new transaction allocation template.


SecurityOAuth2 
Request 
Request Body schema: application/json
Transaction allocation template to create


id
required
string
User defined transaction allocation template ID.


 
 Example:  "FA_ALLOC"
required
Array of objects  non-empty 
Transaction allocation lines.


 
 Array (non-empty)
value
required
string
The exact amount or percentage to allocate for this line.


 
 Example:  "60.56"
required
object
Dimensions to use in allocations.


 
valueType
string
 Default:  "amount"
For fixedAmount allocations, specifies whether the current line is an exact amount or percentage. Not needed for percentage and exactAmount allocations.


 Enum: "amount" "percent"  
 Example:  "amount"
lineNumber
integer
Line number of the allocation entry. For fixedAmount allocations, exact amounts are distributed by line number.


 
 Example:  1
object
Transaction allocation template that this allocation line belongs to.


 
description
string
A description of the allocation.


 
 Example:  "Fixed Amount Allocation"
allocateBy
string
 Default:  "percentage"
Determines how transaction allocations are split across the dimensions included in a transaction.


    

  • Use percentage to specify entries as percentages (default)
    • 

  • Use exactAmount to specify entries as fixed amounts
    • 

  • Use fixedAmount for a combination of both. Exact amounts are distributed first, based on the lineNumber values in each txn-allocation-template-line. Any remaining amount is distributed using the percentage allocations. Entries for exact amounts must have lower line numbers than entries for percentages, and percentages must always total 100%. (You use the valueType parameter on each entry to specify amount or percent.)
    • 



 Enum: "exactAmount" "fixedAmount" "percentage"  
 Example:  "percentage"
documentNumber
string
A reference number or name to a specific document--such as a contract--used to define the transaction allocation template formula.


 
 Example:  "RJEALC"
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"
object
Supporting document ID for this attachment.


 
key
string
 
 Example:  "21"
id
string
 
 Example:  "Sales01"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "Fixed amount allocation",
  • "description": "Fixed dollar amount allocation",
  • "status": "active",
  • "allocateBy": "exactAmount",
  • "lines": [
    • {
      • "value": "100",
      • "dimensions": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "4",
    • "id": "Fixed amount allocation",
    • "href": "/objects/general-ledger/txn-allocation-template/4"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a transaction allocation template
get/objects/general-ledger/txn-allocation-template/{key}
Returns detailed information for a specified transaction allocation template.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the transaction allocation template.


 
 Example:  2
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "Fixed amount allocation",
    • "description": "Fixed dollar amount allocation",
    • "allocateBy": "exactAmount",
    • "documentNumber": "REJCAL",
    • "status": "active",
    • "audit": {
      • "createdDateTime": "2023-06-23T11:32:17Z",
      • "modifiedDateTime": "2023-06-23T12:25:08Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/general-ledger/txn-allocation-template/3"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a transaction allocation template
patch/objects/general-ledger/txn-allocation-template/{key}
Updates an existing allocation template by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the transaction allocation template.


 
 Example:  2
Request Body schema: application/json
description
string
A description of the allocation.


 
 Example:  "Fixed Amount Allocation"
allocateBy
string
 Default:  "percentage"
Determines how transaction allocations are split across the dimensions included in a transaction.


    

  • Use percentage to specify entries as percentages (default)
    • 

  • Use exactAmount to specify entries as fixed amounts
    • 

  • Use fixedAmount for a combination of both. Exact amounts are distributed first, based on the lineNumber values in each txn-allocation-template-line. Any remaining amount is distributed using the percentage allocations. Entries for exact amounts must have lower line numbers than entries for percentages, and percentages must always total 100%. (You use the valueType parameter on each entry to specify amount or percent.)
    • 



 Enum: "exactAmount" "fixedAmount" "percentage"  
 Example:  "percentage"
documentNumber
string
A reference number or name to a specific document--such as a contract--used to define the transaction allocation template formula.


 
 Example:  "RJEALC"
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"
object
Supporting document ID for this attachment.


 
key
string
 
 Example:  "21"
id
string
 
 Example:  "Sales01"
Array of objects  non-empty 
Transaction allocation lines.


 
 Array (non-empty)
value
string
The exact amount or percentage to allocate for this line.


 
 Example:  "60.56"
valueType
string
 Default:  "amount"
For fixedAmount allocations, specifies whether the current line is an exact amount or percentage. Not needed for percentage and exactAmount allocations.


 Enum: "amount" "percent"  
 Example:  "amount"
lineNumber
integer
Line number of the allocation entry. For fixedAmount allocations, exact amounts are distributed by line number.


 
 Example:  1
object
Dimensions to use in allocations.


 
object
Transaction allocation template that this allocation line belongs to.


 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "All Shop Allocation",
  • "lines": [
    • {
      • "key": "3",
      • "valueType": "amount",
      • "value": "95"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "Fixed amount allocation",
    • "href": "/objects/general-ledger/txn-allocation-template/3"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a transaction allocation template
delete/objects/general-ledger/txn-allocation-template/{key}
Deletes a transaction allocation template.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the transaction allocation template.


 
 Example:  2
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 transaction allocation templates
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/txn-allocation-template"
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 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 response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "general-ledger/txn-allocation-template",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "status",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "33",
      • "id": "Fixed Amount Allocation",
      • "status": "active",
      • "href": "/objects/general-ledger/txn-allocation-template/33"
      }
    ],
  • "ia::meta": {
    • "totalCount": 1,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}