@kintsugi-tax/tax-platform-sdk
v0.10.0
Published
Developer-friendly & type-safe Typescript SDK specifically catered to leverage Kintsugi's tax API.
Readme
Kintsugi Tax
Developer-friendly & type-safe Typescript SDK specifically catered to leverage Kintsugi's tax API.
Summary
Table of Contents
SDK Installation
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
NPM
npm add @kintsugi-tax/tax-platform-sdkPNPM
pnpm add @kintsugi-tax/tax-platform-sdkBun
bun add @kintsugi-tax/tax-platform-sdkYarn
yarn add @kintsugi-tax/tax-platform-sdk[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.
Model Context Protocol (MCP) Server
This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.
Node.js v20 or greater is required to run the MCP server from npm.
Add the following server definition to your claude_desktop_config.json file:
{
"mcpServers": {
"SDK": {
"command": "npx",
"args": [
"-y", "--package", "@kintsugi-tax/tax-platform-sdk",
"--",
"mcp", "start",
"--api-key-header", "...",
"--custom-header", "..."
]
}
}
}Create a .cursor/mcp.json file in your project root with the following content:
{
"mcpServers": {
"SDK": {
"command": "npx",
"args": [
"-y", "--package", "@kintsugi-tax/tax-platform-sdk",
"--",
"mcp", "start",
"--api-key-header", "...",
"--custom-header", "..."
]
}
}
}You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
curl -L -o mcp-server \
https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-serverIf the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".
{
"mcpServers": {
"Todos": {
"command": "./DOWNLOAD/PATH/mcp-server",
"args": [
"start"
]
}
}
}For a full list of server arguments, run:
npx -y --package @kintsugi-tax/tax-platform-sdk -- mcp start --helpRequirements
For supported JavaScript runtimes, please consult RUNTIMES.md.
SDK Example Usage
Example
import { SDK } from "@kintsugi-tax/tax-platform-sdk";
const sdk = new SDK();
async function run() {
const result = await sdk.addressValidation.search({
apiKeyHeader: "<YOUR_API_KEY_HERE>",
}, {
phone: "555-123-4567",
street1: "1600 Amphitheatre Parkway",
street2: "Building 40",
city: "Mountain View",
county: "Santa Clara",
state: "CA",
postalCode: "94043",
country: "US",
fullAddress: "1600 Amphitheatre Parkway, Mountain View, CA 94043",
});
console.log(result);
}
run();
Authentication
Per-Client Security Schemes
This SDK supports the following security schemes globally:
| Name | Type | Scheme |
| -------------- | ------ | ------- |
| apiKeyHeader | apiKey | API key |
| customHeader | apiKey | API key |
You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
import { SDK } from "@kintsugi-tax/tax-platform-sdk";
const sdk = new SDK({
security: {
apiKeyHeader: "<YOUR_API_KEY_HERE>",
customHeader: "<YOUR_API_KEY_HERE>",
},
});
async function run() {
const result = await sdk.addressValidation.suggest({
line1: "1600 Amphitheatre Parkway",
line2: "",
line3: "",
city: "Mountain View",
state: "CA",
postalCode: "94043",
id: 215,
county: "",
fullAddress: "1600 Amphitheatre Parkway, Mountain View, CA 94043",
});
console.log(result);
}
run();
Per-Operation Security Schemes
Some operations in this SDK require the security scheme to be specified at the request level. For example:
import { SDK } from "@kintsugi-tax/tax-platform-sdk";
const sdk = new SDK();
async function run() {
const result = await sdk.addressValidation.search({
apiKeyHeader: "<YOUR_API_KEY_HERE>",
}, {
phone: "555-123-4567",
street1: "1600 Amphitheatre Parkway",
street2: "Building 40",
city: "Mountain View",
county: "Santa Clara",
state: "CA",
postalCode: "94043",
country: "US",
fullAddress: "1600 Amphitheatre Parkway, Mountain View, CA 94043",
});
console.log(result);
}
run();
Available Resources and Operations
AddressValidation
Customers
- list - Get Customers
- create - Create Customer
- get - Get Customer By Id
- update - Update Customer
- getByExternalId - Get Customer By External Id
- getTransactions - Get Transactions By Customer Id
- createTransaction - Create Transaction By Customer Id
Exemptions
- list - Get Exemptions
- create - Create Exemption
- get - Get Exemption By Id
- uploadCertificate - Upload Exemption Certificate
- getAttachments - Get Attachments For Exemption
Filings
- list - Get Filings
- get - Get Filing By Id
- getByRegistrationId - Get Filings By Registration Id
Nexus
- listPhysical - Get Physical Nexus
- createPhysical - Create Physical Nexus
- updatePhysical - Update Physical Nexus
- deletePhysical - Delete Physical Nexus
- list - Get Nexus For Org
Products
- getProductsV1ProductsGet - Get Products
- createProductV1ProductsPost - Create Product
- getProductCategoriesV1ProductsCategoriesGet - Get Product Categories
- get - Get Product By Id
- update - Update Product
Registrations
- get - Get Registrations
- create - Create Registration
- getById - Get Registration By Id
- update - Update Registration
- deregister - Deregister Registration
TaxEstimation
- estimate - Estimate Tax
Transactions
- get - Get Transactions
- create - Create Transaction
- getByExternalId - Get Transaction By External Id
- update - Update Transaction
- getById - Get Transaction By Id
- getByFilingId - Get Transactions By Filing Id
- createCreditNote - Create Credit Note By Transaction Id
- updateCreditNote - Update Credit Note By Transaction Id
Standalone functions
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
addressValidationSearch- SearchaddressValidationSuggest- SuggestionscustomersCreate- Create CustomercustomersCreateTransaction- Create Transaction By Customer IdcustomersGet- Get Customer By IdcustomersGetByExternalId- Get Customer By External IdcustomersGetTransactions- Get Transactions By Customer IdcustomersList- Get CustomerscustomersUpdate- Update CustomerexemptionsCreate- Create ExemptionexemptionsGet- Get Exemption By IdexemptionsGetAttachments- Get Attachments For ExemptionexemptionsList- Get ExemptionsexemptionsUploadCertificate- Upload Exemption CertificatefilingsGet- Get Filing By IdfilingsGetByRegistrationId- Get Filings By Registration IdfilingsList- Get FilingsnexusCreatePhysical- Create Physical NexusnexusDeletePhysical- Delete Physical NexusnexusList- Get Nexus For OrgnexusListPhysical- Get Physical NexusnexusUpdatePhysical- Update Physical NexusproductsCreateProductV1ProductsPost- Create ProductproductsGet- Get Product By IdproductsGetProductCategoriesV1ProductsCategoriesGet- Get Product CategoriesproductsGetProductsV1ProductsGet- Get ProductsproductsUpdate- Update ProductregistrationsCreate- Create RegistrationregistrationsDeregister- Deregister RegistrationregistrationsGet- Get RegistrationsregistrationsGetById- Get Registration By IdregistrationsUpdate- Update RegistrationtaxEstimationEstimate- Estimate TaxtransactionsCreate- Create TransactiontransactionsCreateCreditNote- Create Credit Note By Transaction IdtransactionsGet- Get TransactionstransactionsGetByExternalId- Get Transaction By External IdtransactionsGetByFilingId- Get Transactions By Filing IdtransactionsGetById- Get Transaction By IdtransactionsUpdate- Update TransactiontransactionsUpdateCreditNote- Update Credit Note By Transaction Id
File uploads
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
[!TIP]
Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
- Node.js v20+: Since v20, Node.js comes with a native
openAsBlobfunction innode:fs.- Bun: The native
Bun.filefunction produces a file handle that can be used for streaming file uploads.- Browsers: All supported browsers return an instance to a
Filewhen reading the value from an<input type="file">element.- Node.js v18: A file stream can be created using the
fileFromhelper fromfetch-blob/from.js.
import { SDK } from "@kintsugi-tax/tax-platform-sdk";
import { openAsBlob } from "node:fs";
const sdk = new SDK({
security: {
apiKeyHeader: "<YOUR_API_KEY_HERE>",
customHeader: "<YOUR_API_KEY_HERE>",
},
});
async function run() {
const result = await sdk.exemptions.uploadCertificate({
exemptionId: "<id>",
bodyUploadExemptionCertificateV1ExemptionsExemptionIdAttachmentsPost: {
file: await openAsBlob("example.file"),
},
});
console.log(result);
}
run();
Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { SDK } from "@kintsugi-tax/tax-platform-sdk";
const sdk = new SDK();
async function run() {
const result = await sdk.addressValidation.search({
apiKeyHeader: "<YOUR_API_KEY_HERE>",
}, {
phone: "555-123-4567",
street1: "1600 Amphitheatre Parkway",
street2: "Building 40",
city: "Mountain View",
county: "Santa Clara",
state: "CA",
postalCode: "94043",
country: "US",
fullAddress: "1600 Amphitheatre Parkway, Mountain View, CA 94043",
}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
console.log(result);
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { SDK } from "@kintsugi-tax/tax-platform-sdk";
const sdk = new SDK({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
async function run() {
const result = await sdk.addressValidation.search({
apiKeyHeader: "<YOUR_API_KEY_HERE>",
}, {
phone: "555-123-4567",
street1: "1600 Amphitheatre Parkway",
street2: "Building 40",
city: "Mountain View",
county: "Santa Clara",
state: "CA",
postalCode: "94043",
country: "US",
fullAddress: "1600 Amphitheatre Parkway, Mountain View, CA 94043",
});
console.log(result);
}
run();
Error Handling
SDKError is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
| error.message | string | Error message |
| error.statusCode | number | HTTP response status code eg 404 |
| error.headers | Headers | HTTP response headers |
| error.body | string | HTTP body. Can be empty string if no body is returned. |
| error.rawResponse | Response | Raw HTTP response |
| error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |
Example
import { SDK } from "@kintsugi-tax/tax-platform-sdk";
import * as errors from "@kintsugi-tax/tax-platform-sdk/models/errors";
const sdk = new SDK();
async function run() {
try {
const result = await sdk.addressValidation.search({
apiKeyHeader: "<YOUR_API_KEY_HERE>",
}, {
phone: "555-123-4567",
street1: "1600 Amphitheatre Parkway",
street2: "Building 40",
city: "Mountain View",
county: "Santa Clara",
state: "CA",
postalCode: "94043",
country: "US",
fullAddress: "1600 Amphitheatre Parkway, Mountain View, CA 94043",
});
console.log(result);
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.SDKError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);
// Depending on the method different errors may be thrown
if (error instanceof errors.ErrorResponse) {
console.log(error.data$.detail); // string
}
}
}
}
run();
Error Classes
Primary errors:
SDKError: The base class for HTTP error responses.
Network errors:
ConnectionError: HTTP client was unable to make a request to a server.RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.RequestAbortedError: HTTP request was aborted by the client.InvalidRequestError: Any input used to create a request is invalid.UnexpectedClientError: Unrecognised or unexpected error.
Inherit from SDKError:
HTTPValidationError: Validation Error. Status code422. Applicable to 8 of 41 methods.*BackendSrcExemptionsResponsesValidationErrorResponse: Validation issues, such as missing required fields or invalid field values. Status code422. Applicable to 5 of 41 methods.*BackendSrcProductsResponsesValidationErrorResponse: Validation error. Status code422. Applicable to 5 of 41 methods.*BackendSrcRegistrationsResponsesValidationErrorResponse: Validation error. Status code422. Applicable to 5 of 41 methods.*BackendSrcTransactionsResponsesValidationErrorResponse: Status code422. Applicable to 5 of 41 methods.*BackendSrcNexusResponsesValidationErrorResponse: Validation error. Status code422. Applicable to 4 of 41 methods.*BackendSrcCustomersResponsesValidationErrorResponse: Query parameters failed validation, such as an out-of-range page number. Status code422. Applicable to 3 of 41 methods.*BackendSrcFilingsResponsesValidationErrorResponse: Validation error. Status code422. Applicable to 3 of 41 methods.*BackendSrcAddressValidationResponsesValidationErrorResponse: Validation error - Address fields failed validation or are incomplete. Status code422. Applicable to 2 of 41 methods.*BackendSrcTaxEstimationResponsesValidationErrorResponse: Validation Error. Status code422. Applicable to 1 of 41 methods.*ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. Seeerror.rawValuefor the raw value anderror.pretty()for a nicely formatted multi-line string.
* Check the method documentation to see if the error is applicable.
Server Selection
Override Server URL Per-Client
The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:
import { SDK } from "@kintsugi-tax/tax-platform-sdk";
const sdk = new SDK({
serverURL: "https://api.trykintsugi.com",
});
async function run() {
const result = await sdk.addressValidation.search({
apiKeyHeader: "<YOUR_API_KEY_HERE>",
}, {
phone: "555-123-4567",
street1: "1600 Amphitheatre Parkway",
street2: "Building 40",
city: "Mountain View",
county: "Santa Clara",
state: "CA",
postalCode: "94043",
country: "US",
fullAddress: "1600 Amphitheatre Parkway, Mountain View, CA 94043",
});
console.log(result);
}
run();
Custom HTTP Client
The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to:
- route requests through a proxy server using undici's ProxyAgent
- use the
"beforeRequest"hook to add a custom header and a timeout to requests - use the
"requestError"hook to log errors
import { SDK } from "@kintsugi-tax/tax-platform-sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@kintsugi-tax/tax-platform-sdk/lib/http";
const dispatcher = new ProxyAgent("http://proxy.example.com:8080");
const httpClient = new HTTPClient({
// 'fetcher' takes a function that has the same signature as native 'fetch'.
fetcher: (input, init) =>
// 'dispatcher' is specific to undici and not part of the standard Fetch API.
fetch(input, { ...init, dispatcher } as RequestInit),
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new SDK({ httpClient: httpClient });Debugging
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console's interface as an SDK option.
[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { SDK } from "@kintsugi-tax/tax-platform-sdk";
const sdk = new SDK({ debugLogger: console });Development
Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
