Develop with the Sales Tax API

The Sales Tax API provides sales tax calculation in the context of a given transaction, accounting for different types of rates (flat, percentage based) as well as modes (inclusive vs. exclusive). This enables you to get the tax codes and rates upfront and automatically recommend taxes for the US region.

How to calculate sales tax

To calculate sales tax, use the indirectTaxCalculateSaleTransactionTax (mutation). For details, see indirectTaxCalculateSaleTransactionTax (mutation) in the API Explorer.

Request

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
  mutation CalculateTax {
      indirectTaxCalculateSaleTransactionTax(
          input: {
              transactionDate: "2024-05-15"
              subject: {
                  qbCustomerId: "1"
              }
              shipping: {
                  shipFromAddress:
                  {
                      freeFormAddressLine: "2700 Coast Ave CA, US  94043",
                  },
                  shipToAddress:
                  {
                      freeFormAddressLine: "2700 Coast Ave CA, US  94043",
                  },
                  shippingFee: {
                      value: 10.99
                  }
              },
              lineItems: [
                  {
                      numberOfUnits:1,
                      pricePerUnitExcludingTaxes: {
                          value: 100
                      }
                      productVariantTaxability: {
                          productVariantId: <product_id>
                      }
                  },
              ]
          }
          ) {
              ... on IndirectTax_TaxCalculationPayload {
                  taxCalculation {
                      transactionDate
                      shipping {
                          shipFromAddress {
                                  streetAddressLine1
                          }
                          shipToAddress {
                              streetAddressLine1
                          }
                          shippingFee {
                              value
                          }
                      taxAmount {
                          value
                      }
                  }
                  lineItems {
                      nodes {
                          numberOfUnits
                          totalPriceExcludingTaxes {
                              value
                          }
                          productVariantTaxability {
                              classificationCode
                          }
                          taxAmount {
                              value
                          }
                          taxDetails {
                              taxAmount {
                                  value
                              }
                              taxableAmount {
                                  value
                              }
                              taxRate {
                                  name
                                  taxRate {
                                      taxRateReferenceId
                                  }
                              }
                          }
                      }
                  }
                  taxTotals {
                      totalTaxAmountExcludingShipping {
                          value
                      }
                      aggregatedTaxesExcludingShippingByRate {
                          taxableAmount {
                              value
                          }
                          taxAmount {
                              value
                          }
                          ratePercentageApplied {
                              ...on IndirectTax_RatePercentage {
                                  rate
                              }
                          }
                          taxRate {
                              name
                              taxRate {
                                  taxRateReferenceId
                              }
                          }
                      }
                  }
              }
          }
      }
  }
Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 {
  "data": {
    "indirectTaxCalculateSaleTransactionTax": {
      "taxCalculation": {
          "id": "0",
          "subject": {
              "customer": {
                  "id": "1"
              }
                  "taxExemption": "NOT_EXEMPT"
          },
          "transactionDate": "2024-05-15",
          "shipping": {
              "shipFromAddress": {
                  "streetAddressLine1": "2700 Coast Ave CA, US  94043"
              },
              "shipToAddress": {
                  "streetAddressLine1": "2700 Coast Ave CA, US  94043"
              },
              "shippingFee": {
                  "value": 10.99
              },
              "taxAmount": {
                  "value": 0.00
              }
          },
          "lineItems": {
              "nodes": [
                  {
                      "numberOfUnits": 1,
                      "totalPriceExcludingTaxes": {
                          "value": 100.00
                      },
                      "productVariantTaxability": {
                          "classificationCode": "EUC-09020802-V1-00120000"
                      },
                      "taxAmount": {
                          "value": 9.12
                      },
                      "taxDetails": [
                          {
                              "taxAmount": {
                                  "value": 6.24
                              },
                              "taxableAmount": {
                                  "value": 100.00
                              },
                              "taxExemptAmount": {
                                  "value": 0
                              },
                              "ratePercentageApplied": {
                                  "rate": 6.25
                              },
                              "taxRate": {
                                  "name": "California State",
                                  "taxRate": {
                                      "taxRateReferenceId": "-1"
                                  }
                              }
                          },
                          {
                              "taxAmount": {
                                  "value": 1.00
                              },
                              "taxableAmount": {
                                  "value": 100.00
                              },
                              "ratePercentageApplied": {
                                  "rate": 1
                              },
                              "taxRate": {
                                  "name": "California, Santa Clara County",
                                  "taxRate": {
                                      "taxRateReferenceId": "-1"
                                  }
                              }
                          },
                          {
                              "taxAmount": {
                                  "value": 1.88
                              },
                              "taxableAmount": {
                                  "value": 100.00
                              },
                              "taxExemptAmount": {
                                  "value": 0
                              },
                              "ratePercentageApplied": {
                                  "rate": 1.875
                              },
                              "taxRate": {
                                  "name": "California, Santa Clara County District",
                                  "taxRate": {
                                      "taxRateReferenceId": "-1"
                                  }
                              }
                          }
                      ]
                  }
                  }
              ]
          },
          "taxTotals": {
              "totalTaxAmountExcludingShipping": {
                  "value": 18.25
              },
              "aggregatedTaxesExcludingShippingByRate": [
                  {
                      "taxableAmount": {
                          "value": 200.00
                      },
                      "taxAmount": {
                          "value": 12.49
                      },
                      "ratePercentageApplied": {
                          "rate": 6.25
                      },
                      "taxRate": {
                          "name": "California State",
                          "taxRate": {
                              "taxRateReferenceId": "-1"
                          }
                      }
                  },
                  {
                      "taxableAmount": {
                          "value": 200.00
                      },
                      "taxAmount": {
                          "value": 2.00
                      },
                      "ratePercentageApplied": {
                          "rate": 1
                      },
                      "taxRate": {
                          "name": "California, Santa Clara County",
                          "taxRate": {
                              "taxRateReferenceId": "-1"
                          }
                      }
                  },
                  {
                      "taxableAmount": {
                          "value": 200.00
                      },
                      "taxAmount": {
                          "value": 3.76
                      },
                      "ratePercentageApplied": {
                          "rate": 1.875
                      },
                      "taxRate": {
                          "name": "California, Santa Clara County District",
                          "taxRate": {
                              "taxRateReferenceId": "-1"
                          }
                      }
                  },
                  {
                      "taxableAmount": {
                          "value": 0.00
                      },
                      "taxAmount": {
                          "value": 0.00
                      },
                      "ratePercentageApplied": {
                          "rate": 6.25
                      },
                      "taxRate": {
                          "name": "California State",
                          "taxRate": {
                              "taxRateReferenceId": "-1"
                          }
                      }
                  },
                  {
                      "taxableAmount": {
                          "value": 0.00
                      },
                      "taxAmount": {
                          "value": 0.00
                      },
                      "ratePercentageApplied": {
                          "rate": 1
                      },
                      "taxRate": {
                          "name": "California, Santa Clara County",
                          "taxRate": {
                              "taxRateReferenceId": "-1"
                          }
                      }
                  },
                  {
                      "taxableAmount": {
                          "value": 0.00
                      },
                      "taxAmount": {
                          "value": 0.00
                      },
                      "ratePercentageApplied": {
                          "rate": 1.875
                      },
                      "taxRate": {
                          "name": "California, Santa Clara County District",
                          "taxRate": {
                              "taxRateReferenceId": "-1"
                          }
                      }
                  }
              ]
           }
        }
      }
    }
  }
Test with Postman

To test your app, use Postman. Fork our official collection specifically for the Sales Tax API here. For more information, see Set up and test queries in Postman.