Skip to main content
GET
/
api
/
reports
/
sales-tax-liability-summary
Get sales tax liability summary report
curl --request GET \
  --url https://api.example.com/api/reports/sales-tax-liability-summary \
  --header 'Authorization: <authorization>' \
  --header 'accept: <accept>' \
  --header 'organization-id: <organization-id>'
{
  "query": {
    "fromDate": "<string>",
    "toDate": "<string>",
    "numberFormat": {
      "precision": 2,
      "divideOn1000": false,
      "showZero": true,
      "formatMoney": "total",
      "negativeFormat": "parentheses"
    }
  },
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "rate": 123,
      "taxableAmount": {
        "amount": 123,
        "formattedAmount": "<string>",
        "currencyCode": "<string>",
        "date": {}
      },
      "taxAmount": {
        "amount": 123,
        "formattedAmount": "<string>",
        "currencyCode": "<string>",
        "date": {}
      },
      "totalSales": {
        "amount": 123,
        "formattedAmount": "<string>",
        "currencyCode": "<string>",
        "date": {}
      }
    }
  ],
  "meta": {
    "organizationName": "<string>",
    "baseCurrency": "<string>",
    "dateFormat": "<string>",
    "isCostComputeRunning": true,
    "sheetName": "<string>",
    "formattedFromDate": "<string>",
    "formattedToDate": "<string>",
    "formattedDateRange": "<string>"
  }
}

Headers

Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

accept
string
required

Query Parameters

fromDate
string<date-time>
required

Start date for the sales tax liability summary

Example:

"2024-01-01"

toDate
string<date-time>
required

End date for the sales tax liability summary

Example:

"2024-01-31"

basis
enum<string>
required

Accounting basis for the summary

Available options:
cash,
accrual
Example:

"accrual"

Response

Sales tax liability summary report

query
object
required

Query parameters used to generate the report

data
object[]
required

Tax rate summaries

meta
object
required

Report metadata