latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Trial Balances

Gets a trial balance report for a business.

get/trialBalances

Query parameters

businessNamestring required
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
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"
          }
        }
      ]
    }
  ]
}