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.

SecurityOAuth2

Responses

200

OK

400

Bad Request

Request samples

Response samples

200
400

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.

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"

state

string

Default: "posted"

Shows the current state of the statistical journal entry. The only valid values when creating a new entry are posted (default, system-defined state), and draft. Only populate the state field when creating a draft entry. If you leave the state field blank, it will have the default state of posted.

Enum: "approved" "declined" "draft" "partiallyApproved" "posted" "reversalPending" "reversed" "submitted"

Example: "draft"

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": {"location": {"id": "1"
}
},
"statisticalAccount": {"id": "9001"
}
}
]
}

Response samples

201
400

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

200
400

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-12-05T08:23:34Z",
"modifiedDateTime": "2025-03-21T12:51:08Z",
"createdByUser": {"key": "34",
"id": "Admin",
"href": "/objects/company-config/user/34"
},
"createdBy": "1",
"modifiedByUser": {"key": "1",
"id": "Aman",
"href": "/objects/company-config/user/1"
},
"modifiedBy": "1"
},
"state": "posted",
"sequenceNumber": "1221",
"lines": [{"id": "140",
"key": "140",
"statisticalJournalEntry": {"id": "81",
"key": "81",
"href": "/objects/general-ledger/statistical-journal-entry/81"
},
"lineNumber": 1,
"txnType": "increase",
"entryDate": "2024-03-05",
"txnAmount": "15.00",
"statisticalAccount": {"key": "1",
"id": "9001",
"name": "Root - Billable Utilized Statistical Account",
"href": "/objects/general-ledger/statistical-gl-account/1"
},
"dimensions": {"department": {"key": null,
"id": null,
"name": null
},
"location": {"key": "1",
"id": "1",
"name": "United States of America",
"href": "/objects/location/1"
},
"project": {"key": null,
"id": null,
"name": null
},
"customer": {"key": null,
"id": null,
"name": null
},
"vendor": {"key": null,
"id": null,
"name": null
},
"employee": {"key": null,
"id": null,
"name": null
},
"item": {"key": null,
"id": null,
"name": null
},
"class": {"key": null,
"id": null,
"name": null
}
},
"documentId": null,
"description": null,
"numberOfUnits": null,
"reconciliationGroup": {"cleared": "false",
"clearingDate": null,
"reconciliationDate": null
},
"accountingPeriod": null,
"allocation": {"id": null,
"key": null
},
"audit": {"createdDateTime": "2024-12-05T08:23:34Z",
"modifiedDateTime": "2025-03-21T12:51:08Z",
"createdByUser": {"key": "34",
"id": "Admin",
"href": "/objects/company-config/user/34"
},
"createdBy": "1",
"modifiedByUser": {"key": "1",
"id": "Aman",
"href": "/objects/company-config/user/1"
},
"modifiedBy": "1"
},
"state": "posted",
"href": "/objects/general-ledger/statistical-journal-entry-line/140"
}
],
"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"

state

string

Default: "posted"

Shows the current state of the statistical journal entry. The only valid values when creating a new entry are posted (default, system-defined state), and draft. Only populate the state field when creating a draft entry. If you leave the state field blank, it will have the default state of posted.

Enum: "approved" "declined" "draft" "partiallyApproved" "posted" "reversalPending" "reversed" "submitted"

Example: "draft"

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": {"id": "1000"
},
"dimensions": {"department": {"id": "11"
},
"location": {"id": "1"
}
},
"documentId": "Statistical JE reference",
"currency": {"txnCurrency": "USD"
}
}
]
}

Response samples

200
400

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

400

application/json

{"ia::result": {"ia::error": {"code": "invalidRequest",
"message": "A POST request requires a payload",
"errorId": "REST-1028",
"additionalInfo": {"messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
"placeholders": {"OPERATION": "POST"
},
"propertySet": { }
},
"supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 0,
"totalError": 1
}
}

Statistical journal entries

List statistical journal entries

Create a statistical journal entry

Request Body schema: application/jsonrequired

Get a statistical journal entry

path Parameters

Update a statistical journal entry

path Parameters

Request Body schema: application/json

Delete a statistical journal entry

path Parameters

Request Body schema: application/json
required