v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB

Core Accounting

List Budget Accounts

    Retrieve a list of budget accounts with optional filtering and sorting.

    Supports including soft-deleted records for audit and recovery purposes.
    When include_deleted=true, returns ONLY deleted records instead of active records.
    Deleted records contain minimal data: 'id', 'is_deleted=true', 'deleted_at' timestamp,
    and 'last_modified_at'. When 'false' or omitted, returns ONLY active records.
    This provides clean separation between active and deleted data.

get/coa/api/budgets/{budget_pk}/accounts

Path parameters

budget_pkinteger required

Query parameters

include_deletedboolean

When set to 'true', returns ONLY deleted records instead of active records. Deleted records contain minimal data: 'id', 'is_deleted=true', 'deleted_at' timestamp, and 'last_modified_at'. When 'false' or omitted, returns ONLY active records. This provides clean separation between active and deleted data.

last_modified_at__gtestring

Filter for records modified on or after this timestamp. Format: ISO 8601 (e.g., '2024-01-01T00:00:00Z' or '2024-01-01'). Works with both active records and deleted records (filters by deletion time for deleted records).

last_modified_at__ltestring

Filter for records modified on or before this timestamp. Format: ISO 8601 (e.g., '2024-12-31T23:59:59Z' or '2024-12-31'). Works with both active records and deleted records (filters by deletion time for deleted records).

Response

idinteger required

is_deletedboolean required

deleted_atstring date-time nullable required

account_namestring required

account_lineagestring required

department_namestring required

periodinteger

amountnumber double

created_atstring date-time required

last_modified_atstring date-time required

customerinteger required

budgetinteger required

accountinteger required

departmentinteger nullable required