List

Note

Keep in mind: the items in the list are returned according to the access level of the token owner.

Full list with pagination

POST https://do.workzeal.com/common/list/paging/5?columns=id,date,sum

Query Parameters

Name Type Description
columns* String List of columns
records_onpage Int Records per page, but no more than 500
page Int Page number
sorting_column String Sorting column
sorting_direction Int Sorting 0 Asc 1 Desc 
curl --location --request POST 'https://do.workzeal.com/common/list/paging/5?columns=id,date,sum,direction_id,note,company_id&records_onpage=50&page=1' \
--header 'Authorization: Bearer XXXX-XXXXXXX-XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw 'null'

Columns

Name Description
id Transaction ID
date Transaction date
sum Amount in the base currency
sum_currency Amount in the currency
direction_id Direction: 1 - receipt, 2 - expense
direction Direction as text
type_id Payment method ID
type Payment method as text
category_id Income/expense category ID
category Category as text
account_id Account ID
account Account as text
currency Account currency as text
note Note
user_id Responsible person ID
user_name Responsible person
company_id Client ID
company_name Client name
deal_id Deal ID
tags Tags

Filtering

Filters are added to the request as query parameters and can be combined with each other:

  • company_id - client ID, only the transactions of one client: ?company_id=368132
  • deal_id - deal ID, only the transactions of one deal: ?deal_id=12345
  • user_ids - responsible person IDs, one or several: ?user_ids=37 or ?user_ids=1,3,5
  • date1 - from date (YYYY-MM-DD format): ?date1=2026-08-01
  • date2 - to date (YYYY-MM-DD format): ?date2=2026-08-31
  • tags - comma-separated tags: ?tags=rent

Example: the transactions of one client for August:

curl --location --request POST 'https://do.workzeal.com/common/list/paging/5?columns=id,date,sum&company_id=368132&date1=2026-08-01&date2=2026-08-31' \
--header 'Authorization: Bearer XXXX-XXXXXXX-XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw 'null'

Note

This is a common pattern: pagination and filters work the same way in all modules of the universal list common/list/paging/{module}. See the detailed description on the deals list page.

Quick list by client or deal

GET https://do.workzeal.com/finance/list?company_id=368132

A simplified method without pagination: returns the cash flow transactions of one client, from newest to oldest. Instead of a client, you can request the transactions of one deal:

GET https://do.workzeal.com/finance/list?deal_id=12345

Query Parameters

Name Type Description
company_id Int Client ID. Required if deal_id is not passed
deal_id Int Deal ID. Required if company_id is not passed 
curl --location --request GET 'https://do.workzeal.com/finance/list?company_id=368132' \
--header 'Authorization: Bearer XXXX-XXXXXXX-XXXXXXX'

Response

{
  "status": "success",
  "error": "",
  "code": null,
  "rows": 0,
  "pages": 0,
  "page": 0,
  "value": "[ { ...transaction... }, { ...transaction... } ]"
}
// value - JSON array of cash flow transactions
Previous
Finance
Next
Add