WAwafeq
Reports

Cash Flow

Changed on

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

get/reports/cash-flow/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/reports/cash-flow/
  • Auth
    API key in header Authorization

Query parameters

branch__instring[]

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

contact__instring[]

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

currency'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW'
  • AED - AED
  • SAR - SAR
  • USD - USD
  • EUR - EUR
  • CAD - CAD
  • AFN - AFN
  • ALL - ALL
  • AMD - AMD
  • ARS - ARS
  • AUD - AUD
  • AZN - AZN
  • BAM - BAM
  • BDT - BDT
  • BGN - BGN
  • BHD - BHD
  • BIF - BIF
  • BND - BND
  • BOB - BOB
  • BRL - BRL
  • BWP - BWP
  • BYN - BYN
  • BZD - BZD
  • CDF - CDF
  • CHF - CHF
  • CLP - CLP
  • CNY - CNY
  • COP - COP
  • CRC - CRC
  • CVE - CVE
  • CZK - CZK
  • DJF - DJF
  • DKK - DKK
  • DOP - DOP
  • DZD - DZD
  • EGP - EGP
  • ERN - ERN
  • ETB - ETB
  • GBP - GBP
  • GEL - GEL
  • GHS - GHS
  • GNF - GNF
  • GTQ - GTQ
  • HKD - HKD
  • HNL - HNL
  • HRK - HRK
  • HUF - HUF
  • IDR - IDR
  • ILS - ILS
  • INR - INR
  • IQD - IQD
  • IRR - IRR
  • ISK - ISK
  • JMD - JMD
  • JOD - JOD
  • JPY - JPY
  • KES - KES
  • KHR - KHR
  • KMF - KMF
  • KRW - KRW
  • KWD - KWD
  • KZT - KZT
  • LBP - LBP
  • LKR - LKR
  • LYD - LYD
  • MAD - MAD
  • MDL - MDL
  • MGA - MGA
  • MKD - MKD
  • MMK - MMK
  • MOP - MOP
  • MUR - MUR
  • MXN - MXN
  • MYR - MYR
  • MZN - MZN
  • NAD - NAD
  • NGN - NGN
  • NIO - NIO
  • NOK - NOK
  • NPR - NPR
  • NZD - NZD
  • OMR - OMR
  • PAB - PAB
  • PEN - PEN
  • PHP - PHP
  • PKR - PKR
  • PLN - PLN
  • PYG - PYG
  • QAR - QAR
  • RON - RON
  • RSD - RSD
  • RUB - RUB
  • RWF - RWF
  • SDG - SDG
  • SEK - SEK
  • SGD - SGD
  • SOS - SOS
  • SYP - SYP
  • THB - THB
  • TND - TND
  • TOP - TOP
  • TRY - TRY
  • TTD - TTD
  • TWD - TWD
  • TZS - TZS
  • UAH - UAH
  • UGX - UGX
  • UYU - UYU
  • UZS - UZS
  • VES - VES
  • VND - VND
  • XAF - XAF
  • XOF - XOF
  • YER - YER
  • ZAR - ZAR
  • ZMW - ZMW

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_afterstring date required

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

date_beforestring date required

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

group_by'month' | 'year'
  • month - month
  • year - year

Group the report by this value.

  • month - month
  • year - year
project__instring[]

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

Response

Changes

  • b8f5e10134b4Revision changes
    • warning

      deleted the query request parameter cost_center__in

    • info

      added to the / response property allOf list for the response status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the /// response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      removed from the /// response property allOf list for the response status