Search account register

get

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

Retrieve an account's register: its journal entries with amounts and a running balance relative to that account, most recent first. The perspective parameter (the account to view) is required. The running balance is omitted when date, type, amount, payee, memo, or account filters are applied.

Required permission: Full Read 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

Required. The id of the account whose register to view. Line items, amounts, and the running balance are presented relative to this account.

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.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

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