Search accounts

get

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

Retrieve the chart of accounts entries matching the given filters, ordered by account number.

Required permission: Full Read Accounting or Accounting Settings

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Return accounts whose number or name contains the given text.

description

string

Return accounts whose description contains the given text.

createdBy

string

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

fund

string

Comma-delimited list of fund ids. Returns accounts whose default fund is one of them. Use -1 to include accounts without a default fund.

type

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

category

string

Comma-delimited list of account category ids or codes. Category ids and codes appear on each account in the response.

boolean

If true, returns only register (bank/checking) accounts; if false, only non-register accounts.

payable

boolean

If true, returns only accounts-payable accounts; if false, only non-payable accounts.

receivable

boolean

If true, returns only accounts-receivable accounts; if false, only non-receivable accounts.

badDebt

boolean

If true, returns only bad-debt expense accounts; if false, only non-bad-debt accounts.

payableAdjustment

boolean

If true, returns only payable-adjustment accounts; if false, only non-adjustment accounts.

active

boolean

If true, returns only active accounts; if false, only deactivated accounts.

transactions.start

double

Return accounts with at least this many posted line items.

transactions.end

double

Return accounts with at most this many posted line items.

earliest.start

date-time

Return accounts whose earliest activity is on or after this date.

earliest.end

date-time

Return accounts whose earliest activity is on or before this date.

latest.start

date-time

Return accounts whose latest activity is on or after this date.

latest.end

date-time

Return accounts whose latest activity is on or before this date.

balance.start

double

Return accounts with a balance of at least this amount.

balance.end

double

Return accounts with a balance of at most this amount.

starting.start

double

Return accounts with a starting balance of at least this amount.

starting.end

double

Return accounts with a starting balance of at most this amount.

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