Archive account (soft delete)
Archive an account (soft delete).
Validations:
- Cannot archive account with non-zero balance
- Cannot archive account with active child accounts
Returns the archived account with is_active set to false.
Flexible lookup: The account_id parameter accepts UUID, account code, or external_id.
Authorizations
Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>
Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.
Path Parameters
A UUID string identifying this account.
Response
Detailed serializer for account with additional information.
Unique account identifier
Account code from chart of accounts (e.g., '1000', '4000')
Account name from chart of accounts
Account currency from business base currency (GBP, EUR, USD)
Account type code (asset, liability, equity, revenue, expense)
asset- Assetliability- Liabilityequity- Equityrevenue- Revenueexpense- Expense
asset, liability, equity, revenue, expense Human-readable account type (e.g., 'Current Asset', 'Revenue')
Account subtype code for more granular classification (bank, cash, etc.)
current_assets- Current Assetsnon_current_assets- Non-current Assetscurrent_liabilities- Current Liabilitiesnon_current_liabilities- Non-current Liabilitiesshare_capital- Share Capitalshare_premium- Share Premiumreserves- Reservesretained_earnings- Retained Earningsrevenue- Revenueother_operating_income- Other Operating Incomefinance_income- Finance Incomedirect_costs- Direct Costsoperating_expenses- Operating Expensesfinance_costs- Finance Costsincome_tax- Income Tax
current_assets, non_current_assets, current_liabilities, non_current_liabilities, share_capital, share_premium, reserves, retained_earnings, revenue, other_operating_income, finance_income, direct_costs, operating_expenses, finance_costs, income_tax Account subtype for more granular classification
Parent account code if this is a sub-account (null for top-level accounts)
Current balance in cents
Formatted balance with currency symbol (e.g., '£12,500.50')
Debit balance in cents
Credit balance in cents
Period balance in cents (null if no period filter applied)
Formatted period balance with currency symbol (null if no period filter)
Whether this account has sub-accounts (nested hierarchy)
Depth in account hierarchy (0 for root accounts)
Whether this account is active and accepting transactions
Detailed account description
Bank institution name (for bank accounts only)
International Bank Account Number (for bank accounts)
UK bank sort code (for UK bank accounts, format: XX-XX-XX)
Masked account number showing last 4 digits (e.g., '****5555')
Total number of debit transactions (count, not amount)
Total number of credit transactions (count, not amount)
Date of most recent journal entry
Reference of most recent journal entry
List of sub-accounts if this is a parent account (empty array if no children)