Use journal entries to add, edit, or reverse transactions to a journal.
When writing journal entries, be sure to balance the general ledger by posting offsetting entries.
Note: If GL Outlier Detection is enabled for a company, information about outliers is included in journal entries and allocation splits when you get a journal entry object.
Returns a collection with a key, ID, and link for each entry. This operation is mostly for use in testing; use the query service to find journal entries that meet certain criteria and to specify the properties that you want in the response.
Subscription | General Ledger |
---|---|
User type | Business user with Admin privileges, Employee, Payment Approver |
Permissions | List, View Journal Entries |
OK
Bad Request
{- "ia::result": [
- {
- "key": "256",
- "id": "256",
- "href": "/objects/general-ledger/journal-entry/256"
}, - {
- "key": "132",
- "id": "132",
- "href": "/objects/general-ledger/journal-entry/132"
}, - {
- "key": "56",
- "id": "56",
- "href": "/objects/general-ledger/journal-entry/56"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new journal entry (transaction). You can post a transaction to a journal right away, or save it as a draft.
Subscription | General Ledger, Projects (for revenue recognition of projects) |
---|---|
User type | Business |
Permissions | Add Journal Entries |
Journal entry to create
required | object The journal to use for this entry. | ||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
postingDate required | string <date> Posting date. Example: "2023-04-01" | ||||||||||||||||||||||||||||
description required | string Description of the transaction. Example: "Revenue entries" | ||||||||||||||||||||||||||||
required | Array of objects >= 2 items Journal entry lines included in this entry. Must have at least two lines, one debit and one credit. | ||||||||||||||||||||||||||||
Array (>= 2 items)
| |||||||||||||||||||||||||||||
automaticReversalDate | string or null <date> Reversal date if you want to reverse this transaction on a certain date. Must be greater than Example: "2023-04-04" | ||||||||||||||||||||||||||||
moduleName | string Intacct module that the journal entry originates from. Example: "2.GL" | ||||||||||||||||||||||||||||
referenceNumber | string User-provided reference number. Example: "Recurr_GL_101" | ||||||||||||||||||||||||||||
object Base location for a multi-entity company. Required if a company is multi-entity enabled and entries do not balance by entity. | |||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
state | string Default: "posted" State of the entry. The only valid values when creating a new entry are Example: "draft" | ||||||||||||||||||||||||||||
object Tax properties associated with the journal entry. | |||||||||||||||||||||||||||||
|
Created
Bad Request
{- "glJournal": {
- "id": "GJ"
}, - "postingDate": "2022-04-01",
- "description": "March Revenue Posting",
- "lines": [
- {
- "lineNumber": 1,
- "txnType": "credit",
- "entryDate": "2022-04-01",
- "txnAmount": "200",
- "glAccount": {
- "id": "1000"
}, - "dimensions": {
- "department": {
- "key": "11"
}, - "location": {
- "key": "192"
}
}, - "documentId": "Revenue_attachment"
}, - {
- "lineNumber": 2,
- "txnType": "debit",
- "entryDate": "2022-04-01",
- "txnAmount": "200",
- "glAccount": {
- "id": "1000"
}, - "dimensions": {
- "department": {
- "key": "11"
}, - "location": {
- "key": "192"
}
}, - "documentId": "Revenue_attachment"
}
]
}
{- "ia::result": {
- "key": "41",
- "id": "41",
- "href": "/objects/general-ledger/journal-entry/41"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified journal entry.
key required | string System-assigned key for the journal entry. Example: 132 |
OK
Bad Request
{- "ia::result": {
- "id": "132",
- "key": "132",
- "txnNumber": 40,
- "description": "Revenue Entries",
- "glJournal": {
- "key": "23",
- "id": "CRJ",
- "isAdjustment": false,
- "href": "/objects/general-ledger/journal/23"
}, - "postingDate": "2021-09-24",
- "moduleName": "2.GL",
- "referenceId": "CR0",
- "automaticReversalDate": null,
- "reversedBy": {
- "key": null
}, - "reversedFromDate": null,
- "baseLocation": {
- "id": null,
- "key": null
}, - "audit": {
- "createdDateTime": "2023-06-09T00:33:58Z",
- "modifiedDateTime": "2023-06-09T00:33:59Z",
- "createdBy": "68",
- "modifiedBy": "68"
}, - "state": "submitted",
- "sequenceNumber": null,
- "taxSolutionId": {
- "id": null
}, - "accountAllocationRun": {
- "id": null,
- "key": null
}, - "lines": [
- {
- "id": "8434",
- "key": "8434",
- "journalEntry": {
- "id": "3235",
- "key": "3235",
- "href": "/objects/general-ledger/journal-entry/3235"
}, - "lineNumber": 1,
- "txnType": "credit",
- "entryDate": "2021-09-24",
- "txnAmount": "100",
- "account": {
- "key": "9",
- "id": "4000",
- "name": "Revenue",
- "href": "/objects/general-ledger/account/9"
}, - "dimensions": {
- "department": {
- "key": "1",
- "id": "01",
- "name": "Sales",
- "href": "/objects/company-config/department/1"
}, - "location": {
- "key": "1",
- "id": "CA",
- "name": "California",
- "href": "/objects/company-config/location/1"
}, - "class": {
- "key": null,
- "id": null,
- "name": null
}, - "item": {
- "key": null,
- "id": null,
- "name": null
}, - "customer": {
- "key": null,
- "id": null,
- "name": null
}, - "vendor": {
- "key": null,
- "id": null,
- "name": null
}, - "project": {
- "key": null,
- "id": null,
- "name": null
}, - "employee": {
- "key": null,
- "id": null,
- "name": null
}, - "warehouse": {
- "key": null,
- "id": null,
- "name": null
}, - "task": {
- "key": null,
- "id": null,
- "name": null
}
}, - "documentId": "Revenue_attachment",
- "description": null,
- "numberOfUnits": null,
- "currency": {
- "baseCurrency": "USD",
- "txnCurrency": "USD",
- "exchangeRateDate": "2023-06-08",
- "exchangeRateTypeId": null,
- "exchangeRate": 1
}, - "accountAllocationTimePeriod": null,
- "allocation": {
- "id": null,
- "key": null
}, - "audit": {
- "createdDateTime": "2023-06-09T00:33:58Z",
- "modifiedDateTime": "2023-06-09T00:33:59Z",
- "createdBy": "68",
- "modifiedBy": "68"
}, - "state": "submitted",
- "isBillable": false,
- "isBilled": null,
- "href": "/objects/general-ledger/journal-entry-line/8434"
}, - {
- "id": "8435",
- "key": "8435",
- "journalEntry": {
- "id": "3235",
- "key": "3235",
- "href": "/objects/general-ledger/journal-entry/3235"
}, - "lineNumber": 2,
- "transactionType": "Debit",
- "entryDate": "2023-06-08",
- "transactionAmount": 200,
- "glAccount": {
- "key": "81",
- "id": "1000",
- "name": "Checking",
- "href": "/objects/general-ledger/account/81"
}, - "dimensions": {
- "department": {
- "key": "1",
- "id": "01",
- "name": "Sales",
- "href": "/objects/company-config/department/1"
}, - "location": {
- "key": "1",
- "id": "CA",
- "name": "California",
- "href": "/objects/company-config/location/1"
}, - "class": {
- "key": null,
- "id": null,
- "name": null
}, - "item": {
- "key": null,
- "id": null,
- "name": null
}, - "customer": {
- "key": null,
- "id": null,
- "name": null
}, - "vendor": {
- "key": null,
- "id": null,
- "name": null
}, - "project": {
- "key": null,
- "id": null,
- "name": null
}, - "employee": {
- "key": null,
- "id": null,
- "name": null
}, - "warehouse": {
- "key": null,
- "id": null,
- "name": null
}, - "task": {
- "key": null,
- "id": null,
- "name": null
}
}, - "documentId": "Revenue_attachment",
- "description": null,
- "numberOfUnits": null,
- "currency": {
- "baseCurrency": "USD",
- "txnCurrency": "USD",
- "exchangeRateDate": "2023-06-08",
- "exchangeRateTypeId": null,
- "exchangeRate": 1
}, - "accountAllocationTimePeriod": null,
- "allocation": {
- "id": null,
- "key": null
}, - "audit": {
- "createdDateTime": "2023-06-09T00:33:59Z",
- "modifiedDateTime": "2023-06-09T00:33:59Z",
- "createdBy": "68",
- "modifiedBy": "68"
}, - "state": "submitted",
- "isBillable": false,
- "isBilled": null,
- "href": "/objects/general-ledger/journal-entry-line/8435"
}
], - "href": "/objects/general-ledger/journal-entry/3235"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing journal entry by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned key for the journal entry. Example: 132 |
object The journal to use for this entry. | |||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
description | string Description of the transaction. Example: "Revenue entries" | ||||||||||||||||||||||||||||
postingDate | string <date> Posting date. Example: "2023-04-01" | ||||||||||||||||||||||||||||
automaticReversalDate | string or null <date> Reversal date if you want to reverse this transaction on a certain date. Must be greater than Example: "2023-04-04" | ||||||||||||||||||||||||||||
moduleName | string Intacct module that the journal entry originates from. Example: "2.GL" | ||||||||||||||||||||||||||||
referenceNumber | string User-provided reference number. Example: "Recurr_GL_101" | ||||||||||||||||||||||||||||
object Base location for a multi-entity company. Required if a company is multi-entity enabled and entries do not balance by entity. | |||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
object Tax properties associated with the journal entry. | |||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
Array of objects >= 2 items Journal entry lines included in this entry. Must have at least two lines, one debit and one credit. | |||||||||||||||||||||||||||||
Array (>= 2 items)
|
OK
Bad Request
{- "postingDate": "2023-12-11",
- "state": "submitted",
- "lines": [
- {
- "key": 195,
- "txnType": "debit",
- "txnAmount": "100",
- "glAccount": {
- "id": "1000"
}, - "dimensions": {
- "department": {
- "id": "11"
}, - "location": {
- "id": "1"
}
}, - "documentId": "test",
- "currency": {
- "txnCurrency": "USD"
}
}, - {
- "key": 196,
- "txnType": "debit",
- "txnAmount": "100",
- "glAccount": {
- "id": "1000"
}, - "dimensions": {
- "department": {
- "id": "11"
}, - "location": {
- "id": "1"
}
}, - "documentId": "test",
- "currency": {
- "txnCurrency": "USD"
}
}, - {
- "txnType": "credit",
- "txnAmount": "200",
- "glAccount": {
- "id": "4000"
}, - "dimensions": {
- "department": {
- "id": "11"
}, - "location": {
- "id": "1"
}
}, - "documentId": "Test1",
- "currency": {
- "txnCurrency": "USD"
}
}
]
}
{- "ia::result": {
- "key": "1",
- "id": "1",
- "href": "/objects/general-ledger/journal-entry/1"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes a journal entry.
key required | string System-assigned key for the journal entry. Example: 132 |
No Content
Bad Request
{- "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
}
}
Submit a journal entry for approval.
key required | string System-assigned key for the journal entry. Example: "132" |
OK
Bad Request
{- "key": "132"
}
{- "ia::result": {
- "key": "132",
- "id": "132",
- "href": "/objects/general-ledger/journal-entry/132",
- "state": "submitted"
}, - "ia::meta": {
- "totalCount": 3,
- "totalSuccess": 2,
- "totalError": 1
}
}
Approve a submitted journal entry.
key required | string System-assigned key for the journal entry. Example: "132" |
notes | string Notes or comments about this journal entry. Example: "Approved, ready for use" |
OK
Bad Request
{- "key": "132",
- "notes": "Approved, ready for use"
}
{- "ia::result": {
- "key": "132",
- "id": "132",
- "href": "/objects/general-ledger/journal-entry/132",
- "state": "approved"
}, - "ia::meta": {
- "totalCount": 3,
- "totalSuccess": 2,
- "totalError": 1
}
}
Decline a submitted journal entry.
key required | string System-assigned key for the journal entry. Example: "132" |
notes | string Notes or comments about this journal entry. Example: "Declined, missing information" |
OK
Bad Request
{- "key": "132",
- "notes": "Declined, missing information"
}
{- "ia::result": {
- "key": "132",
- "id": "132",
- "href": "/objects/general-ledger/journal-entry/132",
- "state": "declined"
}, - "ia::meta": {
- "totalCount": 3,
- "totalSuccess": 2,
- "totalError": 1
}
}
Recalls a journal entry.
key required | string System-assigned key for the journal entry. Example: "132" |
OK
Bad Request
{- "key": "132"
}
{- "ia::result": {
- "key": "132",
- "id": "132",
- "href": "/objects/general-ledger/journal-entry/132",
- "state": "draft"
}, - "ia::meta": {
- "totalCount": 3,
- "totalSuccess": 2,
- "totalError": 1
}
}
Reverses a journal entry.
key required | string System-assigned key for the journal entry. Example: "132" |
reverseDate required | string <date> Reversal date to reverse the transaction on a certain date. Must be greater than Example: "2023-04-04" |
OK
Bad Request
{- "key": "132",
- "reverseDate": "2023-04-04"
}
{- "ia::result": {
- "key": "132",
- "id": "132",
- "href": "/objects/general-ledger/journal-entry/132",
- "state": "reversed"
}, - "ia::meta": {
- "totalCount": 3,
- "totalSuccess": 2,
- "totalError": 1
}
}
Reclassifies a journal entry.
key required | string System-assigned unique key for the journal entry. Used to identify the journal entry in URLs or JSON bodies for all operations on the journal entry. Example: "132" | ||||||||||||||||||||||||||||
id | string Same as Example: "132" | ||||||||||||||||||||||||||||
description | string Description of the transaction. Example: "Revenue entries" | ||||||||||||||||||||||||||||
referenceNumber | string User-provided reference number. Example: "Recurr_GL_101" | ||||||||||||||||||||||||||||
object Supporting document for the journal batch. | |||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
state | string Default: "posted" State of the entry. The only valid values when creating a new entry are Example: "draft" | ||||||||||||||||||||||||||||
Array of objects Journal entry lines included in this entry. Must have at least two lines, one debit and one credit. | |||||||||||||||||||||||||||||
Array
|
OK
Bad Request
{- "key": "132",
- "id": "132",
- "description": "Revenue entries",
- "referenceNumber": "Recurr_GL_101",
- "attachment": {
- "key": "6",
- "id": "Doc6331"
}, - "state": "draft",
- "lines": [
- {
- "txnType": "credit",
- "txnAmount": "100.45",
- "documentId": "Revenue_Documentation",
- "description": "Revenue Entries",
- "numberOfUnits": 5,
- "accountingPeriod": 11,
- "isBillable": false,
- "state": "draft",
- "currency": {
- "exchangeRateDate": "2014-01-08",
- "exchangeRateTypeId": "Intacct Daily Rate",
- "exchangeRate": 0.78,
- "baseCurrency": "USD",
- "txnCurrency": "GBP"
}, - "glAccount": {
- "key": "144",
- "id": "1112"
}, - "allocation": {
- "key": "21",
- "id": "FA_ALLOC"
}, - "dimensions": {
- "location": {
- "key": "22",
- "id": "LOC-22"
}, - "department": {
- "key": "11",
- "id": "DEP-11"
}, - "employee": {
- "key": "10",
- "id": "EMP-10"
}, - "project": {
- "key": "2",
- "id": "NET-XML30-2"
}, - "customer": {
- "key": "13",
- "id": "CUST-13"
}, - "vendor": {
- "key": "357",
- "id": "1605212096809"
}, - "item": {
- "key": "13",
- "id": "Case 13"
}, - "warehouse": {
- "key": "6",
- "id": "WH01"
}, - "class": {
- "key": "731",
- "id": "REST_CLS_001"
}, - "task": {
- "id": "1",
- "key": "1"
}, - "costType": {
- "id": "2",
- "key": "2"
}, - "asset": {
- "id": "A001",
- "key": "1"
}, - "contract": {
- "id": "CON-0045-1",
- "key": "12"
}, - "affiliateEntity": {
- "key": "23",
- "id": "AFF-23"
}
}, - "journalEntry": {
- "id": "132",
- "key": "132"
}, - "taxEntries": [
- {
- "baseTaxAmount": "100.00",
- "txnTaxAmount": "100.00",
- "taxRate": 1.0299
}
]
}
]
}
{- "ia::result": {
- "key": "132",
- "id": "132",
- "href": "/objects/general-ledger/journal-entry/132",
- "state": "posted"
}, - "ia::meta": {
- "totalCount": 3,
- "totalSuccess": 2,
- "totalError": 1
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "general-ledger/journal-entry" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
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 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
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
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
| |||||||||
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 |
OK
Bad Request
{- "object": "general-ledger/journal-entry",
- "filters": [
- {
- "$eq": {
- "journalSymbol": "AP"
}
}, - {
- "$between": {
- "postingDate": [
- "2022-01-01",
- "2022-04-30"
]
}
}
], - "fields": [
- "key",
- "id",
- "href"
], - "orderBy": [
- {
- "postingDate": "asc"
}
]
}
{- "ia::result": [
- {
- "key": "17",
- "id": "17",
- "href": "/objects/general-ledger/journal-entry/17",
- "postingDate": "2022-01-31"
}, - {
- "key": "18",
- "id": "18",
- "href": "/objects/general-ledger/journal-entry/18",
- "postingDate": "2022-02-28"
}, - {
- "key": "20",
- "id": "20",
- "href": "/objects/general-ledger/journal-entry/20",
- "postingDate": "2022-03-31"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}