# Kintsugi ## Docs - [4. Handling Refund Transactions](https://docs.trykintsugi.com/docs/api-guides/handling-refund-transactions.md): Create credit notes and refund records that properly track refunds for compliance and filing preparation - [1. Planning An Integration](https://docs.trykintsugi.com/docs/api-guides/planning-an-integration.md): Understand L1 (transaction sync) and L2 (tax engine) integration levels, and map endpoints to your workflow - [2. Product & Customer Records](https://docs.trykintsugi.com/docs/api-guides/product-customer-records.md): Create and manage product and customer records that power tax calculations and compliance tracking - [5. Sales Tax Calculations](https://docs.trykintsugi.com/docs/api-guides/sales-tax-calculations.md): Calculate accurate sales tax rates using Kintsugi's tax estimate endpoint in your checkout and billing flows - [3. Syncing Transaction Records](https://docs.trykintsugi.com/docs/api-guides/syncing-transaction-records.md): Sync completed sales transactions to Kintsugi for compliance tracking and nexus determination - [Creating and Managing API Keys](https://docs.trykintsugi.com/docs/creating-and-managing-api-keys.md): Step-by-Step Guide to Getting API Keys from the Kintsugi Platform - [Error Handling](https://docs.trykintsugi.com/docs/error-handling.md): Learn how to handle API errors and implement robust error handling - [File Upload](https://docs.trykintsugi.com/docs/file-upload.md): Upload sales transactions via CSV file - [Getting Started with Kintsugi](https://docs.trykintsugi.com/docs/getting-started.md): Get up and running with Kintsugi's automated sales tax solution in minutes - [Integrating Kintsugi's API](https://docs.trykintsugi.com/docs/guides/integrating-kintsugis-api.md): Design patterns and workflows for building Kintsugi tax API integrations - [Migrating from Avalara/TaxJar to Kintsugi](https://docs.trykintsugi.com/docs/guides/migrating-from-avalara-taxjar.md): Step-by-step guide to migrate your tax integration from Avalara or TaxJar to Kintsugi - [US Sales Tax for Developers](https://docs.trykintsugi.com/docs/guides/sales-tax-for-developers.md): Master sales tax compliance for e-commerce and SaaS applications - [Making Authenticated Request](https://docs.trykintsugi.com/docs/making-authenticate-request-using-api-key.md): Describes how to use API Key and x-organization-id to make an authorized request. - [Getting Started with Kintsugi MCP](https://docs.trykintsugi.com/docs/mcp/getting-started.md): Learn how AI assistants with Kintsugi MCP help you build better integrations faster - [Integration Guide](https://docs.trykintsugi.com/docs/mcp/integration.md): Set up Kintsugi MCP in your development environment to build integrations faster - [Use Cases and Examples](https://docs.trykintsugi.com/docs/mcp/use-cases.md): Real-world examples of developers using Kintsugi MCP to build integrations faster - [Java SDK](https://docs.trykintsugi.com/docs/sdks/java.md): Kintsugi Java SDK documentation and examples - [SDK Overview](https://docs.trykintsugi.com/docs/sdks/overview.md): Official Kintsugi SDKs for multiple programming languages - [PHP SDK](https://docs.trykintsugi.com/docs/sdks/php.md): Kintsugi PHP SDK documentation and examples - [Python SDK](https://docs.trykintsugi.com/docs/sdks/python.md): Kintsugi Python SDK documentation and examples - [SDK Quick Start](https://docs.trykintsugi.com/docs/sdks/quick-start.md): Get up and running with Kintsugi SDKs in minutes - [Ruby SDK](https://docs.trykintsugi.com/docs/sdks/ruby.md): Kintsugi Ruby SDK documentation and examples - [TypeScript SDK](https://docs.trykintsugi.com/docs/sdks/typescript.md): Kintsugi TypeScript SDK documentation and examples - [API Lab](https://docs.trykintsugi.com/recipes.md): Interactive API steps for learning and testing Kintsugi endpoints - [Calculate Tax for a Transaction](https://docs.trykintsugi.com/recipes/calculate-tax.md): Interactive playground to calculate tax using the Kintsugi API - [Creating Credit Notes](https://docs.trykintsugi.com/recipes/creating-credit-notes.md): Interactive playground for creating credit notes (refunds) for sale transactions - [Creating Transactions](https://docs.trykintsugi.com/recipes/creating-transactions.md): Interactive playground for creating transactions and retrieving transaction records - [Managing Customers](https://docs.trykintsugi.com/recipes/managing-customers.md): Interactive playground for creating customers and retrieving customer records - [Managing Nexus](https://docs.trykintsugi.com/recipes/managing-nexus.md): Interactive playground for creating physical nexus, registrations, and retrieving nexus information - [Create a Product](https://docs.trykintsugi.com/recipes/managing-products.md): Interactive playground to create products using the Kintsugi API - [Search](https://docs.trykintsugi.com/reference/api/address-validation/search.md): This API validates and enriches address information submitted by the user. It ensures that the address is standardized, accurate, and compliant with geographical and postal standards. The API also adds additional fields, such as county, when possible. - [Suggestions](https://docs.trykintsugi.com/reference/api/address-validation/suggestions.md): This API endpoint provides address suggestions based on partial input data. It helps users auto-complete and validate addresses efficiently by returning a list of suggested addresses that match the input criteria. This improves accuracy, increases speed, reduces errors, and streamlin… - [Create Customer](https://docs.trykintsugi.com/reference/api/customers/create-customer.md): The Create Customer API enables the creation of a new customer record with essential details like name, contact information, and address, along with optional metadata. - [Create Transaction By Customer Id](https://docs.trykintsugi.com/reference/api/customers/create-transaction-by-customer-id.md): Create a new transaction for a specific customer. - [Get Customer By External Id](https://docs.trykintsugi.com/reference/api/customers/get-customer-by-external-id.md): The Get Customer By External ID API retrieves the details of a single customer using their external identifier. This endpoint is useful for accessing customer data when only an external ID is available. - [Get Customer By Id](https://docs.trykintsugi.com/reference/api/customers/get-customer-by-id.md): The Get Customer By ID API retrieves the details of a single customer using their unique identifier. It returns customer-specific data, including contact information, address, name and metadata, etc. - [Get Customers](https://docs.trykintsugi.com/reference/api/customers/get-customers.md): The Get Customers API retrieves a paginated list of customers based on specified filters. This API allows searching, filtering by country and state, and sorting the results. - [Get Transactions By Customer Id](https://docs.trykintsugi.com/reference/api/customers/get-transactions-by-customer-id.md): Get a list of transactions for a customer by their unique ID. When pagination params are provided, this endpoint returns a paginated response. When omitted, it returns the legacy list response format (deprecated). - [Update Customer](https://docs.trykintsugi.com/reference/api/customers/update-customer.md): The Update Customer API allows you to modify an existing customer's information using their unique identifier, enabling updates to their details as needed. - [Create Exemption](https://docs.trykintsugi.com/reference/api/exemptions/create-exemption.md): The Create Exemption API allows you to create a new exemption record. This includes defining details such as exemption type, jurisdiction, Country, State, validity dates, etc. - [Get attachments for exemption](https://docs.trykintsugi.com/reference/api/exemptions/get-attachments-for-exemption.md) - [Get Exemption By Id](https://docs.trykintsugi.com/reference/api/exemptions/get-exemption-by-id.md): The Get Exemption By ID API retrieves a specific exemption record by its unique ID. This API is useful for retrieving detailed information about a particular exemption, including its associated customer, organisation id, status, etc. - [Get Exemptions](https://docs.trykintsugi.com/reference/api/exemptions/get-exemptions.md): Retrieve a list of exemptions based on filters. - [Upload Exemption Certificate](https://docs.trykintsugi.com/reference/api/exemptions/upload-exemption-certificate.md): The Upload Exemption Certificate API allows you to upload a file attachment (e.g., exemption certificate) for a specific exemption. This is primarily used to associate supporting documents with an exemption record to ensure compliance and facilitate verification. - [Get Filing By Id](https://docs.trykintsugi.com/reference/api/filings/get-filing-by-id.md): This API retrieves detailed information about a specific filing using its unique identifier (filing_id). - [Get Filings](https://docs.trykintsugi.com/reference/api/filings/get-filings.md): The Get Filings API retrieves a paginated list of filings based on filters such as dates, jurisdiction, Country, status, etc. This helps track and manage tax filings efficiently across multiple jurisdictions. - [Get Filings By Registration Id](https://docs.trykintsugi.com/reference/api/filings/get-filings-by-registration-id.md): The Get Filings By Registration ID API retrieves all filings associated with a specific registration ID. This allows users to query detailed filing information tied to a specific registration record. - [Create Physical Nexus](https://docs.trykintsugi.com/reference/api/nexus/create-physical-nexus.md): The Create Physical Nexus API allows you to create a new physical nexus by specifying its attributes, including the location, start date, end date, etc. - [Delete Physical Nexus](https://docs.trykintsugi.com/reference/api/nexus/delete-physical-nexus.md): The Delete Physical Nexus API allows you to remove an existing physical nexus by its unique ID. - [Get Nexus For Org](https://docs.trykintsugi.com/reference/api/nexus/get-nexus-for-org.md): Get a list of all nexuses for the organization. - [Get Physical Nexus](https://docs.trykintsugi.com/reference/api/nexus/get-physical-nexus.md): Retrieve a paginated list of physical nexuses for a specific organization. - [Update Physical Nexus](https://docs.trykintsugi.com/reference/api/nexus/update-physical-nexus.md): The Update Physical Nexus API allows you to modify the details of an existing physical nexus by its unique ID. - [Create Product](https://docs.trykintsugi.com/reference/api/products/create-product.md): The Create Product API allows users to manually create a new product in the system. This includes specifying product details such as category, subcategory, and tax exemption status, etc. You can retrieve supported categories and subcategories from [GET /products/categories endpoint](… - [Get Product By Id](https://docs.trykintsugi.com/reference/api/products/get-product-by-id.md): The Get Product By ID API retrieves detailed information about a single product by its unique ID. This API helps in viewing the specific details of a product, including its attributes, status, and categorization. - [Get Product Categories](https://docs.trykintsugi.com/reference/api/products/get-product-categories.md): The Get Product Categories API retrieves all product categories. This endpoint helps users understand and select the appropriate categories for their products. - [Get Products](https://docs.trykintsugi.com/reference/api/products/get-products.md): Retrieve a paginated list of products based on filters and search query. - [Update Product](https://docs.trykintsugi.com/reference/api/products/update-product.md): The Update Product API allows users to modify the details of an existing product identified by its unique product_id. You can retrieve supported categories and subcategories from [GET /products/categories endpoint](/reference/api/products/get-product-categories) - [Create Registration](https://docs.trykintsugi.com/reference/api/registrations/create-registration.md): The Create Registration API allows users to create a new registration for tracking and managing tax filings efficiently across multiple jurisdictions. - [Deregister Registration](https://docs.trykintsugi.com/reference/api/registrations/deregister-registration.md): Deregister an existing registration. - [Get Registration By Id](https://docs.trykintsugi.com/reference/api/registrations/get-registration-by-id.md): The Get Registration By ID API retrieves a single registration record based on its unique identifier. - [Get Registrations](https://docs.trykintsugi.com/reference/api/registrations/get-registrations.md): The Get Registrations API retrieves a paginated list of registrations. This API helps in tracking and managing registrations efficiently across multiple jurisdictions. - [Update Registration](https://docs.trykintsugi.com/reference/api/registrations/update-registration.md): The Update Registration API allows you to modify an existing registration using its unique registration_id. - [Estimate Tax](https://docs.trykintsugi.com/reference/api/tax-estimation/estimate-tax.md): The Estimate Tax API calculates the estimated tax for a specific transaction based on the provided details, including organization nexus, transaction details, customer details, and addresses. Optionally simulates nexus being met for tax calculation purposes. The `simulate_nexus_met` paramete… - [Create Credit Note By Transaction Id](https://docs.trykintsugi.com/reference/api/transactions/create-credit-note-by-transaction-id.md): Create a new credit note for a specific transaction. - [Create Transaction](https://docs.trykintsugi.com/reference/api/transactions/create-transaction.md): Create a transaction. Set `marketplace: true` for reseller or marketplace orders where tax was remitted externally; gross sales still count toward nexus, but tax liability is excluded. - [Get Transaction By External Id](https://docs.trykintsugi.com/reference/api/transactions/get-transaction-by-external-id.md): Retrieves a specific transaction based on its external ID. This allows users to fetch transaction details using an identifier from an external system. - [Get Transaction By Id](https://docs.trykintsugi.com/reference/api/transactions/get-transaction-by-id.md): The Get Transaction By Id API retrieves detailed information about a specific transaction by providing its unique transaction ID. - [Get Transactions](https://docs.trykintsugi.com/reference/api/transactions/get-transactions.md): The Get Transactions API retrieves a list of transactions with optional filtering, sorting, and pagination. - [Get Transactions By Filing Id](https://docs.trykintsugi.com/reference/api/transactions/get-transactions-by-filing-id.md): Retrieve transactions by filing ID. - [Update Credit Note By Transaction Id](https://docs.trykintsugi.com/reference/api/transactions/update-credit-note-by-transaction-id.md): Update an existing credit note for a specific transaction. - [Update Transaction](https://docs.trykintsugi.com/reference/api/transactions/update-transaction.md): Update a specific transaction by its ID. ## OpenAPI Specs - [openapi-partners-public](https://docs.trykintsugi.com/openapi-partners-public.json) - [openapi-customer](https://docs.trykintsugi.com/openapi-customer.json) - [openapi](https://docs.trykintsugi.com/api-reference/openapi.json) ## Optional - [FAQs](https://trykintsugi.com/faq) - [Support](https://trykintsugi.com/support) - [Blog](https://trykintsugi.com/blog)