Search line items

get

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

Retrieve individual journal entry line items (debits and credits) matching the given filters, most recent first.

Required permission: Full Read Accounting

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

entry

int32

≥ 1

The id of a journal entry. Returns only that entry's line items.

accountType

string

Comma-delimited list of account type ids or codes (coa_type_asset, coa_type_liability, coa_type_equity, coa_type_income, coa_type_expense).

type

string

Comma-delimited list of journal entry type ids: 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.

date.start

date-time

Return line items dated on or after this date.

date.end

date-time

Return line items dated on or before this date.

account

string

Comma-delimited list of account ids. Returns line items posted to one of those accounts.

fund

string

Comma-delimited list of fund ids. Returns line items in one of those funds.

tags

string

Comma-delimited list of accounting tag ids. Returns line items carrying one of those tags.

status

string

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

description

string

Return line items whose description contains the given text.

debit.start

double

Return line items with a debit of at least this amount.

debit.end

double

Return line items with a debit of at most this amount.

credit.start

double

Return line items with a credit of at least this amount.

credit.end

double

Return line items with a credit of at most this amount.

payee

string

Return line items whose payee's name contains the given text.

createdBy

string

Return line items created by users whose name contains the given text.

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