API Reference

Cash Flow

get
https://api.wafeq.com/v1/reports/cash-flow/

Generate cash flow report in currency from date_after to date_before range and group it by group_by parameter.

Query Params
branch__in
array of strings

The unique identifier of the branch. Multiple values may be provided. The special value 'null' may be provided to filter for null values.

branch__in
contact__in
array of strings

The unique identifier of the contact. Multiple values may be provided. The special value 'null' may be provided to filter for null values.

contact__in
cost_center__in
array of strings

The unique identifier of the cost center. Multiple values may be provided. The special value 'null' may be provided to filter for null values.

cost_center__in
string
enum
length ≥ 1

The currency of the report. Default: base currency of the organization.

  • AED - AED ⃱
  • SAR - SAR ⃁
  • USD - USD $
  • EUR - EUR €
  • CAD - CAD $
  • AFN - AFN ؋
  • ALL - ALL Lek
  • AMD - AMD դր.
  • ARS - ARS $
  • AUD - AUD $
  • AZN - AZN ман.
  • BAM - BAM KM
  • BDT - BDT ৳
  • BGN - BGN лв.
  • BHD - BHD د.ب.‏
  • BIF - BIF FBu
  • BND - BND $
  • BOB - BOB Bs
  • BRL - BRL R$
  • BWP - BWP P
  • BYN - BYN BYN
  • BZD - BZD $
  • CDF - CDF FrCD
  • CHF - CHF CHF
  • CLP - CLP $
  • CNY - CNY CN¥
  • COP - COP $
  • CRC - CRC ₡
  • CVE - CVE CV$
  • CZK - CZK Kč
  • DJF - DJF Fdj
  • DKK - DKK kr
  • DOP - DOP RD$
  • DZD - DZD د.ج.‏
  • EGP - EGP ج.م.‏
  • ERN - ERN Nfk
  • ETB - ETB Br
  • GBP - GBP £
  • GEL - GEL GEL
  • GHS - GHS GH₵
  • GNF - GNF FG
  • GTQ - GTQ Q
  • HKD - HKD $
  • HNL - HNL L
  • HRK - HRK kn
  • HUF - HUF Ft
  • IDR - IDR Rp
  • ILS - ILS ₪
  • INR - INR ₹
  • IQD - IQD د.ع.‏
  • IRR - IRR ﷼
  • ISK - ISK kr
  • JMD - JMD $
  • JOD - JOD د.أ.‏
  • JPY - JPY ￥
  • KES - KES Ksh
  • KHR - KHR ៛
  • KMF - KMF FC
  • KRW - KRW ₩
  • KWD - KWD د.ك.‏
  • KZT - KZT тңг.
  • LBP - LBP ل.ل.‏
  • LKR - LKR SL Re
  • LYD - LYD د.ل.‏
  • MAD - MAD د.م.‏
  • MDL - MDL MDL
  • MGA - MGA MGA
  • MKD - MKD MKD
  • MMK - MMK K
  • MOP - MOP MOP$
  • MUR - MUR MURs
  • MXN - MXN $
  • MYR - MYR RM
  • MZN - MZN MTn
  • NAD - NAD N$
  • NGN - NGN ₦
  • NIO - NIO C$
  • NOK - NOK kr
  • NPR - NPR नेरू
  • NZD - NZD $
  • OMR - OMR ر.ع.‏
  • PAB - PAB B/.
  • PEN - PEN S/.
  • PHP - PHP ₱
  • PKR - PKR ₨
  • PLN - PLN zł
  • PYG - PYG ₲
  • QAR - QAR ر.ق.‏
  • RON - RON RON
  • RSD - RSD дин.
  • RUB - RUB руб.
  • RWF - RWF FR
  • SDG - SDG SDG
  • SEK - SEK kr
  • SGD - SGD $
  • SOS - SOS Ssh
  • SYP - SYP ل.س.‏
  • THB - THB ฿
  • TND - TND د.ت.‏
  • TOP - TOP T$
  • TRY - TRY TL
  • TTD - TTD $
  • TWD - TWD NT$
  • TZS - TZS TSh
  • UAH - UAH ₴
  • UGX - UGX USh
  • UYU - UYU $
  • UZS - UZS UZS
  • VES - VES Bs.S.
  • VND - VND ₫
  • XAF - XAF FCFA
  • XOF - XOF CFA
  • YER - YER ر.ي.‏
  • ZAR - ZAR R
  • ZMW - ZMW ZK
date
required

The period start date of the report. Must be the first day of the month/year.

date
required

The period end date of the report. Must be the last day of the month/year.

string
enum
length ≥ 1
Defaults to month

Group the report by this value.

  • month - month
  • year - year
Allowed:
project__in
array of strings

The unique identifier of the project. Multiple values may be provided. The special value 'null' may be provided to filter for null values.

project__in
Response

Updated 7 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago