Search budgets

get

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

Retrieve the budgets matching the given filters, with their total budgeted income and expense.

Required permission: Full Read Accounting

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Return budgets whose name contains the given text.

description

string

Return budgets whose description contains the given text.

year.start

double

Return budgets starting in or after this year.

year.end

double

Return budgets starting in or before this year.

status

string

Comma-delimited list of status ids or codes (budget_status_draft, budget_status_published).

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.

200OK