Delete journal entries

delete

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

Delete draft journal entries in bulk. Provide ids, or explicitly set include to false to delete every draft matching the filters (and every draft outright when no filters are given); an empty body is rejected. Only drafts are deleted; entries that are posted, reconciled, printed, batch-linked, or starting balance/bill entries are skipped without an error.

Required permission: Full Write Accounting

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

entry

int32

≥ 1

Return the single journal entry with this id.

date.start

date

Return entries dated on or after this date.

date.end

date

Return entries dated on or before this date.

account

string

Comma-delimited list of account ids. Returns entries with a line item posted to one of those accounts.

type

string

Comma-delimited list of entry kinds: 1 = Increase, 2 = Decrease (both relative to the perspective account), 3 = Account Transfer, 4 = Fund Transfer, 5 = Batch Posting, 6 = Starting Balance, 7 = Journal Entry, 8 = Bill Payment.

label

string

Comma-delimited list of register actions, relative to the perspective account: 1 = Deposit, 2 = Payment, 3 = Transfer In, 4 = Transfer Out, 5 = Refund, 6 = Return, 7 = Income Reversal, 8 = Pay Down, 9 = Charge, 10 = Fund Transfer In, 11 = Fund Transfer Out.

fund

string

The id of a single fund. Returns entries with a line item in that fund. Only one fund id is supported.

tags

string

Comma-delimited list of accounting tag ids. Returns entries with a line item carrying one of those tags.

method

string

Comma-delimited list of payment method ids. Use -1 to include entries without a payment method. Values come from /api/property_values/accounting_payment_methods/values.

status

string

Comma-delimited list of status ids or codes (je_status_draft, je_status_posted, je_status_voided).

amount.start

double

Return entries with a total of at least this amount.

amount.end

double

Return entries with a total of at most this amount.

payee

string

Return entries with a line item payee whose name contains the given text.

memo

string

Return entries whose memo or line item descriptions contain the given text.

reconciliation

int32

≥ 1

The id of a bank reconciliation. Returns the entries in that reconciliation; for an in-progress reconciliation, unreconciled candidate entries are included as well.

reference

string

Return entries whose entry number or reference matches the given value exactly.

reconciled

boolean

If true, returns only reconciled entries; if false, only unreconciled entries.

perspective

int32

≥ 1

The id of an account. When given, register-relative filters (type, label, amount) are evaluated from that account's point of view.

payeeId

int32

≥ 1

The id of a payee (person or business). Returns entries with a line item for that payee.

created.start

date-time

Return entries created on or after this date and time.

created.end

date-time

Return entries created on or before this date and time.

modified.start

date-time

Return entries modified on or after this date and time.

modified.end

date-time

Return entries modified on or before this date and time.

createdBy

string

Return entries created by users whose name contains the given text.

view

string

A named register view: deposits or payments. Defaults to all.

Body Params

The selection criteria

ids

array of doubles | null

The ids the operation applies to: an include list by default, or an exclude list when include is false. For deletes, required unless include is false.

ids

include

boolean | null

Whether ids is an include list (true, default) or an exclude list (false). Setting include to false with no ids applies the operation to every record matching the query filters.

Responses

200

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!