Update journal entry

put

https://{tenant}.onechurchsoftware.com/api/journalentries/{id}

Full update of a journal entry: optional fields that are omitted are cleared, and the line items replace the existing ones. Bill payment entries keep their original memo. First retrieve the current entry from /api/journalentries/{id}, apply your changes, then send back the full object.

Required permission: Full Write Accounting

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the journal entry

Body Params

The details of the journal 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.

memo

string | null

The entry's memo. Required for fund transfers.

reference

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.

items

files

array of objects | null

Files attached to the entry. On write, provide the ids of previously uploaded documents to attach them to the entry.

files

printCheck

boolean

Whether the entry is a check queued for printing.

amount

double | null

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

account

object | null

A reference to an existing record by its id.

from

object | null

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

object | null

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

split

boolean

Whether the entry splits across multiple line items.

splitPayee

boolean

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

payee

object | null

A reference to an existing record by its id.

perspective

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.

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).

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

401

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

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK

404Not Found