Journal entries

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.

List journal entries

get/objects/general-ledger/journal-entry

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.

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

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "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
    }
}

Create a journal entry

post/objects/general-ledger/journal-entry

Creates a new journal entry (transaction). You can post a transaction to a journal right away, or save it as a draft.

  • Draft transactions do not have to be complete; they can be reviewed and updated before they are posted.
  • In order to post a journal entry, the entire transaction must balance and all required information must be entered.
Permissions and other requirements
SubscriptionGeneral Ledger, Projects (for revenue recognition of projects)
User typeBusiness
PermissionsAdd Journal Entries
SecurityOAuth2
Request
Request Body schema: application/json

Journal entry to create

required
object

The journal to use for this entry.

key
string

System-assigned key for the journal.

Example: "3"
id
string

The id of the journal.

Example: "EJ"
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)
txnAmount
required
string <decimal-precision-2>

Transaction amount as an absolute value.

Example: "100.45"
txnType
required
string
Default: "debit"

Transaction type - debit or credit.

Enum: "credit" "debit"
Example: "credit"
required
object
documentId
string

Document number of entry.

Example: "Revenue_Documentation"
description
string

Description of the journal entry line.

Example: "Revenue Entries"
numberOfUnits
integer

Number of units

Example: 5
accountingPeriod
integer

Accounting period if company uses custom accounting periods.

Example: 11
isBillable
boolean
Default: false

Set to true to mark the line item as billable. (Requires Projects subscription and billable General Ledger transactions to be enabled.)

Example: false
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

Template to use for predefined transaction allocations.

object
object

Journal entry that this journal entry line is owned by.

Array of objects

Tax Entries of the journal entry

automaticReversalDate
string or null <date>

Reversal date if you want to reverse this transaction on a certain date. Must be greater than postingDate.

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.

key
string

Location key.

Example: "32"
id
string

Location unique ID.

Example: "BC"
state
string
Default: "posted"

State of the entry. The only valid values when creating a new entry are posted (default) to post to the GL, and draft.

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

Tax properties associated with the journal entry.

taxImplication
string or null
Default: null

Tax implications. This field applies only to companies using the Taxes application to track VAT or GST.

Enum: "inbound" "none" null "outbound"
Example: "inbound"
object

Vendor to use for tax-related information when taxImplications is set to inbound.

key
string

System-assigned key for the vendor.

Example: "15"
id
string

Unique identifier of the vendor.

Example: "V-00014"
object

Customer to use for tax-related information when taxImplications is set to outbound.

key
string

System-assigned key for the customer.

Example: "14"
id
string

Unique identifier of the customer.

Example: "C-00019"
object

Contact information

key
string

System-assigned key to uniquely identify the contact.

Example: "416"
id
string

Name of the contact.

Example: "Klay Vanderbilt"
Responses
201

Created

400

Bad Request

Request samples
application/json
{
  • "glJournal": {
    • "id": "GJ"
    },
  • "postingDate": "2022-04-01",
  • "description": "March Revenue Posting",
  • "lines": [
    • {
      • "lineNumber": 1,
      • "txnType": "credit",
      • "entryDate": "2022-04-01",
      • "txnAmount": "200",
      • "glAccount": {
        },
      • "dimensions": {
        },
      • "documentId": "Revenue_attachment"
      },
    • {
      • "lineNumber": 2,
      • "txnType": "debit",
      • "entryDate": "2022-04-01",
      • "txnAmount": "200",
      • "glAccount": {
        },
      • "dimensions": {
        },
      • "documentId": "Revenue_attachment"
      }
    ]
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "41",
    • "id": "41",
    • "href": "/objects/general-ledger/journal-entry/41"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Get journal entry

get/objects/general-ledger/journal-entry/{key}

Returns detailed information for a specified journal entry.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the journal entry.

Example: 132
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "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": [
      • {
        },
      • {
        }
      ],
    • "href": "/objects/general-ledger/journal-entry/3235"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Update a journal entry

patch/objects/general-ledger/journal-entry/{key}

Updates an existing journal entry by setting field values. Any fields not provided remain unchanged.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the journal entry.

Example: 132
Request Body schema: application/json
object

The journal to use for this entry.

key
string

System-assigned key for the journal.

Example: "3"
id
string

The id of the journal.

Example: "EJ"
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 postingDate.

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.

key
string

Location key.

Example: "32"
id
string

Location unique ID.

Example: "BC"
object

Tax properties associated with the journal entry.

taxImplication
string or null
Default: null

Tax implications. This field applies only to companies using the Taxes application to track VAT or GST.

Enum: "inbound" "none" null "outbound"
Example: "inbound"
object

Vendor to use for tax-related information when taxImplications is set to inbound.

key
string

System-assigned key for the vendor.

Example: "15"
id
string

Unique identifier of the vendor.

Example: "V-00014"
object

Customer to use for tax-related information when taxImplications is set to outbound.

key
string

System-assigned key for the customer.

Example: "14"
id
string

Unique identifier of the customer.

Example: "C-00019"
object

Contact information

key
string

System-assigned key to uniquely identify the contact.

Example: "416"
id
string

Name of the contact.

Example: "Klay Vanderbilt"
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)
txnType
string
Default: "debit"

Transaction type - debit or credit.

Enum: "credit" "debit"
Example: "credit"
txnAmount
string <decimal-precision-2>

Transaction amount as an absolute value.

Example: "100.45"
documentId
string

Document number of entry.

Example: "Revenue_Documentation"
description
string

Description of the journal entry line.

Example: "Revenue Entries"
numberOfUnits
integer

Number of units

Example: 5
accountingPeriod
integer

Accounting period if company uses custom accounting periods.

Example: 11
isBillable
boolean
Default: false

Set to true to mark the line item as billable. (Requires Projects subscription and billable General Ledger transactions to be enabled.)

Example: false
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
object

Template to use for predefined transaction allocations.

object
object

Journal entry that this journal entry line is owned by.

Array of objects

Tax Entries of the journal entry

Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "postingDate": "2023-12-11",
  • "state": "submitted",
  • "lines": [
    • {
      • "key": 195,
      • "txnType": "debit",
      • "txnAmount": "100",
      • "glAccount": {
        },
      • "dimensions": {
        },
      • "documentId": "test",
      • "currency": {
        }
      },
    • {
      • "key": 196,
      • "txnType": "debit",
      • "txnAmount": "100",
      • "glAccount": {
        },
      • "dimensions": {
        },
      • "documentId": "test",
      • "currency": {
        }
      },
    • {
      • "txnType": "credit",
      • "txnAmount": "200",
      • "glAccount": {
        },
      • "dimensions": {
        },
      • "documentId": "Test1",
      • "currency": {
        }
      }
    ]
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "1",
    • "href": "/objects/general-ledger/journal-entry/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Delete a journal entry

delete/objects/general-ledger/journal-entry/{key}

Deletes a journal entry.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the 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
    }
}

Submit a journal entry

post/workflows/general-ledger/journal-entry/submit

Submit a journal entry for approval.

SecurityOAuth2
Request
Request Body schema: application/json
key
required
string

System-assigned key for the journal entry.

Example: "132"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "key": "132"
}
Response samples
application/json
{
  • "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 journal entry

post/workflows/general-ledger/journal-entry/approve

Approve a submitted journal entry.

SecurityOAuth2
Request
Request Body schema: application/json
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"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "key": "132",
  • "notes": "Approved, ready for use"
}
Response samples
application/json
{
  • "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 journal entry

post/workflows/general-ledger/journal-entry/decline

Decline a submitted journal entry.

SecurityOAuth2
Request
Request Body schema: application/json
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"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "key": "132",
  • "notes": "Declined, missing information"
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "132",
    • "id": "132",
    • "href": "/objects/general-ledger/journal-entry/132",
    • "state": "declined"
    },
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 2,
    • "totalError": 1
    }
}

Recall a journal entry

post/workflows/general-ledger/journal-entry/recall

Recalls a journal entry.

SecurityOAuth2
Request
Request Body schema: application/json
key
required
string

System-assigned key for the journal entry.

Example: "132"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "key": "132"
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "132",
    • "id": "132",
    • "href": "/objects/general-ledger/journal-entry/132",
    • "state": "draft"
    },
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 2,
    • "totalError": 1
    }
}

Reverse a journal entry

post/workflows/general-ledger/journal-entry/reverse

Reverses a journal entry.

SecurityOAuth2
Request
Request Body schema: application/json
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 postingDate.

Example: "2023-04-04"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "key": "132",
  • "reverseDate": "2023-04-04"
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "132",
    • "id": "132",
    • "href": "/objects/general-ledger/journal-entry/132",
    • "state": "reversed"
    },
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 2,
    • "totalError": 1
    }
}

Reclassify a journal entry

post/workflows/general-ledger/journal-entry/reclassify

Reclassifies a journal entry.

SecurityOAuth2
Request
Request Body schema: application/json
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 key for this object.

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.

key
string

System-assigned key for the attachment.

Example: "6"
id
string

Unique ID of the attachment.

Example: "Doc6331"
state
string
Default: "posted"

State of the entry. The only valid values when creating a new entry are posted (default) to post to the GL, and draft.

Value: "posted"
Example: "draft"
Array of objects

Journal entry lines included in this entry. Must have at least two lines, one debit and one credit.

Array
txnType
string
Default: "debit"

Transaction type - debit or credit.

Enum: "credit" "debit"
Example: "credit"
txnAmount
string <decimal-precision-2>

Transaction amount as an absolute value.

Example: "100.45"
documentId
string

Document number of entry.

Example: "Revenue_Documentation"
description
string

Description of the journal entry line.

Example: "Revenue Entries"
numberOfUnits
integer

Number of units

Example: 5
accountingPeriod
integer

Accounting period if company uses custom accounting periods.

Example: 11
isBillable
boolean
Default: false

Set to true to mark the line item as billable. (Requires Projects subscription and billable General Ledger transactions to be enabled.)

Example: false
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
object

Template to use for predefined transaction allocations.

object
object

Journal entry that this journal entry line is owned by.

Array of objects

Tax Entries of the journal entry

Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "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": {
        },
      • "glAccount": {
        },
      • "allocation": {
        },
      • "dimensions": {
        },
      • "journalEntry": {
        },
      • "taxEntries": [
        ]
      }
    ]
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "132",
    • "id": "132",
    • "href": "/objects/general-ledger/journal-entry/132",
    • "state": "posted"
    },
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 2,
    • "totalError": 1
    }
}

Query 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/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 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/journal-entry",
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$between": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "href"
    ],
  • "orderBy": [
    • {
      • "postingDate": "asc"
      }
    ]
}
Response samples
application/json
{
  • "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
    }
}