Statistical journal entries

Statistical journal entries record and track non-financial data alongside financial transactions. They help measure key performance indicators and provide valuable insights for business reporting and analysis.

Use statistical journal entries to add, edit, or reverse statistical transactions within a journal before posting them to the general ledger for reporting and analysis.

List statistical journal entries

get/objects/general-ledger/statistical-journal-entry

Returns up to 100 statistical journal entries from the collection with a key, ID, and link for each entry. This operation is mostly for use in testing; use the query service to find statistical journal entries that meet certain criteria and to specify the properties that you want in the response.

Permissions and other requirements
SubscriptionGeneral Ledger
User typeBusiness user with Admin privileges, Employee, Payment Approver
PermissionsList, View Statistical Journal Entries
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "66",
      • "id": "66",
      • "href": "/objects/general-ledger/statistical-journal-entry/66"
      },
    • {
      • "key": "67",
      • "id": "67",
      • "href": "/objects/general-ledger/statistical-journal-entry/67"
      },
    • {
      • "key": "68",
      • "id": "68",
      • "href": "/objects/general-ledger/statistical-journal-entry/68"
      },
    • {
      • "key": "70",
      • "id": "70",
      • "href": "/objects/general-ledger/statistical-journal-entry/70"
      },
    • {
      • "key": "72",
      • "id": "72",
      • "href": "/objects/general-ledger/statistical-journal-entry/72"
      }
    ],
  • "ia::meta": {
    • "totalCount": 5,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a statistical journal entry
post/objects/general-ledger/statistical-journal-entry
Creates a new statistical journal entry, you can either post the entry immediately or save as a draft for review. Draft journal entries can be updated before posting, but all required information must be provided to post.



Permissions and other requirements



SubscriptionGeneral Ledger, Projects (for revenue recognition of projects)


User typeBusiness


PermissionsAdd Statistical Journal Entries







SecurityOAuth2 
Request 
Request Body schema: application/json
required
Create a new statistical journal entry


required
object
Identifies the statistical journal associated to which the statistical journal entry belongs.


 
key
string
System-assigned key for the statistical journal.


 
 Example:  "3"
id
string
Unique identifier for the statistical journal.


 
 Example:  "EJ"
postingDate
required
string <date> 
The date when the statistical journal entry is recorded in the journal and posted to the general ledger for tracking and reporting.


 
 Example:  "2023-04-01"
description
required
string
Description of the statistical journal entry.


 
 Example:  "Revenue entries"
required
Array of objects  non-empty 
A collection of statistical transaction lines within the journal entry. At least one line in required per statistical journal entry.


 
 Array (non-empty)
txnAmount
required
string <decimal-precision-2> 
Represents the amount of the line item as an absolute value within the statistical journal entry.


 
 Example:  "100.45"
txnType
required
string
 Default:  "increase"
Indicates the type of line item recorded in the statistical journal entry.


 Enum: "decrease" "increase"  
 Example:  "increase"
required
object
 
documentId
string
Reference for the statistical journal entry line item, this is a user-entered value that can contain numeric or alpha-numeric values.


 
 Example:  "Headcount_Increase-03-24"
description
string
Description of the statistical journal entry line.


 
 Example:  "Headcount Increase March 2024"
state
string
 Default:  "posted"
State to update the entry to. Posted to post to the GL


 Enum: "approved" "declined" "draft" "paid" "partiallyApproved" "partiallyPaid" "posted" "reversal" "reversalPending" "reversed" "submitted"  
 Example:  "draft"
object
Transaction allocation template, a predefined template used to allocate statistical line items across accounts, departments, or entities.


 
object
 
automaticReversalDate
string or null <date> 
The date a statistical journal entry is automatically reversed in the general ledger. automaticReversalDate must be later than the postingDate.


 
 Example:  "2023-04-04"
referenceNumber
string
Unique identifier assigned to the statistical journal entry by the user for tracking and reconciliation.


 
 Example:  "Recurr_GL_101"
object
Supporting documents or files linked to the statistical journal entry.


 
key
string
System-assigned key for the attachment.


 
 Example:  "6"
id
string
Unique identifier for the attachment.


 
 Example:  "Doc6331"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "description": "TSSJ 5 JE Journal",
  • "statisticalJournal": {
    • "id": "cs"
    },
  • "postingDate": "2024-03-05",
  • "lines": [
    • {
      • "txnType": "increase",
      • "txnAmount": "15",
      • "dimensions": {
        },
      • "statisticalAccount": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "81",
    • "key": "81",
    • "href": "/objects/general-ledger/statistical-journal-entry/81"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a statistical journal entry
get/objects/general-ledger/statistical-journal-entry/{key}
Returns detailed information for a specified statistical journal entry.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the statistical journal entry.


 
 Example:  132
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "81",
    • "key": "81",
    • "txnNumber": 6,
    • "description": "TSSJ 5 JE Journal",
    • "statisticalJournal": {
      • "id": "CS",
      • "key": "107",
      • "href": "/objects/general-ledger/statistical-journal/107"
      },
    • "postingDate": "2024-03-05",
    • "moduleName": "2.GL",
    • "referenceNumber": "Stat_GL_101",
    • "entity": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "attachment": {
      • "id": "Transaction Notes",
      • "key": "4",
      • "href": "/objects/company-config/attachment/4"
      },
    • "reversedBy": {
      • "id": null,
      • "key": null
      },
    • "reversedFromDate": null,
    • "audit": {
      • "createdDateTime": "2024-04-26T17:28:30Z",
      • "modifiedDateTime": "2024-04-26T17:28:30Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "state": "posted",
    • "sequenceNumber": "1221",
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/general-ledger/statistical-journal-entry/81"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a statistical journal entry
patch/objects/general-ledger/statistical-journal-entry/{key}
Updates an existing statistical journal entry by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the statistical journal entry.


 
 Example:  132
Request Body schema: application/json
description
string
Description of the statistical journal entry.


 
 Example:  "Revenue entries"
postingDate
string <date> 
The date when the statistical journal entry is recorded in the journal and posted to the general ledger for tracking and reporting.


 
 Example:  "2023-04-01"
automaticReversalDate
string or null <date> 
The date a statistical journal entry is automatically reversed in the general ledger. automaticReversalDate must be later than the postingDate.


 
 Example:  "2023-04-04"
object
Identifies the statistical journal associated to which the statistical journal entry belongs.


 
key
string
System-assigned key for the statistical journal.


 
 Example:  "3"
id
string
Unique identifier for the statistical journal.


 
 Example:  "EJ"
referenceNumber
string
Unique identifier assigned to the statistical journal entry by the user for tracking and reconciliation.


 
 Example:  "Recurr_GL_101"
object
Supporting documents or files linked to the statistical journal entry.


 
key
string
System-assigned key for the attachment.


 
 Example:  "6"
id
string
Unique identifier for the attachment.


 
 Example:  "Doc6331"
Array of objects  non-empty 
A collection of statistical transaction lines within the journal entry. At least one line in required per statistical journal entry.


 
 Array (non-empty)
txnType
string
 Default:  "increase"
Indicates the type of line item recorded in the statistical journal entry.


 Enum: "decrease" "increase"  
 Example:  "increase"
txnAmount
string <decimal-precision-2> 
Represents the amount of the line item as an absolute value within the statistical journal entry.


 
 Example:  "100.45"
documentId
string
Reference for the statistical journal entry line item, this is a user-entered value that can contain numeric or alpha-numeric values.


 
 Example:  "Headcount_Increase-03-24"
description
string
Description of the statistical journal entry line.


 
 Example:  "Headcount Increase March 2024"
state
string
 Default:  "posted"
State to update the entry to. Posted to post to the GL


 Enum: "approved" "declined" "draft" "paid" "partiallyApproved" "partiallyPaid" "posted" "reversal" "reversalPending" "reversed" "submitted"  
 Example:  "draft"
object
 
object
Transaction allocation template, a predefined template used to allocate statistical line items across accounts, departments, or entities.


 
object
 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "postingDate": "2023-12-11",
  • "state": "posted",
  • "lines": [
    • {
      • "key": "195",
      • "txnType": "decrease",
      • "txnAmount": "100",
      • "statisticalAccount": {
        },
      • "dimensions": {
        },
      • "documentId": "Statistical JE reference",
      • "currency": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "1",
    • "href": "/objects/general-ledger/statistical-journal-entry/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a statistical journal entry
delete/objects/general-ledger/statistical-journal-entry/{key}
Deletes a statistical journal entry.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the statistical journal entry.


 
 Example:  132
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 statistical journal entries
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/statistical-journal-entry"
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/statistical-journal-entry",
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$between": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "href",
    • "postingDate"
    ],
  • "orderBy": [
    • {
      • "postingDate": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "17",
      • "id": "17",
      • "href": "/objects/general-ledger/statistical-journal-entry/17",
      • "postingDate": "2024-01-31"
      },
    • {
      • "key": "18",
      • "id": "18",
      • "href": "/objects/general-ledger/statistical-journal-entry/18",
      • "postingDate": "2024-02-28"
      },
    • {
      • "key": "20",
      • "id": "20",
      • "href": "/objects/general-ledger/statistical-journal-entry/20",
      • "postingDate": "2024-03-31"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}