FinancialAccounts
Search FinancialAccounts
Search and list FinancialAccount records with filtering, sorting, and pagination.
GET
A FinancialAccount represents a bookkeeping account used for categorising revenue and payments.
Financial accounts can be assigned to Products, EventProducts, TimePasses, ExtraServices (resource prices), Tariffs and Charges to control how income is tracked and reported.
Each account has a
Important: Changing a financial account’s details or reassigning it to different items has no effect on existing invoices. The financial account recorded on each invoice line is captured at the time the invoice is issued and is never updated retroactively.
Code (typically matching an external accounting system reference), a Name, and an AccountType that determines where it appears:
| AccountType | Value | Purpose |
|---|---|---|
| Sales | 1 | Revenue from products, services and bookings |
| Payments | 2 | Incoming payment receipts |
| Deposits | 3 | Security deposits held against contracts |
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the FinancialAccount-List role.Enums
eFinancialAccountType — AccountType values
eFinancialAccountType — AccountType values
| Value | Name |
|---|---|
| 0 | None |
| 1 | Sales |
| 2 | Payments |
| 3 | Deposits |
Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by Business Id.
Filter by display name for this financial account.
Filter by short reference code, typically matching the account code in an external accounting system.
Filter by optional free-text description of the account’s purpose.
Filter by category of the account: Sales (1), Payments (2) or Deposits (3).
Range Filters
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of FinancialAccount records matching the query. See the Get one FinancialAccount endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response