Quote tax for a draft invoice

POST/v1/invoices/{invoiceId}/tax/quote

Authorization

AuthorizationBearer token · headerrequired

Public API key bearer token.

Path parameters

invoiceIdstringrequired

Query parameters

environmentstringrequired

merchantAccountIdstringrequired

Header parameters

Idempotency-Keystring

Required for production-safe retries on mutating routes. Reusing a key with a different request body returns 409.

min length 1

Request body

requiredapplication/json

customerTaxAddressTaxAddressrequired

Show properties

line1stringrequired

line2string

citystringrequired

regionstringrequired

postalCodestringrequired

countrystringrequired

taxBehaviorPolicyTaxBehaviorPolicyRequest

Show properties

behaviorTaxBehaviorrequired

Allowed:exclusiveinclusivelocation_based

locationRefstring

requestedByRefstring

Responses

200Success

dataobjectrequired

Show properties

taxInvoiceTaxrequired

Show properties

invoiceNumberstringrequired

statusstringrequired

Allowed:not_requiredquote_pendingquotedfinalization_pendingfinalizedfailedvoidedreversed

currencystringrequired

subtotalintegerrequired

taxTotalintegerrequired

totalintegerrequired

evidenceVersionstringrequired

taxBehaviorPolicyTaxBehaviorPolicyrequired

Show properties

behaviorTaxBehaviorrequired

Allowed:exclusiveinclusivelocation_based

sourcestringrequired

Allowed:requestrequest_defaultlocation_profile

amountIncludesTaxbooleanrequired

locationRefstring

quotedAtstring<date-time>

finalizedAtstring<date-time>

lineEvidenceTaxLineEvidence[]required

Show properties

Array of TaxLineEvidence

sourceLineIdstringrequired

classificationKeystringrequired

classificationLabelstringrequired

classificationVersionintegerrequired

classificationMappingVersionintegerrequired

taxableAmountintegerrequired

taxAmountintegerrequired

taxBehaviorTaxBehaviorrequired

Allowed:exclusiveinclusivelocation_based

amountIncludesTaxbooleanrequired

jurisdictionEvidenceTaxJurisdictionEvidence[]required

Show properties

Array of TaxJurisdictionEvidence

jurisdictionTypestringrequired

jurisdictionNamestringrequired

taxableAmountintegerrequired

taxAmountintegerrequired

ratenumberrequired

failureTaxFailure

Show properties

codestringrequired

Allowed:tax_company_mapping_missingtax_classification_missingtax_classification_inactivetax_classification_unmappedtax_location_profile_missingaddress_missingunsupported_jurisdictiontax_auth_failedtax_timeouttax_uncertaintax_service_error

messagestringrequired

nextActionstringrequired

Allowed:configure_tax_companyconfigure_tax_classificationconfigure_tax_location_profilecollect_customer_addressretry_quoteretry_finalizeretry_reversereconcile_tax_statenone

replayedbooleanrequired

requestIdstringrequired

400Bad request, including malformed JSON

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

401Missing or invalid API key

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

409Conflict, including idempotency body drift

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

422Validation failed

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

429API key rate limit exceeded

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

defaultError

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

Request

curl -X POST "https://api.vortex.nyc/v1/invoices/string/tax/quote?environment=string&merchantAccountId=string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "customerTaxAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "taxBehaviorPolicy": {
    "behavior": "exclusive",
    "locationRef": "string"
  },
  "requestedByRef": "string"
}'

const response = await fetch("https://api.vortex.nyc/v1/invoices/string/tax/quote?environment=string&merchantAccountId=string", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "customerTaxAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "taxBehaviorPolicy": {
    "behavior": "exclusive",
    "locationRef": "string"
  },
  "requestedByRef": "string"
})
});

import requests

response = requests.post(
    "https://api.vortex.nyc/v1/invoices/string/tax/quote?environment=string&merchantAccountId=string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "customerTaxAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "taxBehaviorPolicy": {
    "behavior": "exclusive",
    "locationRef": "string"
  },
  "requestedByRef": "string"
},
)

Response

{
  "data": {
    "tax": {
      "invoiceNumber": "string",
      "status": "not_required",
      "currency": "string",
      "subtotal": 0,
      "taxTotal": 0,
      "total": 0,
      "evidenceVersion": "string",
      "taxBehaviorPolicy": {
        "behavior": "exclusive",
        "source": "request",
        "amountIncludesTax": true,
        "locationRef": "string"
      },
      "quotedAt": "2024-01-01T00:00:00Z",
      "finalizedAt": "2024-01-01T00:00:00Z",
      "lineEvidence": [
        {
          "sourceLineId": "string",
          "classificationKey": "string",
          "classificationLabel": "string",
          "classificationVersion": 0,
          "classificationMappingVersion": 0,
          "taxableAmount": 0,
          "taxAmount": 0,
          "taxBehavior": "exclusive",
          "amountIncludesTax": true
        }
      ],
      "jurisdictionEvidence": [
        {
          "jurisdictionType": "string",
          "jurisdictionName": "string",
          "taxableAmount": 0,
          "taxAmount": 0,
          "rate": 0
        }
      ],
      "failure": {
        "code": "tax_company_mapping_missing",
        "message": "string",
        "nextAction": "configure_tax_company"
      }
    },
    "replayed": true
  },
  "requestId": "string"
}