Cash Flow Report

Available Filters

Filter Type	Name	Field	Description
Between	`start_date`	`date`	Starting date for report
Between	`end_date`	`date`	Ending date for report
Equals	`currency_code`	`string`	Currency for report

Get Cash Flow Report

#Request

curl --location --request GET 'https://api.freshbooks.com/accounting/businesses/{business_uuid}/reports/cash_flow' 
--header 'Authorization: Bearer  <SET BEARER TOKEN>'

#Response

{
  "response": {
    "result": {
      "cash_flow": {
        "company_name": "",
        "download_token": "",
        "start_date": "2023-01-01",
        "end_date": "2023-12-31",
        "currency_code": "USD",
        "activities": [
          {
            "category": "operating",
            "details": [
              {
                "name": "Sales",
                "accounts": [
                  {
                    "name": "Current Asset",
                    "sub_accounts": [
                      {
                        "name": "Customer Deposits",
                        "categoryid": null,
                        "sub_accountid": null,
                        "total": {
                          "amount": "10.00",
                          "code": "USD"
                        }
                      }
                    ],
                    "total": {
                      "amount": "10.00",
                      "code": "USD"
                    }
                  },
                  {
                    "name": "Customer Credit",
                    "sub_accounts": [
                      {
                        "name": "Customer Credit",
                        "categoryid": null,
                        "sub_accountid": null,
                        "total": {
                          "amount": "175.00",
                          "code": "USD"
                        }
                      }
                    ],
                    "total": {
                      "amount": "175.00",
                      "code": "USD"
                    }
                  },
                  {
                    "name": "Revenue",
                    "sub_accounts": [
                      {
                        "name": "Sales",
                        "categoryid": null,
                        "sub_accountid": null,
                        "total": {
                          "amount": "766.67",
                          "code": "USD"
                        }
                      }
                    ],
                    "total": {
                      "amount": "766.67",
                      "code": "USD"
                    }
                  }
                ],
                "total": {
                  "amount": "951.67",
                  "code": "USD"
                }
              },
              < ... more account and sub-accounts data ... >
            ],
            "total": {
              "amount": "1025.00",
              "code": "USD"
            }
          },
          < ... more category activities data ... >
        ],
        "summary": {
          "ending_balance": {
            "amount": "1025.00",
            "code": "USD"
          },
          "gross_cash_inflow": {
            "amount": "1355.00",
            "code": "USD"
          },
          "gross_cash_outflow": {
            "amount": "-430.00",
            "code": "USD"
          },
          "net_cash_change": {
            "amount": "925.00",
            "code": "USD"
          },
          "starting_balance": {
            "amount": "100.00",
            "code": "USD"
          }
        }
      }
    }
  }
}

Example Cash Flow with report filters

#Request

curl --location --request GET 'https://api.freshbooks.com/accounting/businesses/{business_uuid}/reports/cash_flow?start_date=2023-02-01&end_date=2023-02-28&currency_code=CAD' 
--header 'Authorization: Bearer  <SET BEARER TOKEN>'