Cash flow statement
curl --request GET \
--url https://app.equated.co/api/reports/cash-flow \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.equated.co/api/reports/cash-flow"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.equated.co/api/reports/cash-flow', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.equated.co/api/reports/cash-flow",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.equated.co/api/reports/cash-flow"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.equated.co/api/reports/cash-flow")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.equated.co/api/reports/cash-flow")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"report": {
"currency": "<string>",
"period": "month",
"buckets": [
{
"key": "<string>",
"label": "<string>",
"income": 123,
"expenses": 123
}
],
"breakdowns": [
{
"key": "<string>",
"categories": [
{
"accountId": 123,
"label": "<string>",
"type": "INCOME",
"amount": 123,
"emoji": "<string>",
"color": "<string>"
}
]
}
]
}
}Reports
Cash flow statement
Direct-method cash flow in base currency, bucketed by month, quarter, or year: per-bucket gross inflow/outflow across the organization’s bank-backed accounts, plus per-bucket category breakdowns attributing the cash to the non-cash leg of each moving entry. Includes DRAFT and POSTED bank-feed entries (cash moved before confirmation); bank-to-bank transfers are excluded.
GET
/
api
/
reports
/
cash-flow
Cash flow statement
curl --request GET \
--url https://app.equated.co/api/reports/cash-flow \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.equated.co/api/reports/cash-flow"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.equated.co/api/reports/cash-flow', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.equated.co/api/reports/cash-flow",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.equated.co/api/reports/cash-flow"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.equated.co/api/reports/cash-flow")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.equated.co/api/reports/cash-flow")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"report": {
"currency": "<string>",
"period": "month",
"buckets": [
{
"key": "<string>",
"label": "<string>",
"income": 123,
"expenses": 123
}
],
"breakdowns": [
{
"key": "<string>",
"categories": [
{
"accountId": 123,
"label": "<string>",
"type": "INCOME",
"amount": 123,
"emoji": "<string>",
"color": "<string>"
}
]
}
]
}
}Authorizations
API token issued from the Equated app under Settings → API Tokens.
Query Parameters
Number of trailing buckets to return. Defaults to 12 months / 8 quarters / 5 years by period.
Required range:
0 < x <= 24Legacy alias for buckets.
Required range:
0 < x <= 24Required string length:
3Available options:
month, quarter, year Comma-separated ledger account ids of bank-backed cash accounts to scope the report to. Defaults to all.
Response
200 - application/json
The bucketed cash-flow report
Show child attributes
Show child attributes