Deactivate account

Deactivate a chart of accounts entry so it can no longer be selected on new transactions. For asset, liability, and equity accounts with a non-zero balance, a transfer account is required: the remaining balance is moved to it with a posted journal entry. When the account being deactivated records processing fee income or expense, a replacement account is required. For income and expense accounts the body can be omitted.

Required permission: Accounting Settings

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the account

Body Params

The transfer and replacement account selections

transferAccount
object | null

The active account the remaining balance is transferred to. Required when deactivating an asset, liability, or equity account with a non-zero balance. Provide the id.

feeIncome
object | null

The account that takes over as the processing fee income account. Required when the account being deactivated records fee income. Provide the id.

feeExpense
object | null

The account that takes over as the processing fee expense account. Required when the account being deactivated records fee expense. Provide the id.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

401

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

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json