KintsugiKintsugi
API reference / Dashboard headline statistics

Dashboard headline statistics

GET/dashboard/stats

Sales, transaction count, tax owed, and tax paid for one organization. Amounts use the reporting currency. Leave out countryCode to count every country. stateCode works alone.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-10-06.

Organization-Idstring

Target organization id (Organization-Id selector).

Connection-Idstring

Target connection id; resolves to its organization.

Entity-Idstring

Platform entity id; resolves to a connection's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Query

Every query parameter below is optional. Combine as many as you need and append them to the endpoint as a query string. The example shows a few to get you started.

/dashboard/stats?countryCode=<countryCode>&stateCode=<stateCode>&startDate=<startDate>
countryCodestring

ISO 3166-1 alpha-2 country code, case-insensitive. Omit for all countries.

stateCodestring

State or province code. Works without countryCode.

startDatestring

Start of the date window (YYYY-MM-DD). A transaction counts when its date is in the window. A filing counts only when its whole period is in the window.

endDatestring

End of the date window (YYYY-MM-DD). A transaction counts when its date is in the window. A filing counts only when its whole period is in the window.

Response

totalSalesstringRequired

Sales total in currency, each transaction converted at its transaction-date rate.

totalTransactionsintegerRequired

Number of transactions in scope. Includes transactions excluded from the money totals because no exchange rate was available.

totalTaxAmountImportedstringRequired

Tax amount imported from the source system, in currency.

totalTaxAmountCalculatedstringRequired

Tax amount calculated by Kintsugi, in currency.

outstandingTotalLiabilitystringRequired

Remittance still owed on filings that are unfiled, in progress, or submitted and awaiting payment, in currency. Excludes nexus exposure that has no filing.

totalTaxRemittedstringRequired

Tax remitted on filed filings, in currency.

currencyPublicCurrencyEnumRequired

ISO-4217 reporting currency every amount on this object is in.

Available options:AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGGPGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSIMPINRIQDIRRISKJEPJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSPLSRDSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTVDTWDTZSUAHUGXUSDUYUUZSVEFVNDVUVWSTXAFXCDXDRXOFXPFYERZARZMWZWD
excludedTransactionCountintegerRequired

Transactions left out of the money totals because no exchange rate was available. Counted per currency per day.

excludedCurrenciesPublicCurrencyEnum[]Required

Transaction currencies with no exchange rate on at least one day. Their amounts are not in the totals. Transactions with no currency are counted in excludedTransactionCount but not listed here.

Available options:AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGGPGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSIMPINRIQDIRRISKJEPJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSPLSRDSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTVDTWDTZSUAHUGXUSDUYUUZSVEFVNDVUVWSTXAFXCDXDRXOFXPFYERZARZMWZWD
excludedFilingCountintegerRequired

Filings left out of the liability and remitted totals because no exchange rate was available. Counted per currency per day.

excludedFilingCurrenciesPublicCurrencyEnum[]Required

Filing currencies with no exchange rate on at least one day. Their amounts are not in the totals.

Available options:AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGGPGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSIMPINRIQDIRRISKJEPJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSPLSRDSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTVDTWDTZSUAHUGXUSDUYUUZSVEFVNDVUVWSTXAFXCDXDRXOFXPFYERZARZMWZWD
200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

404

The requested resource was not found.

422

The request failed validation.

cURL
GET /dashboard/stats?countryCode={countryCode}&stateCode={stateCode}&startDate={startDate}
-H "Api-Key: ***"
-H "Api-Version: 2026-10-06"
Example request
https://api.trykintsugi.com/dashboard/stats?countryCode={countryCode}&stateCode={stateCode}&startDate={startDate}
Response
{
"totalSales": "10.00",
"totalTransactions": 100,
"totalTaxAmountImported": "10.00",
"totalTaxAmountCalculated": "10.00",
"outstandingTotalLiability": "10.00",
"totalTaxRemitted": "10.00",
"currency": "AED",
"excludedTransactionCount": 1,
"excludedCurrencies": [
"AED"
],
"excludedFilingCount": 1,
"excludedFilingCurrencies": [
"AED"
]
}
Dashboard headline statistics (2026-10-06) | Kintsugi API Reference