FinancialStatement
Financial Statements

GET /balanceSheets

Changed on

Gets a range of balance sheets 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' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'zohoBooks' | 'byod' required
startDatestring
endDatestring
section'Assets' | 'Liabilities' | 'Equity'
subSection'Current Assets' | 'Non-Current Assets' | 'Current Liabilities' | 'Non-Current Liabilities' | 'Equity' | 'Other Assets' | 'Other Liabilities' | 'Expenses'
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": "Assets",
          "subSection": "Current Assets",
          "fullyQualifiedName": "Expenses : Transportation : Car Mileage",
          "depth": 3,
          "group": "Cash And Cash Equivalents",
          "subGroup": "Utilities",
          "accountId": "3928",
          "subAccountId": "231",
          "account": "Checking",
          "subAccount": "Checking",
          "value": 990
        }
      ]
    }
  ]
}

Changes

    • info

      api tag FinancialStatement added

    • breaking

      removed the enum value myob from the query request parameter serviceName

    • breaking

      removed the enum value plaid 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 Expenses enum value to the //// response property for the response status

    • warning

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

    • warning

      added the new Other Assets enum value to the //// response property for the response status

    • warning

      added the new Other Assets enum value to the //// response property for the response status

    • warning

      added the new Other Liabilities enum value to the //// response property for the response status

    • warning

      added the new Other Liabilities 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 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 Expenses to the query request parameter subSection

    • info

      added the new enum value Other Assets to the query request parameter subSection

    • info

      added the new enum value Other Liabilities to the query request parameter subSection

    • 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