RArailz
FinancialStatement
Financial Statements

GET /cashflowStatements

Changed on

Gets a range of cashflow statements for a business.

Request

  • Base URL
    https://api.railz.ai
  • Auth
    HTTP bearer

Query parameters

accountingMethod'cash' | 'accrual'
businessNamestring required
Example:Railz
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
Example:100
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
        }
      ]
    }
  ]
}

Changes

  • 1383b9a47ac9Revision changes
    • info

      api tag FinancialStatement added

  • 5cdfae3fa1faRevision changes
    • breaking

      removed the enum value myob from the query request parameter serviceName

    • breaking

      removed the enum value oracleNetsuite from the query request parameter serviceName

    • breaking

      removed the enum value plaid from the query request parameter serviceName

    • breaking

      removed the enum value quickbooksDesktop from the query request parameter serviceName

    • breaking

      removed the enum value sageBusinessCloud from the query request parameter serviceName

    • breaking

      removed the enum value sageIntacct from the query request parameter serviceName

    • breaking

      removed the enum value shopify from the query request parameter serviceName

    • breaking

      removed the enum value square from the query request parameter serviceName

    • breaking

      removed the enum value wave from the query request parameter serviceName

    • warning

      added the new byod enum value to the /// response property for the response status

    • warning

      added the new byod enum value to the /// response property for the response status

    • warning

      added the new dynamics365Finance enum value to the /// response property for the response status

    • warning

      added the new dynamics365Finance enum value to the /// response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the /// response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the /// response property for the response status

    • warning

      added the new freshbooks enum value to the /// response property for the response status

    • warning

      added the new freshbooks enum value to the /// response property for the response status

    • warning

      added the new myob enum value to the /// response property for the response status

    • warning

      added the new myob enum value to the /// response property for the response status

    • warning

      added the new oracleNetsuite enum value to the /// response property for the response status

    • warning

      added the new oracleNetsuite enum value to the /// response property for the response status

    • warning

      added the new quickbooks enum value to the /// response property for the response status

    • warning

      added the new quickbooks enum value to the /// response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the /// response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the /// response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the /// response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the /// response property for the response status

    • warning

      added the new sageIntacct enum value to the /// response property for the response status

    • warning

      added the new sageIntacct enum value to the /// response property for the response status

    • warning

      added the new wave enum value to the /// response property for the response status

    • warning

      added the new wave enum value to the /// response property for the response status

    • warning

      added the new xero enum value to the /// response property for the response status

    • warning

      added the new xero enum value to the /// response property for the response status

    • warning

      added the new zohoBooks enum value to the /// response property for the response status

    • warning

      added the new zohoBooks enum value to the /// response property for the response status

    • info

      added the new enum value byod to the query request parameter serviceName

    • info

      added the new enum value zohoBooks to the query request parameter serviceName