Skip to main content
GET
/
ca
/
api
/
get_cash_flow
Get Cash Flow
curl --request GET \
  --url https://api.meetcampfire.com/ca/api/get_cash_flow \
  --header 'Authorization: <api-key>'
{
  "cash_flow": [
    {
      "account_id": "12088",
      "account_name": "Accounts Receivable",
      "account_number": "120000",
      "hierarchy": [
        "OPERATING",
        "ADJUSTMENTS_TO_NET_INCOME",
        "12088"
      ],
      "transaction_activity": {
        "2023-10-01": null,
        "2023-11-01": -1400
      }
    },
    {
      "account_id": "12235",
      "account_name": "Expense Card ****3293",
      "account_number": "220012",
      "hierarchy": [
        "OPERATING",
        "ADJUSTMENTS_TO_NET_INCOME",
        "12235"
      ],
      "transaction_activity": {
        "2023-10-01": 4.639999999999972,
        "2023-11-01": -104.85999999999997
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Query Parameters

​
cadence
enum<string>
default:monthly
Available options:
daily,
monthly,
quarterly,
weekly,
yearly
​
end_date
string<date>

Latest date (inclusive) for which to retrieve data. Defaults to end of current month

​
entity
integer

Entity ID(s) to scope the report. Can be repeated (?entity=1&entity=2) or JSON array

​
entity_rollup
boolean
default:false

If true, includes all data of children entities in consolidation

​
group_by
string
​
start_date
string<date>

Earliest date (inclusive) for which to retrieve data. Defaults to six months ago

Response

200 - application/json
​
cash_flow
object[]
​
start_date
string<date>
​
end_date
string<date>
​
cadence
string