WAwafeq
Accounts

List accounts

Changed on

Endpoint for retrieving a list of accounts.

get/accounts/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/accounts/
  • Auth
    API key in header Authorization

Query parameters

classification'ASSET' | 'EQUITY' | 'EXPENSE' | 'LIABILITY' | 'REVENUE' | '__null__'
  • ASSET - ASSET
  • EQUITY - EQUITY
  • EXPENSE - EXPENSE
  • LIABILITY - LIABILITY
  • REVENUE - REVENUE
  • __null__ - null

Classification

  • REVENUE - Revenue
  • EXPENSE - Expense
  • ASSET - Asset
  • LIABILITY - Liability
  • EQUITY - Equity
created_ts_afterstring date-time

The timestamp in UTC when the account was created

created_ts_beforestring date-time

The timestamp in UTC when the account was created

expandstring

Comma-separated related objects to return in full instead of as IDs. Accepted values: parent, parent.parent. Nested relations are joined with a dot.

external_idstring

External identifier

is_payment_enabledboolean

Is payment enabled

is_systemboolean

Filter system accounts

modified_ts_afterstring date-time

The timestamp in UTC when the account was last modified

modified_ts_beforestring date-time

The timestamp in UTC when the account was last modified

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

Response

countinteger required

The total number of results across all pages.

nextstring uri nullable

The URL of the next page of results, or null on the last page.

previousstring uri nullable

The URL of the previous page of results, or null on the first page.

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes