{"openapi":"3.1.0","info":{"title":"API Reference","version":"1.0.0"},"paths":{"/tax/health":{"get":{"operationId":"salesTaxApi_Health","summary":"Health","description":"Use this API endpoint to check the health status of the tax api service","tags":["SALES TAX API"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_HealthResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}}}}},"/tax/connections/{connectionId}/carts":{"post":{"operationId":"cart_create-cart","summary":"Calculate sales tax for one or more carts","description":"\nUse this endpoint to view the tax amount and rate for a single cart or multiple carts. The cart represents a customer's shopping cart or other transaction that has not yet been completed. Each cart can be given a custom CartID to be referenced later. \nThis endpoint supports UPSERT actions: \n* If the specified cartID doesn't exist, a new cart is created. \n* If the cartID already exists, the existing cart is updated. This overwrites the previous cart items.\n","tags":["cart"],"parameters":[{"name":"connectionId","in":"path","description":"represents the ID of a connection. It is used as a unique identifier for the connection","required":true,"schema":{"type":"string","minLength":36}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_CreateCartsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_CreateCartsRequest"}}}},"security":[{"bearer":[]}]}},"/tax/connections/{connectionId}/carts/orders":{"post":{"operationId":"cart_createOrders","summary":"Create an order from a cartID","description":"\nUse this endpoint to convert an existing cart into a full order that will be filed. We recommend doing this when customer checks out or the order has been submitted, rather than when payment is collected. Note that the transactionDate will be the moment the endpoint is called.\n","tags":["cart"],"parameters":[{"name":"connectionId","in":"path","description":"represents the ID of a connection. It is used as a unique identifier for the connection","required":true,"schema":{"type":"string","minLength":36}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_OrderResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_CreateOrderFromCartRequest"}}}},"security":[{"bearer":[]}]}},"/tax/connections/{connectionId}/carts/{cartId}":{"get":{"operationId":"cart_get-cart","summary":"Get Cart By ID","description":"Retrieve a single cart by its cart ID.","tags":["cart"],"parameters":[{"name":"connectionId","in":"path","description":"represents the ID of a connection. It is used as a unique identifier for the connection","required":true,"schema":{"type":"string","minLength":36}},{"name":"cartId","in":"path","description":"the id of the cart","required":true,"schema":{"type":"string","minLength":1,"maxLength":50}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_CartResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}}},"security":[{"bearer":[]}]}},"/tax/connections/{connectionId}/exemption-certificates":{"post":{"operationId":"exemptionCertificate_create-exemption-certificate","summary":"Create Exemption Certificate","tags":["exemptionCertificate"],"parameters":[{"name":"connectionId","in":"path","description":"represents the ID of a connection. It is used as a unique identifier for the connection","required":true,"schema":{"type":"string","minLength":36}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ExemptionCertificateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ExemptionCertificateRequest"}}}},"security":[{"bearer":[]}]}},"/tax/connections/{connectionId}/exemption-certificates/{id}":{"get":{"operationId":"exemptionCertificate_get-exemption-certificates-by-id","summary":"Get Exemption Certificate By ID","tags":["exemptionCertificate"],"parameters":[{"name":"connectionId","in":"path","description":"represents the ID of a connection. It is used as a unique identifier for the connection","required":true,"schema":{"type":"string","minLength":36}},{"name":"id","in":"path","description":"the id of the exemption certificate","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ExemptionCertificateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}}},"security":[{"bearer":[]}]},"delete":{"operationId":"exemptionCertificate_delete-exemption-certificates-by-id","summary":"Disable Exemption Certificate By ID","tags":["exemptionCertificate"],"parameters":[{"name":"connectionId","in":"path","description":"represents the ID of a connection. It is used as a unique identifier for the connection","required":true,"schema":{"type":"string","minLength":36}},{"name":"id","in":"path","description":"the id of the exemption certificate","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}}},"security":[{"bearer":[]}]}},"/tax/exemption-certificates":{"get":{"operationId":"exemptionCertificate_get-exemption-certificates","summary":"Get Exemption Certificates","tags":["exemptionCertificate"],"parameters":[{"name":"limit","in":"query","description":"Maximum results per page","required":false,"schema":{"type":"integer","format":"int64","minimum":0,"maximum":100,"default":20}},{"name":"cursor","in":"query","description":"The position from where the page should start. This can be found in the result of a previous api call and should be used on subsequent api calls to get the next group of records","required":false,"schema":{"type":"string"}},{"name":"ascending","in":"query","description":"Whether you want the results to be ascending.","required":false,"schema":{"type":"boolean","default":false}},{"name":"sortBy","in":"query","description":"The field you want to sort by.","required":false,"schema":{"$ref":"#/components/schemas/SALES_TAX_API_TaxExemptionCertificatesGetParametersSortBy","default":"id"}},{"name":"customerId","in":"query","description":"The customer ID","required":false,"schema":{"type":"string"}},{"name":"disabled","in":"query","description":"Whether the exemption certificate is disabled","required":false,"schema":{"type":"boolean","default":false}},{"name":"connectionId","in":"query","required":false,"schema":{"type":"string","minLength":36}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ListResultExemptionCertificateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}}},"security":[{"bearer":[]}]}},"/tax/connections/{connectionId}/orders":{"post":{"operationId":"orders_create-order","summary":"Create Order","description":"Create orders from marketplace transactions, pre-existing systems, or bulk uploads.","tags":["orders"],"parameters":[{"name":"connectionId","in":"path","description":"represents the ID of a connection. It is used as a unique identifier for the connection","required":true,"schema":{"type":"string","minLength":36}},{"name":"addressAutocomplete","in":"query","description":"The specified addresses (origin, destination, or all) will be overridden with the first result from an address validation search","required":false,"schema":{"$ref":"#/components/schemas/SALES_TAX_API_TaxConnectionsConnectionIdOrdersPostParametersAddressAutocomplete","default":"none"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_OrderResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_CreateOrderRequest"}}}},"security":[{"bearer":[]}]}},"/tax/connections/{connectionId}/orders/{orderId}":{"get":{"operationId":"orders_get-order","summary":"Get Order By ID","tags":["orders"],"parameters":[{"name":"connectionId","in":"path","description":"represents the ID of a connection. It is used as a unique identifier for the connection","required":true,"schema":{"type":"string","minLength":36}},{"name":"orderId","in":"path","description":"the id of the order","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"comma-separated list of fields to expand. Currently supports: refunds","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_OrderResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}}},"security":[{"bearer":[]}]},"delete":{"operationId":"orders_void-order","summary":"Void Order","description":"Void an order that should not have been recorded, for example one created in error or with wrong data. Voiding removes the order and any refunds recorded against it from sales tax filing and nexus tracking, and frees the `orderId` so a corrected order can be created with the same id. A voided order returns 404 from GET; voiding it again returns 204.\n\nUse refunds, not void, when goods were actually sold and later returned.\n\nVoids have a monthly cutoff. An order can be voided until 12:00 AM Eastern on the 10th of the month after its `completedDate`: an order completed on any day in January can be voided through February 9. The cutoff is the same for every account regardless of filing frequency, so a quarterly filer's January order also locks on February 10. After the cutoff the request returns 422 and the order can only be corrected through TaxCloud support. Orders completed in the current month, orders with no `completedDate`, and orders excluded from filing can always be voided.\n\nVoiding is permanent.","tags":["orders"],"parameters":[{"name":"connectionId","in":"path","description":"represents the ID of a connection. It is used as a unique identifier for the connection","required":true,"schema":{"type":"string","minLength":36}},{"name":"orderId","in":"path","description":"the id of the order to void","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}}},"security":[{"bearer":[]}]},"patch":{"operationId":"orders_update-order","summary":"Update Order","description":"Use this endpoint to change the completedDate of an existing order","tags":["orders"],"parameters":[{"name":"connectionId","in":"path","description":"represents the ID of a connection. It is used as a unique identifier for the connection","required":true,"schema":{"type":"string","minLength":36}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_OrderResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_UpdateOrderRequest"}}}},"security":[{"bearer":[]}]}},"/tax/connections/{connectionId}/orders/refunds/{orderId}":{"post":{"operationId":"refunds_refund-order","summary":"Refund order","description":"Create a refund against an order. Multiple refunds are supported, but the total refunded quantity cannot exceed the original order quantity for each item. IMPORTANT: Refund prices and tax amounts are automatically calculated from the order. If the order had discounts applied, refunds will reflect the discounted prices (the actual amount paid). Do not send price or tax fields in the refund request - only itemId and quantity are required. Pass an `idempotencyKey` to make retries safe — a second request with the same key returns the original refund (HTTP 200) instead of creating a new one. Omitting `idempotencyKey` returns an `X-TaxCloud-Warning` response header recommending one; the refund is still created.","tags":["refunds"],"parameters":[{"name":"connectionId","in":"path","description":"represents the ID of a connection. It is used as a unique identifier for the connection","required":true,"schema":{"type":"string","minLength":36}},{"name":"orderId","in":"path","description":"the id of the order to refund against","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_RefundTransactionResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_RefundTransactionRequest"}}}},"security":[{"bearer":[]}]}},"/tax/connections/{connectionId}/ping":{"get":{"operationId":"utilities_ping","summary":"Ping","description":"Use this API endpoint to verify your authentication is working for the given connectionID.","tags":["utilities"],"parameters":[{"name":"connectionId","in":"path","description":"represents the ID of a connection. It is used as a unique identifier for the connection","required":true,"schema":{"type":"string","minLength":36}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_Pong"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}}},"security":[{"bearer":[]}]}},"/tax/tic/search":{"post":{"operationId":"utilities_tic-search","summary":"Search TIC Codes","description":"Search for Taxability Information Codes (TICs) using semantic search.\n\nThis endpoint helps you find the correct TICs for your products using natural language product descriptions, category names, or search terms. It uses semantic similarity (vector-based) to match meaning and context, so results can be relevant even when exact terminology doesn't match.\n\n**How it works:**\n- Provide a product description, category name, or search term\n- The system searches available TICs using semantic similarity\n- Results are ranked by relevance (most relevant first)\n- Set **limit** from 1–100 (defaults to **10** when omitted)\n- Use **cursor** to paginate through results (optional, from previous response's nextCursor)\n\n**Best Practices:**\n- Use specific descriptions: \"Ceramic & Pottery Kilns\" works better than \"kilns\"\n- Include context: \"Women's Athletic Shoes\" is better than \"shoes\"\n- If you don't find a match, try broader or more specific terms\n\n**Example Queries:**\n- \"Ceramic & Pottery Kilns\", \"Women's Running Shoes\", \"Laptop Computer\"\n- \"Clothing\", \"Electronics\", \"Food & Beverages\"\n- \"shipping charges\", \"digital goods\", \"prescription drugs\"\n\n**Service Availability:**\nIf you receive a service unavailable error (HTTP 503), this indicates temporary downstream service unavailability, potentially due to rate limiting. Check the Retry-After header (if present) and retry your request after the specified delay. Use exponential backoff for retries.","tags":["utilities"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_TicSearchResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_TicSearchRequest"}}}},"security":[{"bearer":[]}]}},"/tax/verify-address":{"post":{"operationId":"utilities_verify-address","summary":"Verify Address","description":"Use this endpoint to verify an address prior to doing a cart or creating a order.","tags":["utilities"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_VerifyAddressResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorModel"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SALES_TAX_API_VerifyAddressRequest"}}}},"security":[{"bearer":[]}]}}},"tags":[{"name":"SALES TAX API"},{"name":"cart"},{"name":"exemptionCertificate"},{"name":"orders"},{"name":"refunds"},{"name":"utilities"}],"servers":[{"url":"https://api.v3.taxcloud.com","description":"https://api.v3.taxcloud.com"}],"components":{"schemas":{"SALES_TAX_API_ComponentHealthResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the component"},"type":{"type":"string","description":"The type of the component"}},"required":["status","type"],"title":"ComponentHealthResponse"},"SALES_TAX_API_HealthResponse":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"components":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_ComponentHealthResponse"},"description":"The components of the service with their respective health status"},"status":{"type":"string","description":"The status of the service"}},"required":["components","status"],"title":"HealthResponse"},"SALES_TAX_API_ErrorDetail":{"type":"object","properties":{"location":{"type":"string","description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'"},"message":{"type":"string","description":"Error message text"},"value":{"description":"The value at the given location"}},"title":"ErrorDetail"},"SALES_TAX_API_ErrorModel":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"errors":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_ErrorDetail"},"description":"Optional list of individual error details"},"instance":{"type":"string","format":"uri","description":"A URI reference that identifies the specific occurrence of the problem."},"status":{"type":"integer","format":"int64","description":"HTTP status code"},"title":{"type":"string","description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error."},"type":{"type":"string","format":"uri","default":"about:blank","description":"A URI reference to human-readable documentation for the error."}},"title":"ErrorModel"},"SALES_TAX_API_CurrencyCurrencyCode":{"type":"string","enum":["USD","CAD"],"default":"USD","description":"specifies the currency of the price of a cart item.","title":"CurrencyCurrencyCode"},"SALES_TAX_API_Currency":{"type":"object","properties":{"currencyCode":{"$ref":"#/components/schemas/SALES_TAX_API_CurrencyCurrencyCode","default":"USD","description":"specifies the currency of the price of a cart item."}},"title":"Currency"},"SALES_TAX_API_AddressCountryCode":{"type":"string","enum":["US","CA"],"default":"US","description":"CountryCode is a string field that represents the ISO 3166-1 alpha-2 code of a country. For example, US for the United States, GB for Great Britain etc. Default value is US.","title":"AddressCountryCode"},"SALES_TAX_API_Address":{"type":"object","properties":{"city":{"type":"string","minLength":1,"maxLength":50,"description":"City or post-town"},"countryCode":{"$ref":"#/components/schemas/SALES_TAX_API_AddressCountryCode","default":"US","description":"CountryCode is a string field that represents the ISO 3166-1 alpha-2 code of a country. For example, US for the United States, GB for Great Britain etc. Default value is US."},"line1":{"type":"string","minLength":1,"maxLength":128,"description":"the first line of the address (e.g., street, PO Box, or building). Values longer than 50 characters will be automatically truncated."},"line2":{"type":"string","minLength":0,"maxLength":128,"description":"the second line of the address, if there is one (e.g., apartment or suite number). Values longer than 50 characters will be automatically truncated."},"state":{"type":"string","minLength":2,"maxLength":2,"description":"Two-character state or province code (e.g., MN)."},"zip":{"type":"string","minLength":1,"maxLength":16,"description":"Postal or ZIP code. For US addresses this must be a 5-digit ZIP code or ZIP+4 (e.g., 55401 or 55401-2427)."}},"required":["city","line1","state","zip"],"title":"Address"},"SALES_TAX_API_LineItemDiscountType":{"type":"string","enum":["percentage","amount"],"description":"The type of discount: 'percentage' or 'amount'","title":"LineItemDiscountType"},"SALES_TAX_API_LineItemDiscount":{"type":"object","properties":{"cartItemIndex":{"type":"integer","format":"int64","minimum":0,"description":"Optional. Disambiguates which cart line item to apply the discount to when the order has multiple line items sharing the same itemId. If omitted and the order has exactly one matching itemId, that line is used. If omitted and multiple lines share the itemId, the request is rejected."},"itemId":{"type":"string","description":"The ID of the line item this discount applies to. Must match an itemId in the lineItems array. When the order reuses this itemId across multiple lines, pair it with cartItemIndex to identify the line."},"type":{"$ref":"#/components/schemas/SALES_TAX_API_LineItemDiscountType","description":"The type of discount: 'percentage' or 'amount'"},"value":{"type":"number","format":"double","minimum":0,"description":"The discount value (percentage as decimal 0-1, or dollar amount). IMPORTANT: When providing discounts, prices in lineItems should be pre-discount (original prices). If prices are already discounted, do not provide the discounts field."}},"required":["itemId","type","value"],"title":"LineItemDiscount"},"SALES_TAX_API_OrderLevelDiscountType":{"type":"string","enum":["percentage","amount"],"description":"The type of discount: 'percentage' or 'amount'","title":"OrderLevelDiscountType"},"SALES_TAX_API_OrderLevelDiscount":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SALES_TAX_API_OrderLevelDiscountType","description":"The type of discount: 'percentage' or 'amount'"},"value":{"type":"number","format":"double","minimum":0,"description":"The discount value (percentage as decimal 0-1, or dollar amount). IMPORTANT: When providing discounts, prices in lineItems should be pre-discount (original prices). If prices are already discounted, do not provide the discounts field."}},"required":["type","value"],"title":"OrderLevelDiscount"},"SALES_TAX_API_Discounts":{"type":"object","properties":{"lineItemDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_LineItemDiscount"},"description":"Discounts applied to specific line items. Applied before order-level discounts. Each discount must reference a valid itemId from the lineItems array."},"orderDiscount":{"$ref":"#/components/schemas/SALES_TAX_API_OrderLevelDiscount","description":"Discount applied to the entire order. Applied after line-item discounts. Shipping items (TICs 11010-11015) and Colorado retail delivery fees (TIC 11098) are excluded from order-level discount calculations. Prices in lineItems are pre-discount (original prices)."}},"title":"Discounts"},"SALES_TAX_API_Exemption":{"type":"object","properties":{"exemptionId":{"type":["string","null"],"minLength":1,"description":"represents the id of an exemption certificate used for a customer"},"isExempt":{"type":["boolean","null"],"description":"is the customer exempt, if exemptionID is given isExempt is assumed true"}},"title":"Exemption"},"SALES_TAX_API_CartItem":{"type":"object","properties":{"index":{"type":"integer","format":"int64","minimum":0,"maximum":500,"description":"represents the index of a cart item. It is used to specify the position of the item within the cart."},"itemId":{"type":"string","minLength":1,"maxLength":50,"description":"the ID of a cart item. If the same itemId appears on multiple lines, the line is identified by itemId plus its index. Store both if you may later refund an individual line."},"price":{"type":"number","format":"double","minimum":0,"description":"Price represents the unit price of a cart item. When providing discounts, prices should be pre-discount (original prices)."},"productId":{"type":"string","description":"A unique ID of the product from the product catalog (e.g. SKU). Must match an existing product"},"quantity":{"type":"number","format":"double","minimum":0,"maximum":99999.9999,"description":"Quantity represents the quantity of a cart item. For quantities above the maximum, send a single line with quantity 1 and the extended (total) amount as the price."},"tic":{"type":"integer","format":"int64","minimum":0,"maximum":100000,"description":"Tic (Taxability Information Codes) defaults to 0 if none is sent"}},"required":["index","itemId","price","quantity"],"title":"CartItem"},"SALES_TAX_API_Cart":{"type":"object","properties":{"cartId":{"type":"string","minLength":1,"maxLength":50,"description":"Id that represents this cart.  If no id is passed one will be generated for you."},"currency":{"$ref":"#/components/schemas/SALES_TAX_API_Currency","description":"represents information about a currency including its code and denomination."},"customerId":{"type":"string","minLength":1,"maxLength":50,"description":"customerId in external system"},"deliveredBySeller":{"type":"boolean","description":"represents if the seller directly delivered the order."},"destination":{"$ref":"#/components/schemas/SALES_TAX_API_Address","description":"the destination address of the order"},"discounts":{"$ref":"#/components/schemas/SALES_TAX_API_Discounts","description":"Optional discounts to apply. If not provided, prices are consumed as is."},"exemption":{"$ref":"#/components/schemas/SALES_TAX_API_Exemption","description":"information about exemption on the order"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_CartItem"}},"origin":{"$ref":"#/components/schemas/SALES_TAX_API_Address","description":"the origin address of the order"}},"required":["currency","customerId","destination","lineItems","origin"],"title":"Cart"},"SALES_TAX_API_CreateCartsRequest":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"items":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_Cart"}},"transactionDate":{"type":"string","format":"date-time","description":"The RFC3339 datetime string the cart is calculated for (if no value is passed in now is assumed)"}},"required":["items"],"title":"CreateCartsRequest"},"SALES_TAX_API_CurrencyResponse":{"type":"object","properties":{"currencyCode":{"type":"string","description":"specifies the currency of the price of a cart item."}},"required":["currencyCode"],"title":"CurrencyResponse"},"SALES_TAX_API_AddressResponse":{"type":"object","properties":{"city":{"type":"string","minLength":1,"maxLength":64,"description":"City or post-town"},"countryCode":{"type":"string","minLength":1,"maxLength":2,"default":"US","description":"CountryCode is a string field that represents the ISO 3166-1 alpha-2 code of a country. For example, US for the United States, GB for Great Britain etc. Default and only currently accepted value is US."},"line1":{"type":"string","minLength":1,"maxLength":128,"description":"the first line of the address (e.g., street, PO Box, or building). Values longer than 50 characters will be automatically truncated."},"line2":{"type":"string","minLength":0,"maxLength":128,"description":"the second line of the address, if there is one (e.g., apartment or suite number). Values longer than 50 characters will be automatically truncated."},"state":{"type":"string","minLength":1,"maxLength":32,"description":"State, province, county or other large territorial division."},"zip":{"type":"string","minLength":1,"maxLength":16,"description":"Postal or ZIP code."}},"required":["city","countryCode","line1","state","zip"],"title":"AddressResponse"},"SALES_TAX_API_Tax":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"represents the amount associated with a cart item."},"rate":{"type":"number","format":"double","maximum":0.99999,"description":"represents the tax rate of a cart item."}},"required":["amount","rate"],"title":"Tax"},"SALES_TAX_API_CartItemWithTaxResponse":{"type":"object","properties":{"index":{"type":"integer","format":"int64","minimum":0,"maximum":500,"description":"represents the index of a cart item. It is used to specify the position of the item within the cart."},"itemId":{"type":"string","description":"represents the ID of a cart item. With index, forms the key (itemId, index) that uniquely identifies this line within the cart."},"originalPrice":{"type":"number","format":"double","description":"Original price before discounts applied."},"price":{"type":"number","format":"double","description":"Price represents the discounted unit price of a cart item, if applicable (what tax is calculated on)."},"productId":{"type":["string","null"],"description":"ID of the product from the product catalog (e.g. SKU). Null if the line item has no associated product."},"quantity":{"type":"number","format":"double","minimum":0,"description":"Quantity represents the quantity of a cart item."},"tax":{"$ref":"#/components/schemas/SALES_TAX_API_Tax","description":"represents the tax information associated with a cart item."},"tic":{"type":["integer","null"],"format":"int64","minimum":0,"maximum":100000,"description":"Tic (Taxability Information Codes) defaults to 0 if none is sent"}},"required":["index","itemId","originalPrice","price","quantity","tax","tic"],"title":"CartItemWithTaxResponse"},"SALES_TAX_API_CartResponse":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"cartId":{"type":"string","maxLength":50,"description":"Id that represents this cart.  If no id is passed one will be generated for you."},"currency":{"$ref":"#/components/schemas/SALES_TAX_API_CurrencyResponse","description":"represents information about a currency including its code and denomination."},"customerId":{"type":"string","maxLength":50,"description":"customerId in external system"},"deliveredBySeller":{"type":"boolean","description":"represents if the seller directly delivered the order."},"destination":{"$ref":"#/components/schemas/SALES_TAX_API_AddressResponse","description":"the destination address of the order"},"exemption":{"$ref":"#/components/schemas/SALES_TAX_API_Exemption","description":"information about exemption on the order"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_CartItemWithTaxResponse"}},"origin":{"$ref":"#/components/schemas/SALES_TAX_API_AddressResponse","description":"the origin address of the order"}},"required":["cartId","currency","customerId","deliveredBySeller","destination","exemption","lineItems","origin"],"title":"CartResponse"},"SALES_TAX_API_CreateCartsResponse":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"connectionId":{"type":"string","minLength":36,"description":"represents the ID of a connection. It is used as a unique identifier for the connection"},"items":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_CartResponse"}},"transactionDate":{"type":"string","format":"date-time","description":"The RFC3339 datetime string the cart is calculated for"}},"required":["connectionId","items","transactionDate"],"title":"CreateCartsResponse"},"SALES_TAX_API_CreateOrderFromCartRequestKind":{"type":"string","enum":["credit","order"],"default":"order","description":"The kind of order to create. Defaults to 'order'. Use 'credit' for credit orders.","title":"CreateOrderFromCartRequestKind"},"SALES_TAX_API_CreateOrderFromCartRequest":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"cartId":{"type":"string","minLength":1,"maxLength":50,"description":"Id that represents this cart."},"completed":{"type":"boolean","default":false,"description":"was the order shipped, creating a tax liability."},"completedDate":{"type":"string","format":"date-time","description":"The date the order was shipped on, which created a tax liability. If provided, takes precedence over the completed field."},"kind":{"$ref":"#/components/schemas/SALES_TAX_API_CreateOrderFromCartRequestKind","default":"order","description":"The kind of order to create. Defaults to 'order'. Use 'credit' for credit orders."},"orderId":{"type":"string","minLength":1,"maxLength":50,"description":"orderId in external system"}},"required":["cartId","orderId"],"title":"CreateOrderFromCartRequest"},"SALES_TAX_API_OrderResponseKind":{"type":"string","enum":["credit","order"],"description":"The kind of order, either credit or order. Defaults to order if not provided.","title":"OrderResponseKind"},"SALES_TAX_API_RefundTax":{"type":"object","properties":{"amount":{"type":"number","format":"double","minimum":0,"description":"represents the calculated tax amount for the refunded item."}},"required":["amount"],"title":"RefundTax"},"SALES_TAX_API_CartItemRefundWithTaxResponse":{"type":"object","properties":{"index":{"type":"integer","format":"int64","minimum":0,"maximum":100,"description":"represents the index of a cart item. It is used to specify the position of the item within the cart."},"itemId":{"type":"string","description":"represents the ID of a cart item. Together with index it identifies the line: (itemId, index)."},"price":{"type":"number","format":"double","minimum":0,"description":"Price represents the unit price refunded. This is automatically calculated from the order. If the order had discounts applied, this price reflects the discounted amount (the actual amount paid by the customer)."},"quantity":{"type":"number","format":"double","minimum":0,"description":"Quantity represents the quantity refunded."},"tax":{"$ref":"#/components/schemas/SALES_TAX_API_RefundTax","description":"Tax amount refunded. This is automatically calculated proportionally from the order's tax. If the order had discounts, this reflects tax on the discounted price."},"tic":{"type":"integer","format":"int64","minimum":0,"maximum":100000,"default":0,"description":"Tic (Taxability Information Codes) are For more information visit <<doc link>>"}},"required":["index","itemId","price","quantity"],"title":"CartItemRefundWithTaxResponse"},"SALES_TAX_API_RefundTransactionResponse":{"type":"object","properties":{"batchId":{"type":"string","description":"Batch ID for grouping refunds"},"connectionId":{"type":"string","minLength":36,"description":"represents the ID of a connection. It is used as a unique identifier for the connection"},"createdDate":{"type":"string","format":"date-time","description":"represents the time when the refund was created."},"idempotencyKey":{"type":"string","description":"Echoed back when the refund was created with an idempotency key."},"items":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_CartItemRefundWithTaxResponse"}},"returnedDate":{"type":"string","format":"date-time","description":"represents the time when the refund took effect."}},"required":["connectionId","items"],"title":"RefundTransactionResponse"},"SALES_TAX_API_OrderResponse":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"batchId":{"type":"string","description":"Batch ID for grouping orders"},"channel":{"type":["string","null"],"description":"what channel did this come from"},"completedDate":{"type":"string","format":"date-time","description":"The RFC3339 datetime string the order was shipped on, created a tax liability"},"connectionId":{"type":"string","minLength":36,"description":"represents the ID of a connection. It is used as a unique identifier for the connection"},"currency":{"$ref":"#/components/schemas/SALES_TAX_API_CurrencyResponse","description":"represents information about a currency including its code and denomination."},"customerId":{"type":"string","description":"customerId in external system"},"deliveredBySeller":{"type":"boolean","description":"represents if the seller directly delivered the order."},"destination":{"$ref":"#/components/schemas/SALES_TAX_API_AddressResponse","description":"the destination address of the order"},"excludeFromFiling":{"type":"boolean","default":false,"description":"Whether to exclude from filing"},"exemption":{"$ref":"#/components/schemas/SALES_TAX_API_Exemption","description":"information about exemption on the order"},"kind":{"$ref":"#/components/schemas/SALES_TAX_API_OrderResponseKind","description":"The kind of order, either credit or order. Defaults to order if not provided."},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_CartItemWithTaxResponse"}},"orderId":{"type":"string","description":"orderId in external system"},"origin":{"$ref":"#/components/schemas/SALES_TAX_API_AddressResponse","description":"the origin address of the order"},"refunds":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_RefundTransactionResponse"},"description":"refunds associated with this order when expand=refunds is specified"},"transactionDate":{"type":"string","format":"date-time","description":"The RFC3339 datetime string the order was purchased on"}},"required":["channel","connectionId","currency","customerId","deliveredBySeller","destination","excludeFromFiling","exemption","kind","lineItems","orderId","origin","transactionDate"],"title":"OrderResponse"},"SALES_TAX_API_ExemptionCertificateRequestCustomerBusinessType":{"type":"string","enum":["AccommodationAndFoodServices","AgriculturalForestryFishingHunting","Construction","FinanceAndInsurance","InformationPublishingAndCommunications","Manufacturing","Mining","RealEstate","RentalAndLeasing","RetailTrade","TransportationAndWarehousing","Utilities","WholesaleTrade","BusinessServices","ProfessionalServices","EducationAndHealthCareServices","NonprofitOrganization","Government","NotABusiness","Other"],"description":"The type of business the customer is","title":"ExemptionCertificateRequestCustomerBusinessType"},"SALES_TAX_API_ExemptionCertificateRequestReason":{"type":"string","enum":["FederalGovernment","StateOrLocalGovernment","TribalGovernment","ForeignDiplomat","CharitableOrganization","EducationalOrganization","Resale","AgriculturalProduction","IndustrialProductionOrManufacturing","DirectPayPermit","DirectMail","Other","ReligiousOrganization"],"description":"The reason the customer is exempt from taxes","title":"ExemptionCertificateRequestReason"},"SALES_TAX_API_ExemptionCertificateExemptStatesResponse":{"type":"object","properties":{"abbreviation":{"type":"string","minLength":2,"maxLength":2,"description":"The state that issued the exemption certificate"}},"required":["abbreviation"],"title":"ExemptionCertificateExemptStatesResponse"},"SALES_TAX_API_ExemptionCertificateRequest":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"address":{"$ref":"#/components/schemas/SALES_TAX_API_Address","description":"Address of the customer"},"customerBusinessDescription":{"type":"string","maxLength":20,"description":"description for business type if type is other"},"customerBusinessType":{"$ref":"#/components/schemas/SALES_TAX_API_ExemptionCertificateRequestCustomerBusinessType","description":"The type of business the customer is"},"customerId":{"type":"string","maxLength":50,"description":"Id for the customer in the given connection"},"customerName":{"type":"string","maxLength":50,"description":"name of the customer who purchased the exemption certificate"},"reason":{"$ref":"#/components/schemas/SALES_TAX_API_ExemptionCertificateRequestReason","description":"The reason the customer is exempt from taxes"},"reasonDescription":{"type":"string","maxLength":20,"description":"The reason the customer is exempt from taxes"},"states":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_ExemptionCertificateExemptStatesResponse"},"description":"List of states that the exemption certificate is valid for"}},"required":["address","customerBusinessType","customerId","customerName","reason","reasonDescription","states"],"title":"ExemptionCertificateRequest"},"SALES_TAX_API_ExemptionCertificateResponseCustomerBusinessType":{"type":"string","enum":["AccommodationAndFoodServices","AgriculturalForestryFishingHunting","Construction","FinanceAndInsurance","InformationPublishingAndCommunications","Manufacturing","Mining","RealEstate","RentalAndLeasing","RetailTrade","TransportationAndWarehousing","Utilities","WholesaleTrade","BusinessServices","ProfessionalServices","EducationAndHealthCareServices","NonprofitOrganization","Government","NotABusiness","Other"," Unknown"],"description":"The type of business the customer is","title":"ExemptionCertificateResponseCustomerBusinessType"},"SALES_TAX_API_ExemptionCertificateResponseReason":{"type":"string","enum":["FederalGovernment","StateOrLocalGovernment","TribalGovernment","ForeignDiplomat","CharitableOrganization","EducationalOrganization","Resale","AgriculturalProduction","IndustrialProductionOrManufacturing","DirectPayPermit","DirectMail","Other","ReligiousOrganization","Unknown"],"description":"The reason the customer is exempt from taxes","title":"ExemptionCertificateResponseReason"},"SALES_TAX_API_ExemptionCertificateResponse":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"accountId":{"type":"integer","format":"int64","description":"The account id for the exemption certificate"},"address":{"$ref":"#/components/schemas/SALES_TAX_API_Address","description":"Address of the customer"},"certificateId":{"type":"string","description":"Id for the exemption certificate"},"connectionId":{"type":"string","description":"The connection id for the exemption certificate"},"createdDate":{"type":"string","format":"date-time","description":"The RFC3339 datetime string the exemption certificate was created at"},"customerBusinessDescription":{"type":"string","description":"description for business type if type is other"},"customerBusinessType":{"$ref":"#/components/schemas/SALES_TAX_API_ExemptionCertificateResponseCustomerBusinessType","description":"The type of business the customer is"},"customerId":{"type":"string","description":"Id for the customer in the given connection"},"customerName":{"type":"string","description":"name of the customer who purchased the exemption certificate"},"disabledAt":{"type":["string","null"],"format":"date-time","description":"The RFC3339 datetime string the exemption certificate was disabled at, if applicable"},"reason":{"$ref":"#/components/schemas/SALES_TAX_API_ExemptionCertificateResponseReason","description":"The reason the customer is exempt from taxes"},"reasonDescription":{"type":"string","description":"The reason the customer is exempt from taxes"},"singlePurchase":{"type":"boolean","description":"Whether the exemption certificate is for a single purchase"},"states":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_ExemptionCertificateExemptStatesResponse"}}},"required":["accountId","address","certificateId","connectionId","createdDate","customerBusinessType","customerId","customerName","disabledAt","reason","reasonDescription","singlePurchase","states"],"title":"ExemptionCertificateResponse"},"SALES_TAX_API_TaxExemptionCertificatesGetParametersSortBy":{"type":"string","enum":["createdDate","id"],"default":"id","description":"The field you want to sort by.","title":"TaxExemptionCertificatesGetParametersSortBy"},"SALES_TAX_API_ListResultExemptionCertificateResponse":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"items":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_ExemptionCertificateResponse"}},"limit":{"type":"integer","format":"int64","minimum":0,"maximum":100,"description":"Maximum results per page"},"nextCursor":{"type":["string","null"]}},"required":["items","limit","nextCursor"],"title":"ListResultExemptionCertificateResponse"},"SALES_TAX_API_TaxConnectionsConnectionIdOrdersPostParametersAddressAutocomplete":{"type":"string","enum":["none","origin","destination","all"],"default":"none","description":"The specified addresses (origin, destination, or all) will be overridden with the first result from an address validation search","title":"TaxConnectionsConnectionIdOrdersPostParametersAddressAutocomplete"},"SALES_TAX_API_CreateOrderRequestKind":{"type":"string","enum":["credit","order"],"default":"order","description":"The kind of order, either credit or order. Defaults to order if not provided.","title":"CreateOrderRequestKind"},"SALES_TAX_API_CartItemWithTax":{"type":"object","properties":{"index":{"type":"integer","format":"int64","minimum":0,"maximum":500,"description":"represents the index of a cart item. It is used to specify the position of the item within the cart."},"itemId":{"type":"string","minLength":1,"maxLength":50,"description":"the ID of a cart item. If the same itemId appears on multiple lines, the line is identified by itemId plus its index. Store both if you may later refund an individual line."},"price":{"type":"number","format":"double","minimum":0,"description":"Price represents the price of a cart item (what tax is calculated on)."},"productId":{"type":"string","description":"ID of the product from the product catalog. Must match an existing product"},"quantity":{"type":"number","format":"double","minimum":0,"maximum":99999.9999,"description":"Quantity represents the quantity of a cart item. For quantities above the maximum, send a single line with quantity 1 and the extended (total) amount as the price."},"tax":{"$ref":"#/components/schemas/SALES_TAX_API_Tax","description":"represents the tax information associated with a cart item."},"tic":{"type":"integer","format":"int64","minimum":0,"maximum":100000,"description":"Tic (Taxability Information Codes) defaults to 0 if none is sent"}},"required":["index","itemId","price","quantity","tax"],"title":"CartItemWithTax"},"SALES_TAX_API_CreateOrderRequest":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"batchId":{"type":"string","description":"Optional batch ID for grouping orders"},"channel":{"type":"string","description":"what channel did this come from. Pass in one of amazon,ebay,walmart for tax exclusion"},"completedDate":{"type":"string","format":"date-time","description":"The RFC3339 datetime string the order was shipped on, created a tax liability"},"currency":{"$ref":"#/components/schemas/SALES_TAX_API_Currency","description":"represents information about a currency including its code and denomination."},"customerId":{"type":"string","maxLength":50,"description":"customerId in external system"},"deliveredBySeller":{"type":"boolean","description":"represents if the seller directly delivered the order."},"destination":{"$ref":"#/components/schemas/SALES_TAX_API_Address","description":"the destination address of the order"},"discounts":{"$ref":"#/components/schemas/SALES_TAX_API_Discounts","description":"Optional discounts to apply. If not provided, prices are consumed as is."},"excludeFromFiling":{"type":"boolean","description":"When true, the order is recorded but omitted from the filed sales tax return (no tax liability). Defaults to false. Typically for orders whose tax is filed elsewhere, e.g. a marketplace facilitator."},"exemption":{"$ref":"#/components/schemas/SALES_TAX_API_Exemption","description":"information about exemption on the order"},"kind":{"$ref":"#/components/schemas/SALES_TAX_API_CreateOrderRequestKind","default":"order","description":"The kind of order, either credit or order. Defaults to order if not provided."},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_CartItemWithTax"}},"orderId":{"type":"string","maxLength":50,"description":"orderId in external system"},"origin":{"$ref":"#/components/schemas/SALES_TAX_API_Address","description":"the origin address of the order"},"transactionDate":{"type":"string","format":"date-time","description":"The RFC3339 datetime string the order was purchased on"}},"required":["completedDate","currency","customerId","destination","lineItems","orderId","origin","transactionDate"],"title":"CreateOrderRequest"},"SALES_TAX_API_UpdateOrderRequest":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"completedDate":{"type":"string","format":"date-time","description":"The date the order was shipped on, which created a tax liability"}},"title":"UpdateOrderRequest"},"SALES_TAX_API_CartItemRefundWithTaxRequest":{"type":"object","properties":{"cartItemIndex":{"type":"integer","format":"int64","minimum":0,"description":"Optional. Disambiguates which cart line item to refund against when the original order has multiple line items sharing the same itemId. If omitted and the order has exactly one matching itemId, that line is used. If omitted and multiple lines share the itemId, the request is rejected."},"itemId":{"type":"string","minLength":1,"maxLength":50,"description":"represents the ID of a cart item. Must match an itemId from the original order. When the order reuses this itemId across multiple lines, pair it with cartItemIndex to identify the line."},"quantity":{"type":"number","format":"double","minimum":0,"maximum":99999.9999,"description":"Quantity represents the quantity to refund."}},"required":["itemId","quantity"],"title":"CartItemRefundWithTaxRequest"},"SALES_TAX_API_RefundTransactionRequest":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"batchId":{"type":"string","description":"Optional batch ID for grouping refunds"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":200,"description":"Optional opaque key uniquely identifying this refund within the (connection, order). When present, a second create attempt with the same key returns the original refund (HTTP 200) instead of creating a new one. Recommended for ETL or Service Bus consumers that may retry. Use a stable identifier from your source system (e.g. a Shopify refund GID), not a request UUID."},"items":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_CartItemRefundWithTaxRequest"},"description":"represents the items of the refund request, if an empty lists or no lists is passed it is assumed the entire order will be refunded. IMPORTANT: Prices and tax amounts are automatically calculated from the order. If the order had discounts, refunds will use the discounted prices (actual amount paid)."},"returnedDate":{"type":["string","null"],"format":"date-time","description":"The date of the return; defaults to the current timestamp. Leave empty (recommended) to deduct the refund from the current month's filing. Setting to a prior-month date may trigger an amended filing."}},"title":"RefundTransactionRequest"},"SALES_TAX_API_Pong":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"message":{"type":"string","description":"success message when correctly authenticated."}},"required":["message"],"title":"Pong"},"SALES_TAX_API_TicSearchRequest":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"cursor":{"type":"string","description":"Pagination cursor from previous response. Use the nextCursor value from a previous request to get the next page of results."},"limit":{"type":"integer","format":"int64","description":"Maximum number of TIC results to return (1-100). Defaults to 10 if not provided. Fewer results may be returned if fewer matches are available."},"query":{"type":"string","description":"Product description, category name, or search term"}},"required":["query"],"title":"TicSearchRequest"},"SALES_TAX_API_TicSearchResult":{"type":"object","properties":{"description":{"type":"string","description":"Short description of the TIC code"},"documentation":{"type":"string","description":"Detailed documentation of the TIC code"},"label":{"type":"string","description":"Short TIC label"},"naturalLabel":{"type":"string","description":"Natural language TIC description"},"rank":{"type":"integer","format":"int64","description":"1-indexed rank (1 = most relevant)"},"score":{"type":"number","format":"double","description":"Relevance score from semantic search (0-1)"},"ticId":{"type":"integer","format":"int64","description":"TIC code"}},"required":["description","documentation","label","naturalLabel","rank","score","ticId"],"title":"TicSearchResult"},"SALES_TAX_API_TicSearchResponse":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"nextCursor":{"type":"string","description":"Cursor for retrieving next page of results"},"query":{"type":"string","description":"Echo of the input query"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SALES_TAX_API_TicSearchResult"},"description":"Ranked TIC results (most relevant first)"}},"required":["query","results"],"title":"TicSearchResponse"},"SALES_TAX_API_VerifyAddressRequest":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"city":{"type":"string","minLength":1,"maxLength":64,"description":"City or post-town"},"countryCode":{"type":"string","minLength":1,"maxLength":2,"default":"US","description":"CountryCode is a string field that represents the ISO 3166-1 alpha-2 code of a country. For example, US for the United States, GB for Great Britain etc. Default and only currently accepted value is US."},"line1":{"type":"string","minLength":1,"maxLength":128,"description":"the first line of the address (e.g., street, PO Box, or building). Values longer than 50 characters will be automatically truncated."},"line2":{"type":"string","minLength":0,"maxLength":128,"description":"the second line of the address, if there is one (e.g., apartment or suite number). Values longer than 50 characters will be automatically truncated."},"state":{"type":"string","minLength":1,"maxLength":32,"description":"State, province, county or other large territorial division."},"zip":{"type":"string","minLength":1,"maxLength":16,"description":"Postal or ZIP code."}},"required":["city","line1","state","zip"],"title":"VerifyAddressRequest"},"SALES_TAX_API_VerifyAddressResponse":{"type":"object","properties":{"$schema":{"type":"string","format":"uri","description":"A URL to the JSON Schema for this object."},"city":{"type":"string","minLength":1,"maxLength":64,"description":"City or post-town"},"countryCode":{"type":"string","minLength":1,"maxLength":2,"default":"US","description":"CountryCode is a string field that represents the ISO 3166-1 alpha-2 code of a country. For example, US for the United States, GB for Great Britain etc. Default and only currently accepted value is US."},"line1":{"type":"string","minLength":1,"maxLength":128,"description":"the first line of the address (e.g., street, PO Box, or building). Values longer than 50 characters will be automatically truncated."},"line2":{"type":"string","minLength":0,"maxLength":128,"description":"the second line of the address, if there is one (e.g., apartment or suite number). Values longer than 50 characters will be automatically truncated."},"state":{"type":"string","minLength":1,"maxLength":32,"description":"State, province, county or other large territorial division."},"zip":{"type":"string","minLength":1,"maxLength":16,"description":"Postal or ZIP code."}},"required":["city","line1","state","zip"],"title":"VerifyAddressResponse"}},"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"This authentication type can be used to directly call the service."},"apiKey":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"This authentication type is supported by using the provided API key for the merchant account."}}}}