SolariumSolariumDocs
Browse The Docs

Docs/API Reference/Reports

POST

GST/HST Return

Canadian organizations. GST/HST return summary for a filing period: tax collected on sales, input tax credits (ITCs) claimable on expenses, ITC adjustments (e.g. the 50% meals & entertainment restriction), and the net amount owing or refundable. The province, rate, and filing frequency/deadline are derived from the organization's tax configuration. Each collected/ITC line carries its accountId and revenueAccountIds lists the revenue accounts, so accountLines can list the entries behind any line. Before filing, check unbookedCount / unbookedTotal (transactions in the period still in review — not counted yet) and receiptsMissingTaxCount (receipts in the period with no tax read). Use filingPeriod to get the period dates.

Parameters

organizationIdUUID!required

Organization ID

startDateDate!required

Start of the filing period (YYYY-MM-DD)

endDateDate!required

End of the filing period (YYYY-MM-DD)

Request
query {
  gstHstReturn(
    organizationId: "a1b2c3d4-..."
    startDate: "2026-01-01"
    endDate: "2026-03-31"
  ) {
    province
    provinceName
    taxRate
    filingFrequency
    filingDeadline
    filingDeadlineDate
    collectedLines { accountId accountName amount }
    itcLines { accountId accountName amount }
    itcAdjustmentLines { accountName amount }
    revenueAccountIds
    totalRevenue
    totalCollected
    totalItcs
    totalItcAdjustment
    netClaimableItcs
    netOwing
    isRefund
    hasTaxAccounts
    unbookedCount
    unbookedTotal
    receiptsMissingTaxCount
  }
}
Response
{
  "data": {
    "gstHstReturn": {
      "province": "ON",
      "provinceName": "Ontario",
      "taxRate": "13%",
      "filingFrequency": "quarterly",
      "filingDeadline": "2026-04-30",
      "filingDeadlineDate": "2026-04-30",
      "collectedLines": [
        { "accountId": "5c1e...", "accountName": "HST Payable", "amount": "10985.00" }
      ],
      "itcLines": [
        { "accountId": "9d2a...", "accountName": "GST/HST Receivable", "amount": "4212.55" }
      ],
      "revenueAccountIds": ["7f3e..."],
      "unbookedCount": 3,
      "unbookedTotal": "412.80",
      "receiptsMissingTaxCount": 2,
      "itcAdjustmentLines": [
        { "accountName": "Meals & Entertainment (50%)", "amount": "-96.20" }
      ],
      "totalRevenue": "84500.00",
      "totalCollected": "10985.00",
      "totalItcs": "4212.55",
      "totalItcAdjustment": "-96.20",
      "netClaimableItcs": "4116.35",
      "netOwing": "6868.65",
      "isRefund": false,
      "hasTaxAccounts": true
    }
  }
}