TrialBalance
Trial Balances

GET /trialBalances

Changed on

Gets a trial balance report for a business.

Request

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

Query parameters

businessNamestring required
Example:Railz
reportFrequency'month' | 'quarter' | 'year' required
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'zohoBooks' | 'byod' required
accountingMethod'cash' | 'accrual'
startDatestring
endDatestring
section'Income' | 'Expenses' | 'Assets' | 'Liabilities' | 'Equity'
subSection'Income' | 'Cost of Goods Sold' | 'Operating Expenses' | 'Other Income' | 'Other Expenses' | 'Uncategorized Expenses' | 'Uncategorized Income' | 'Expenses' | 'Current Assets' | 'Non-Current Assets' | 'Current Liabilities' | 'Non-Current Liabilities' | 'Equity' | 'Other Assets' | 'Other Liabilities'
groupstring
subGroupstring
accountIdstring
subAccountIdstring
accountstring
debitnumber float
creditnumber float
ytdDebitnumber float
ytdCreditnumber 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": "Expenses",
          "subSection": "Operating Expenses",
          "group": "Expenses",
          "subGroup": "Utilities",
          "subAccountId": "203rc",
          "depth": 3,
          "account": "Utilities - Water",
          "subAccount": "Utilities",
          "subsidiaryRefs": [
            {
              "id": "1",
              "name": "Railz Financial"
            }
          ],
          "credit": 80,
          "accountId": "2s4n2",
          "fullyQualifiedName": "Expenses : Transportation : Car Mileage",
          "ytdCredit": 80,
          "currencyRef": {
            "id": "CAD",
            "name": "Canadian Dollar",
            "symbol": "USD,CAD"
          }
        }
      ]
    }
  ]
}

Changes

    • info

      api tag TrialBalance added

    • breaking

      the query request parameter section was restricted to a list of enum values

    • 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

    • breaking

      the response property ////// became optional for the status

    • breaking

      the response property ////// became optional for the status

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

    • warning

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

    • warning

      added the new Uncategorized Income enum value to the //// response property for the response status

    • warning

      added the new Uncategorized Income 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 optional query request parameter subSection

    • info

      added the new enum value Assets to the query request parameter section

    • info

      added the new enum value Equity to the query request parameter section

    • info

      added the new enum value Expenses to the query request parameter section

    • info

      added the new enum value Income to the query request parameter section

    • info

      added the new enum value Liabilities to the query request parameter section

    • 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

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      response property count deprecated

    • info

      response property count deprecated

    • info

      response property reports/items/data/items/ytdCredit deprecated

    • info

      response property reports/items/data/items/ytdCredit deprecated

    • info

      response property reports/items/data/items/ytdDebit deprecated

    • info

      response property reports/items/data/items/ytdDebit deprecated