> ## Documentation Index > Fetch the complete documentation index at: https://docs.trykintsugi.com/llms.txt > Use this file to discover all available pages before exploring further. # Estimate Tax > 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` parameter is deprecated and will be removed in future releases. ## OpenAPI ````yaml post /v1/tax/estimate openapi: 3.0.0 info: title: Tax Platform version: 1.0.0 servers: - url: https://api.trykintsugi.com description: Production API server URL security: [] paths: /v1/tax/estimate: post: tags: - Tax Estimation summary: Estimate Tax description: |- 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` parameter is deprecated and will be removed in future releases. operationId: estimate_tax_v1_tax_estimate_post parameters: - name: simulate_nexus_met in: query required: false schema: type: boolean description: >- **Deprecated:** Use `simulate_active_registration` in the request body instead. deprecated: true title: Simulate Nexus Met description: >- **Deprecated:** Use `simulate_active_registration` in the request body instead. deprecated: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TransactionEstimatePublicRequest' example: date: '2025-01-23T13:01:29.949Z' external_id: txn_12345 currency: USD addresses: - type: SHIP_TO street_1: 789 Pine St city: Austin state: TX postal_code: '78701' country: US transaction_items: - external_id: item_A date: '2024-10-28T10:00:00Z' external_product_id: prod_abc quantity: 2 amount: 100 - external_id: item_B date: '2024-10-28T10:00:00Z' external_product_id: prod_xyz quantity: 1 amount: 75.5 responses: '200': description: Successfully retrieved data content: application/json: schema: $ref: '#/components/schemas/Page_TransactionEstimateResponse_' example: date: '2025-01-25T13:45:00Z' external_id: '123456' currency: USD description: Test transaction for tax calculation source: OTHER marketplace: false addresses: - type: SHIP_TO street_1: 456 Elm Street street_2: Suite 202 city: Springfield county: Greene state: MO postal_code: '65806' country: US status: VERIFIED transaction_items: - external_id: ITEM123 date: '2025-01-25T14:00:00Z' description: A sample product external_product_id: PROD001 product_name: Sample Product product_description: This is a sample product for testing product_source: OTHER product_subcategory: GENERAL_CLOTHING product_category: PHYSICAL quantity: '2' amount: '250.00' exempt: false tax_amount: '20.00' taxable_amount: '500.00' tax_rate: '0.08' tax_items: - rate: '0.05' name: State Tax amount: '12.50' exempt: false - rate: '0.03' name: County Tax amount: '7.50' exempt: false total_tax_amount_calculated: '20.00' taxable_amount: '500.00' tax_rate_calculated: '0.08' nexus_met: true has_active_registration: true '401': description: Authorization Error content: application/json: example: detail: The request is missing a valid x-api-key. schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Resource Not Found content: application/json: example: detail: Entered an incorrect URL. '422': description: Validation Error content: application/json: example: detail: - type: missing loc: - body - date msg: Field required input: external_id: '123456' total_amount: 1000 currency: USD description: Transaction for tax estimation simulate_active_registration: true addresses: - type: SHIP_TO street_1: 789 Elm Street city: Springfield state: MO postal_code: '65806' country: US transaction_items: - amount: 1000 date: '2025-01-26T10:15:00Z' external_product_id: PROD001 product_description: Sample product description product_name: Sample Product product_source: OTHER quantity: 2 tax_amount: '' tax_items: [] schema: $ref: >- #/components/schemas/backend__src__tax_estimation__responses__ValidationErrorResponse '500': description: Server Error content: application/json: example: detail: An unexpected server error occurred. schema: $ref: '#/components/schemas/ErrorResponse' security: - APIKeyHeader: [] CustomHeader: [] components: schemas: TransactionEstimatePublicRequest: properties: date: type: string format: date-time title: Date of this transaction in ISO 8601 format. description: >- The date of the transaction in ISO 8601 format (e.g., 2025-01-25T12:00:00Z). external_id: type: string title: Unique identifier of this transaction in the source system. description: Unique identifier of this transaction in the source system. currency: $ref: '#/components/schemas/CurrencyEnum' title: Currency of the transaction in ISO 4217 format. description: The currency in which the transaction is conducted (e.g., USD, EUR). description: description: An optional description of the transaction. type: string source: $ref: '#/components/schemas/SourceEnum' title: The system from which the transaction originated. description: >- While currently not used, it may be used in the future to determine taxability. The source of the transaction (e.g., OTHER). deprecated: true marketplace: description: Indicates if the transaction involves a marketplace. default: false type: boolean transaction_items: items: $ref: '#/components/schemas/TransactionItemEstimateBase' type: array title: The items that make up the transaction. description: List of items involved in the transaction. customer: $ref: '#/components/schemas/CustomerBasePublic' title: The customer who placed the transaction. description: >- Details about the customer. If the customer is not found, it will be ignored. addresses: items: properties: type: type: string enum: - SHIP_TO - BILL_TO description: |- Type of the address. Must be either SHIP_TO or BILL_TO. phone: description: Phone number associated with the customer. type: string street_1: type: string description: Primary street address of the customer. street_2: description: >- Additional street address details, such as an apartment or suite number. type: string city: description: City where the customer resides. type: string county: description: County or district of the customer. type: string state: type: string description: State or province of the address. postal_code: type: string description: Postal code of the address. country: type: string description: Country of the address. full_address: description: >- Complete address string of the customer, which can be used as an alternative to individual fields. type: string status: type: string description: Status of the address. Deprecated and ignored. deprecated: true type: object required: - type - state - postal_code - country type: array title: The address information for this transaction. description: >- List of addresses related to the transaction. At least one BILL_TO or SHIP_TO address must be provided. The address will be validated during estimation, and the transaction may be rejected if the address does not pass validation. The SHIP_TO will be preferred to use for determining tax liability. type: object required: - date - external_id - currency - transaction_items - addresses title: TransactionEstimatePublicRequest description: >- Public request model for tax estimation API documentation. This model excludes internal fields like enriched_fields and total_amount that should not be exposed in API docs. Page_TransactionEstimateResponse_: properties: items: items: $ref: '#/components/schemas/TransactionEstimateResponse' type: array title: Items total: type: integer minimum: 0 title: Total page: type: integer minimum: 1 title: Page size: type: integer minimum: 1 title: Size pages: type: integer minimum: 0 title: Pages type: object required: - items - total - page - size - pages title: Page[TransactionEstimateResponse] ErrorResponse: properties: detail: type: string title: Detail description: Error message type: object required: - detail title: ErrorResponse backend__src__tax_estimation__responses__ValidationErrorResponse: properties: detail: items: $ref: >- #/components/schemas/backend__src__tax_estimation__responses__ValidationErrorItem type: array title: Detail type: object required: - detail title: ValidationErrorResponse CurrencyEnum: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - IMP - INR - IQD - IRR - ISK - JEP - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SPL - SRD - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TVD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VEF - VND - VUV - WST - XAF - XCD - XDR - XOF - XPF - YER - ZAR - ZMW - ZWD title: CurrencyEnum SourceEnum: type: string enum: - BIGCOMMERCE - BESTBUY - BUNNY - CHARGEBEE - SHOPIFY - STRIPE - AMAZON - TIKTOK - CUSTOM - UNKNOWN - IMPORT - ZUORA - APIDECK - QUICKBOOKS - API - APPLE_APP_STORE - GOOGLE_APP_STORE - WALMART - PAYPAL - NETSUITE - XERO - MAXIO - RECURLY - SALESFORCE - ETSY - EBAY - WIX - SQUARESPACE - WOOCOMMERCE - MAGENTO - BILLING_PLATFORM - DEEL - RIPPLING - GUSTO - FACEBOOK - OTHER - ORDWAY - INSTAGRAM - PINTEREST - WAYFAIR - WISH - POS - TARGET - NEWEGG - GROUPON - GOOGLE_EXPRESS - NOCNOC - MERCADO_LIBRE - MODALYST - NORDSTROM - FAIRE - SHOPWARE - ZOHO - SAGE-INTACCT - AIRWALLEX - ORB - ZENSKAR - MICROSOFT_DYNAMICS_365 - KICKSTARTER - INTERNAL_ERP title: SourceEnum TransactionItemEstimateBase: properties: external_id: description: A unique identifier for the transaction item. type: string date: type: string format: date-time title: Date of this transaction item in ISO 8601 format. description: The date of the transaction item. description: description: A description of the item. type: string external_product_id: description: |- External product identifier. If not found and product_subcategory and product_category are not provided, an error occurs. type: string product_name: description: Name of the product. Used if creating a new product. type: string product_description: description: Description of the product. Used if creating a new product. type: string product_source: $ref: '#/components/schemas/SourceEnum' title: The source of the product. product_subcategory: description: |- Subcategory of the product. Required if product_category is used in place of external_product_id. type: string product_category: description: |- Category of the product. Required if product_subcategory is used in place of external_product_id. type: string quantity: description: Defaults to 1.0. The quantity of the item. default: '1.0' type: number amount: description: The total amount of the item. type: number exempt: type: boolean title: Whether or not this transaction item is exempt from tax. description: Defaults to false. Indicates whether the item is exempt from tax. default: false type: object required: - date - amount title: TransactionItemEstimateBase CustomerBasePublic: properties: phone: description: Phone number associated with the address. type: string street_1: description: Primary street address. type: string street_2: description: >- Additional street address details, such as an apartment or suite number. type: string city: description: City where the customer resides. type: string county: description: County or district of the customer. type: string state: description: State or province of the customer. type: string postal_code: description: ZIP or Postal code of the customer. type: string country: $ref: '#/components/schemas/CountryCodeEnum' description: Country code in ISO 3166-1 alpha-2 format full_address: description: >- Complete address string of the customer, which can be used as an alternative to individual fields. type: string name: description: Name of the customer. type: string external_id: description: A unique identifier for the customer. type: string status: $ref: '#/components/schemas/StatusEnum' description: Status of the customer (e.g., ACTIVE, INACTIVE). default: ACTIVE email: description: Email address of the customer. type: string address_status: $ref: '#/components/schemas/AddressStatus' description: Address status of the customer. Defaults to UNVERIFIED. default: UNVERIFIED source: $ref: '#/components/schemas/SourceEnum' description: >- Source of the customer information (e.g., BIGCOMMERCE, STRIPE, etc.). registration_number: type: string connection_id: description: Unique identifier of the connection related to the customer. type: string type: object title: CustomerBasePublic TransactionEstimateResponse: properties: date: type: string format: date-time title: Date of this transaction in ISO 8601 format. description: >- The date of the transaction in ISO 8601 format (e.g., 2025-01-25T12:00:00Z). external_id: type: string title: Unique identifier of this transaction in the source system. description: Unique identifier of this transaction in the source system. currency: $ref: '#/components/schemas/CurrencyEnum' title: Currency of the transaction in ISO 4217 format. description: The currency in which the transaction is conducted (e.g., USD, EUR). description: description: An optional description of the transaction. type: string source: $ref: '#/components/schemas/SourceEnum' title: The system from which the transaction originated. description: >- While currently not used, it may be used in the future to determine taxability. The source of the transaction (e.g., OTHER). deprecated: true marketplace: description: Indicates if the transaction involves a marketplace. default: false type: boolean transaction_items: items: $ref: '#/components/schemas/TransactionItemEstimateResponse' type: array title: Transaction Items customer: $ref: '#/components/schemas/CustomerBase' title: The customer who placed the transaction. description: >- Details about the customer. If the customer is not found, it will be ignored. addresses: items: properties: type: type: string enum: - SHIP_TO - BILL_TO description: |- Type of the address. Must be either SHIP_TO or BILL_TO. phone: description: Phone number associated with the customer. type: string street_1: type: string description: Primary street address of the customer. street_2: description: >- Additional street address details, such as an apartment or suite number. type: string city: description: City where the customer resides. type: string county: description: County or district of the customer. type: string state: type: string description: State or province of the address. postal_code: type: string description: Postal code of the address. country: type: string description: Country of the address. full_address: description: >- Complete address string of the customer, which can be used as an alternative to individual fields. type: string status: type: string description: Status of the address. Deprecated and ignored. deprecated: true enriched_fields: type: string description: Additional enriched fields related to the address. type: object required: - type - state - postal_code - country type: array title: The address information for this transaction. description: >- List of addresses related to the transaction. At least one BILL_TO or SHIP_TO address must be provided. The address will be validated during estimation, and the transaction may be rejected if the address does not pass validation. The SHIP_TO will be preferred to use for determining tax liability. **Deprecated:** Use of `address.status` in estimate api is ignored and will be removed in the future status will be considered UNVERIFIED by default and always validated total_tax_amount_calculated: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$) title: Total Tax Amount Calculated description: The total amount of tax determined for the transaction. default: '0.00' taxable_amount: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$) title: Taxable Amount description: The taxable amount for the transaction. default: '0.00' tax_rate_calculated: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,3}|(?=[\d.]{1,13}0*$)\d{0,3}\.\d{0,9}0*$) title: Tax Rate Calculated description: The calculated tax rate for the transaction. default: '0.00' nexus_met: type: boolean title: Nexus Met description: >- Indicates if nexus was met for the transaction.**Deprecated:** Use `has_active_registration` instead. default: false deprecated: true has_active_registration: type: boolean title: Active Registration Met description: Indicates if there is an active registration for the transaction. default: false type: object required: - date - external_id - currency - transaction_items - addresses title: TransactionEstimateResponse backend__src__tax_estimation__responses__ValidationErrorItem: properties: type: type: string title: Type description: Type of validation error loc: items: type: string type: array title: Loc description: Location of error msg: type: string title: Msg description: Error message input: title: Input description: Invalid input value ctx: additionalProperties: true type: object title: Ctx description: Additional context type: object required: - type - loc - msg - input - ctx title: ValidationErrorItem CountryCodeEnum: type: string enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - CV - KH - CM - CA - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - SZ - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - CI - JM - JP - JE - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MK - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - SS - ES - LK - SD - SR - SJ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - XK - ZZ_EU title: CountryCodeEnum StatusEnum: type: string enum: - ACTIVE - ARCHIVED title: StatusEnum AddressStatus: type: string enum: - UNVERIFIED - INVALID - PARTIALLY_VERIFIED - VERIFIED - UNVERIFIABLE - BLANK title: AddressStatus TransactionItemEstimateResponse: properties: external_id: description: A unique identifier for the transaction item. type: string date: type: string format: date-time title: Date of this transaction item in ISO 8601 format. description: The date of the transaction item. description: description: A description of the item. type: string external_product_id: description: |- External product identifier. If not found and product_subcategory and product_category are not provided, an error occurs. type: string product_name: description: Name of the product. Used if creating a new product. type: string product_description: description: Description of the product. Used if creating a new product. type: string product_source: $ref: '#/components/schemas/SourceEnum' title: The source of the product. product_subcategory: description: |- Subcategory of the product. Required if product_category is used in place of external_product_id. type: string product_category: description: |- Category of the product. Required if product_subcategory is used in place of external_product_id. type: string quantity: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,20}|(?=[\d.]{1,41}0*$)\d{0,20}\.\d{0,20}0*$) title: Quantity of the product. description: Defaults to 1.0. The quantity of the item. default: '1.0' amount: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$) title: Total amount of this transaction item, after discounts. description: The total amount of the item. exempt: type: boolean title: True if this item is tax exempt. description: Indicates whether the transaction item is exempt from tax. default: false tax_amount: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$) title: The amount of tax determined for this transaction item. description: The total tax amount for the transaction item. default: '0.00' taxable_amount: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$) title: The amount of this item that was determined to be taxable. description: The taxable amount for the transaction item. default: '0.00' tax_rate: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,3}|(?=[\d.]{1,13}0*$)\d{0,3}\.\d{0,9}0*$) title: The calculated combined tax rate for this transaction item. description: The tax rate applied to the transaction item. default: '0.00' exempt_reason: $ref: '#/components/schemas/TaxExemptionEnum' title: The reason why we determined the transaction item is exempt. description: Reason for exemption, if applicable. tax_items: items: $ref: '#/components/schemas/TaxItemEstimate' type: array title: The tax items that were determined for this transaction item. description: List of tax items applied to the transaction item. default: [] type: object required: - date - amount title: TransactionItemEstimateResponse CustomerBase: properties: phone: description: Phone number associated with the address. type: string street_1: description: Primary street address. type: string street_2: description: >- Additional street address details, such as an apartment or suite number. type: string city: description: City where the customer resides. type: string county: description: County or district of the customer. type: string state: description: State or province of the customer. type: string postal_code: description: ZIP or Postal code of the customer. type: string country: $ref: '#/components/schemas/CountryCodeEnum' description: Country code in ISO 3166-1 alpha-2 format full_address: description: >- Complete address string of the customer, which can be used as an alternative to individual fields. type: string name: description: Name of the customer. type: string external_id: description: A unique identifier for the customer. type: string status: $ref: '#/components/schemas/StatusEnum' description: Status of the customer (e.g., ACTIVE, INACTIVE). default: ACTIVE email: description: Email address of the customer. type: string address_status: $ref: '#/components/schemas/AddressStatus' description: Address status of the customer. Defaults to UNVERIFIED. default: UNVERIFIED source: $ref: '#/components/schemas/SourceEnum' description: >- Source of the customer information (e.g., BIGCOMMERCE, STRIPE, etc.). registration_number: type: string connection_id: description: Unique identifier of the connection related to the customer. type: string type: object title: CustomerBase TaxExemptionEnum: type: string enum: - PRODUCT - TRANSACTION - CUSTOMER - REGION - REVERSE_CHARGE - ZERO_RATE_TAX - HIGH_VALUE_PHYSICAL_GOODS - EXPORT - ZERO_VALUE_ITEM - NO_RULE_FOUND - IMPORTED - ZERO_RATE_NOT_EXEMPT title: TaxExemptionEnum description: This enum is used to determine if a transaction is exempt from tax. TaxItemEstimate: properties: rate: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,3}|(?=[\d.]{1,13}0*$)\d{0,3}\.\d{0,9}0*$) title: The tax rate for this this jurisdiction and tax type. default: '0.0' name: type: string title: >- The name of the tax item for this jurisdiction and tax type. ie. 'State Tax' amount: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$) title: The amount of tax determined for this jurisdiction and tax type. default: '0.0' exempt: type: boolean title: True if this item is tax exempt. default: false exempt_reason: $ref: '#/components/schemas/TaxItemReturnReasonEnum' title: The reason why we determined the tax item is exempt. rule: type: string type: object required: - name title: TaxItemEstimate TaxItemReturnReasonEnum: type: string enum: - NO_RULE_FOUND - RULE_FOUND_TAXABLE - RULE_FOUND_NOT_TAXABLE - RULE_FOUND_TAXABLE_ZERO_RATE - PRODUCT_EXEMPT - FROM_IMPORT - RULE_EXCLUDED_IN_CALCULATION title: TaxItemReturnReasonEnum description: We use this to understand the response from get_tax_items securitySchemes: APIKeyHeader: type: apiKey in: header name: X-API-KEY CustomHeader: type: apiKey in: header name: x-organization-id ````