latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Financial Statements

Gets a range of cashflow statements for a business.

get/cashflowStatements

Query parameters

accountingMethod'cash' | 'accrual'
businessNamestring required
reportFrequency'month' | 'quarter' | 'year' required
serviceName'freshbooks' | 'quickbooks' | 'xero' | 'dynamicsBusinessCentral' | 'zohoBooks' | 'byod' required
startDatestring
endDatestring
section'Operating Activities' | 'Financing Activities' | 'Investing Activities' | 'Cash'
subSection'Payments' | 'Adjustments' | 'Changes' | 'Proceeds' | 'Stock' | 'Intangibles' | 'Property Plant And Equipment' | 'Cash'
groupstring
subGroupstring
accountIdstring
subAccountIdstring
accountstring
valuenumber float
offsetnumber
limitnumber
orderBystring

Response

countnumber required

Example response

{
  "count": 1,
  "reports": [
    {
      "meta": {
        "reportId": "5fad8a342a88364234392fb5",
        "status": "success",
        "reportFrequency": "month",
        "currency": "USD",
        "createdAt": "2020-11-25T01:02:03Z",
        "updatedAt": "2020-11-30T01:02:03Z",
        "startDate": "2020-11-25T01:02:03Z",
        "endDate": "2020-12-25T01:02:03Z",
        "serviceName": "xero",
        "businessName": "Railz",
        "accountingMethod": "accrual"
      },
      "data": [
        {
          "section": "Operating Activities",
          "subSection": "Payments",
          "group": "Financing Activities",
          "subGroup": "Retained Earnings",
          "accountId": "3928",
          "subAccountId": "231",
          "account": "Financing Activities",
          "subAccount": "Retained Earnings",
          "value": 13000,
          "fullyQualifiedName": "Expenses : Transportation : Car Mileage",
          "depth": 3
        }
      ]
    }
  ]
}