Delete budgets

delete

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

Delete the budgets matching the filters and selection, along with all their budgeted amounts. Provide ids, or explicitly set include to false to delete every budget matching the filters (and every budget outright when no filters are given); an empty body is rejected.

Required permission: Full Write 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).

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.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

400Bad Request