Skip to main content
PATCH
Update a Journal Entry

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-user-id
string | null

Optional external entity identifier that performed the update

Path Parameters

business_id
string<biz_string>
required

The id of the business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

journal_entry_id
string<je_string>
required

The id of the journal entry

Example:

"je_R2fAXCjqJPdpYata112zyW"

Body

application/json
description
string | null

The description of the Journal Entry

datetime
string<date-time> | null

The datetime the Journal Entry was created in UTC ISO-8601 format

line_changes
JELineEntryChanges · object | null

An object with optional create and delete values that modify the lines in the Journal Entry. To update a line, simply remove the old line and add a new one.

review_status
enum<string> | null

The new status to set on the Journal Entry

Available options:
bookkeeper_pending,
business_pending,
confirmed
is_reconciled
boolean | null

Whether the Journal Entry is reconciled

tags
Tags · object | null

Tags to apply to the Journal Entry, keyed by tag field name (the field must already exist). Each value is a tag value string, or a list of {value, amount?, ledger_id?} objects to split the amount across values and optionally pin a value to a ledger. Amounts left out are split evenly across the values. Supplying tags replaces all of the Journal Entry's tags; an empty object clears them. Only Journal Entries with no source transaction, invoice, or bill can be tagged this way.

Example:

Response

Successful Response

data
JournalEntryPublic · object
required