On This Page
FILTER BY TAG

International Tax and VAT Committed Tax Calculation

Use a committed tax calculation to include the owed tax amount with a capture.
To commit a tax calculation, include the
taxInformation.commitIndicator
 field set to
true
 in a tax calculation request.

Endpoint

POST
https://api.cybersource.com
/vas/v2/tax

Required Fields for an International Tax and VAT Committed Tax Calculation Using the
REST
 API

Use these fields to perform a committed tax request.
merchantInformation.vatRegistrationNumber
orderInformation.amountDetails.currency
orderInformation.billTo.country
orderInformation.lineItems.unitPrice
taxInformation.showTaxPerLineItem. commitIndicator
Set to
true
.

Optional Fields for an International Tax and VAT Committed Tax Calculation Using the
REST
 API

Use these fields to perform a committed tax request.
buyerInformation.vatRegistrationNumber
clientReferenceInformation.code
clientReferenceInformation.partner.developerId
clientReferenceInformation.partner.solutionId
orderInformation.billTo.address1
orderInformation.billTo.address2
orderInformation.billTo.administrativeArea
orderInformation.billTo.locality
orderInformation.billTo.postalCode
orderInformation.invoiceDetails.invoiceDate
orderInformation.lineItems.buyerVatRegistrationNumber
orderInformation.lineItems.orderAcceptance.administrativeArea
orderInformation.lineItems.orderAcceptance.country
orderInformation.lineItems.orderAcceptance.locality
orderInformation.lineItems.orderAcceptance.postalCode
orderInformation.lineItems.orderOrigin.administrativeArea
orderInformation.lineItems.orderOrigin.country
orderInformation.lineItems.orderOrigin.locality
orderInformation.lineItems.orderOrigin.postalCode
orderInformation.lineItems.productCode
orderInformation.lineItems.productName
orderInformation.lineItems.productSku
orderInformation.lineItems.quantity
orderInformation.lineItems.sellerVatRegistrationNumber
orderInformation.lineItems.shipFromAdministrativeArea
orderInformation.lineItems.shipFromCountry
orderInformation.lineItems.shipFromLocality
orderInformation.lineItems.shipFromPostalCode
orderInformation.lineItems.taxAmount
orderInformation.orderAcceptance.administrativeArea
orderInformation.orderAcceptance.country
orderInformation.orderAcceptance.locality
orderInformation.orderAcceptance.postalCode
orderInformation.orderOrigin.administrativeArea
orderInformation.orderOrigin.country
orderInformation.orderOrigin.locality
orderInformation.orderOrigin.postalCode
orderInformation.shippingDetails.shipFromAdministrativeArea
orderInformation.shippingDetails.shipFromCountry
orderInformation.shippingDetails.shipFromLocality
orderInformation.shippingDetails.shipFromPostalCode
orderInformation.shipTo.address1
orderInformation.shipTo.address2
orderInformation.shipTo.address3
orderInformation.shipTo.administrativeArea
orderInformation.shipTo.country
orderInformation.shipTo.locality
orderInformation.shipTo.postalCode
taxInformation.commitIndicator
Set field to
true
 to commit tax calculation.
taxInformation.dateOverrideReason
taxInformation.nexus
If you include this field, do not include the
taxInformation.noNexus
 field.
taxInformation.noNexus
If you include this field, do not include the
taxInformation.nexus
 field.
taxInformation.refundIndicator
taxInformation.reportingDate
taxInformation.showTaxPerLineItem

Example: Processing an International Tax and VAT Committed Tax Calculation Using the REST API

Request
{
  "clientReferenceInformation": {
    "code": "TAX_TC001"
  },
  "taxInformation": {
    "showTaxPerLineItem": "Yes",
    "commitIndicator": true
  },
  "orderInformation": {
    "amountDetails": {
      "currency": "USD"
    },
    "billTo": {
      "locality": "San Francisco",
      "administrativeArea": "CA",
      "postalCode": 94105,
      "country": "US"
    },
    "lineItems": [
      {
        "unitPrice": 1200
      }
    ]
  }
}
Response
{
  "_links": {
    "void": {
      "method": "PATCH",
      "href": "/vas/v2/tax/6632667159226346003954"
    }
  },
  "clientReferenceInformation": {
    "code": "TAX_TC001"
  },
  "id": "6632667159226346003954",
  "orderInformation": {
    "lineItems": [
      {
        "taxableAmount": "1200.00",
        "taxDetails": [
          {
            "amount": "0.00",
            "type": "city"
          },
          {
            "amount": "28.50",
            "type": "special"
          },
          {
            "amount": "72.00",
            "type": "state"
          },
          {
            "amount": "3.00",
            "type": "county"
          },
          {
            "amount": "0.00",
            "type": "national"
          }
        ],
        "jurisdiction": [
          {
            "country": "US",
            "code": "06",
            "taxable": "1200.00",
            "rate": "0.060000",
            "name": "CALIFORNIA",
            "type": "State",
            "region": "CA",
            "taxAmount": "72.00",
            "taxName": "CA STATE TAX"
          },
          {
            "country": "US",
            "code": "075",
            "taxable": "1200.00",
            "rate": "0.002500",
            "name": "SAN FRANCISCO",
            "type": "County",
            "region": "CA",
            "taxAmount": "3.00",
            "taxName": "CA COUNTY TAX"
          },
          {
            "country": "US",
            "code": "EMBE0",
            "taxable": "1200.00",
            "rate": "0.013750",
            "name": "SAN FRANCISCO COUNTY DISTRICT TAX SP",
            "type": "Special",
            "region": "CA",
            "taxAmount": "16.50",
            "taxName": "CA SPECIAL TAX"
          },
          {
            "country": "US",
            "code": "EMTV0",
            "taxable": "1200.00",
            "rate": "0.010000",
            "name": "SAN FRANCISCO CO LOCAL TAX SL",
            "type": "Special",
            "region": "CA",
            "taxAmount": "12.00",
            "taxName": "CA SPECIAL TAX"
          }
        ],
        "exemptAmount": "0.00",
        "taxAmount": "103.50"
      }
    ],
    "taxableAmount": "1200.00",
    "taxDetails": [
      {
        "amount": "28.50",
        "type": "special"
      },
      {
        "amount": "72.00",
        "type": "state"
      },
      {
        "amount": "0.00",
        "type": "national"
      },
      {
        "amount": "3.00",
        "type": "county"
      },
      {
        "amount": "0.00",
        "type": "city"
      }
    ],
    "exemptAmount": "0.00",
    "taxAmount": "103.50",
    "amountDetails": {
      "totalAmount": "1303.50",
      "currency": "USD"
    }
  },
  "status": "COMPLETED",
  "submitTimeUtc": "2022-09-15T18:31:57Z",
  "taxInformation": {
    "commitIndicator": "true",
    "refundIndicator": "false"
  }
}
RELATED TO THIS PAGE