Adjust journal entry

Correct a posted journal entry: the original entry is voided (a reversal entry is posted as of the body's date, with the body's memo as the reason) and a replacement entry is created from the body. An entry can only be adjusted once; to make further changes, adjust the newest corrected entry. When the entry is applied to a bill (a payment), the replacement stays applied to that bill, keeps the entry's campuses (campuses in the body are ignored) and, for a bill payment, its type; send each line's id so the replacement line keeps its bill line; the adjust is refused without the ids for a payment applied to a bill. A credit memo or write-off applied to a bill cannot be adjusted.

Required permission: Full Write Accounting

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the journal entry to correct

Body Params

The details of the replacement entry

date
required

The entry's posting date. Cannot fall within a closed accounting period.

int32

The id of the journal entry.

type
object | null

The entry's kind: 1 = Manual, 2 = Fund Transfer, 3 = Register Entry, 4 = Starting Balance, 5 = Bill Payment, 6 = Payable, 7 = Batch Posting, 8 = Transfer, 9 = Credit Memo, 10 = Write-Off, 11 = Closing Entry. On write, only Manual (1, the default), Fund Transfer (2), and Register Entry (3) can be created directly; the other kinds are produced by their own workflows. An update must send the entry's own type, since an existing entry's type cannot change; a Register Entry and a Transfer may be sent as either, because the save picks between the two from the lines.

string | null

The entry's memo. Required for fund transfers.

string | null

The entry's reference (e.g. a check number). Returns To be determined while a check is waiting to print.

method
object | null

The entry's payment method. On write, provide either the id or the code; the code takes precedence.

items
array of objects | null

The entry's line items. For register-style entries viewed from an account, the account's own control line is omitted. On write, manual entries use each line's debit/credit amounts while register-style entries use each line's amount. A register-style update keeps the lines the view from the account left out. It takes the account they were read from from shownRegister when the entry has a line on it; otherwise it works that account out from the ids the lines are sent back with, so send each line back with the id it was read with. The update is refused when the ids sent belong to more than one register (as when read with no perspective), whatever shownRegister names. When shownRegister is not sent, or names an account the entry has no line on, it is also refused when no line comes back with its id while the entry holds more than one pair of lines and touches more than one register account, or none.

items
files
array of objects | null

Files attached to the entry. To attach one, upload it first with type journal_entry and no linkedTo, then send the returned file id here. Attaching is additive: files that are already attached stay attached when they are left out, and are removed only by deleting the file.

files
campuses
array of objects | null

The campuses the entry belongs to, ordered by name; empty when it belongs to every campus. On writes, send
the ids to set the campus set (an empty list means every campus); omit the property to keep the current set;
on a create an omitted property places the entry at the caller's lens default when the caller is
campus-limited, else at every campus. Entries created from a bill, a batch or a void inherit their source's
set and ignore this property; a bank transaction confirmed by a signed-in user takes their lens default and
one confirmed by the bank feed sync belongs to every campus. A campus-limited caller can only add or
remove campuses within their access and cannot change whether the entry belongs to every campus.
While two or more organizations exist, a key-less or bank-feed entry lands inside one organization instead of every campus:
the bank account's for a confirmed or matched bank transaction, else the caller's single organization, else the default one.
A lens spanning organizations lands at its campuses in the organization a confirmed or matched bank transaction or the entry's accounts and funds name, and is refused when they name none.
Ignored while multi-campus is off.

campuses
organization
object | null

The one organization this record belongs to (its books): set on every record, the default organization
until a second one exists; null only for a record saved while this release was being installed, before every record was assigned its organization. On a
save, send it with campuses empty to scope the record to the whole organization; when campuses are
sent the organization is taken from them. Required while multi-org is on; All is not offered for financial
records.

boolean

Whether the entry is a check queued for printing.

double | null

For fund transfers, the amount transferred. Required when creating a fund transfer.

account
object | null

The entry's primary account: the asset or liability account on fund transfers, or the register account on register-style entries. Only basic identifying fields are populated on reads; required on fund transfer and register-style writes.

from
object | null

For fund transfers, the fund the amount was transferred from (id and name). Required when creating a fund transfer.

to
object | null

For fund transfers, the fund the amount was transferred to (id and name). Required when creating a fund transfer.

boolean

Whether the entry splits across multiple line items.

boolean

Whether the entry's line items have more than one payee.

payee
object | null

The entry's payee, for register-style entries. When the entry does not split payees, this payee is applied to every line. A caller who does not read the payee in full sees only what the payee's privacy settings share; a business keeps its details.

int32 | null

For register-style writes, the id of the register account the entry is entered from; required and normally the same as the account id.

int32 | null

For register-style updates, the register account the entry was read from: the perspective the GET was called with. When sent, it decides which lines the register view hid, and those lines are kept as they are; it is ignored when the entry has no line on that account. Optional; without it the hidden lines are worked out from the line ids sent, else from the entry's only register account. A save whose line ids were shown from more than one register, or whose register cannot be told, is refused.

status
object | null

The entry's status (je_status_draft, je_status_posted, or je_status_voided). On write, set je_status_draft to save a draft or je_status_posted to post the entry; provide either the id or the code (the code takes precedence). An entry on a completed reconciliation, matched to a bank transaction, with a printed check, or in a closed accounting period cannot be saved as a draft, and changing the status of an entry in a closed accounting period is refused (400). A voided entry keeps its status whatever the request sends, and the reversal of a voided entry cannot be saved as a draft.

bankItems
array of objects | null

Bank feed transactions to link to this entry by id. The entry's total must match each bank item's amount.

bankItems
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json