<commit_before>---
title: Sales Tax Validation v3
layout: reference
redirect_from:
  - /api-reference/invoice/sales-tax-validation.html
---

* [Get Invoices for Calculating Tax](#get)
* [Update Invoices with the Calcuated Tax Amount and Tax Rate](#put)
* [Schema](#schema)
  * [Invoice](#invoice)
  * [Bill To Address](#billToAddress)
  * [Line Item](#lineItem)
  * [Allocation](#allocation)
  * [Vendor](#vendor)
  * [Ship To Address](#shipToAddress)
* [Status Schema](#schema-status)

## Version

3.0  

## <a name="get"></a>Get Invoices for Calculating Tax

    GET  /api/v3.0/invoice/salestaxvalidationrequest

### Parameters  

|Name | Type | Format | Description
|-----|------|--------|------------
|`offset`|`string`|`query`|The starting point of the next set of results, after the limit specified in the limit field has been reached.
|`limit`|`Int32`|`query`|The number of invoices to retrieve. Maximum value: 1000
|`modifiedafter`|`string`|`query`|A parameter that can be used to limit the results to invoices modified after the specified date.

### Input  

None.

### Response  

[Schema](#schema)

## <a name="put"></a>Update Invoices with a Calculated Tax Amount and Tax Rate  

    PUT  /api/v3.0/invoice/salestaxvalidationrequest

### Parameters  

|Name | Type | Format | Description
|-----|------|--------|------------
|`invoice`|-|`body`|The tax information for the invoice that is to be updated.

### Input  

[Invoice](#invoice)

### Response

[Status schema](#schema-status)

## <a name="schema"></a>Invoices Schema

### Invoices

| Name | Type | Format | Description|
|-----|------|--------|------------|
| `Items`|`array`|`Invoice`|The result collection.|
| `NextPage`|`string`|-|The URI of the next page of results, if any.|
| `TotalCount`|`Int32`|-|

### <a name="invoice"></a>Invoice

|Name | Type | Format | Description
|-----|------|--------|------------
|`BillToAddress`|`object`|[`BillToAddress`](#billToAddress)|
|`CalculatedTaxAmount`|`string`|-|The calculated tax amount for the invoice.
|`CalculatedTaxRate`|`string`|-|The calculated tax rate for the invoice.
|`Comments`|`string`|-|Comments for the invoice.
|`CountryCode`|`string`|-|The country code for the line item.
|`CurrencyCode`|`string`|-|The 3-letter ISO 4217 currency code for the invoice currency. For example, USD or CAD.
|`ID`|`string`|-|The unique identifier of the resource.
|`InvoiceAmount`|`string`|-|The invoice amount (the cost of the purchased items).
|`InvoiceDate`|`string`|-|The invoice date.
|`LineItem`|`array`|[`LineItem`](#LineItem)|The line items associated with the invoice.
|`OrgUnit1`|`string`|-|The code that is applied to the first custom field if the custom field is in a list.
|`OrgUnit1Value`|`string`|-|The value of the first custom field.
|`OrgUnit2`|`string`|-|The code that is applied to the second custom field if the custom field is in a list.
|`OrgUnit2Value`|`string`|-|The value of the second custom field.
|`OrgUnit3`|`string`|-|The code that is applied to the third custom field if the custom field is in a list.
|`OrgUnit3Value`|`string`|-|The value of the third custom field.
|`OrgUnit4`|`string`|-|The code that is applied to a the fourth custom field if the custom field is in a list.
|`OrgUnit4Value`|`string`|-|The value of the fourth custom field.
|`OrgUnit5`|`string`|-|The code that is applied to the fifth custom field if the custom field is in a list.
|`OrgUnit5Value`|`string`|-|The value of the fifth custom field.
|`OrgUnit6`|`string`|-|The code that is applied to the sixth custom field if the custom field is in a list.
|`OrgUnit6Value`|`string`|-|The value of the sixth custom field.
|`PurchaseOrderNumber`|`string`|-|The Purchase Order number (if available) associated to the Payment Request.
|`ShippingAmount`|`string`|-|The shipping amount for the invoice.
|`ShipToAddress`|`object`|[`ShipToAddress`](#ShipToAddress)|
|`Status`|`string`|-|The status of the invoice.
|`StatusCode`|`string`|-| **Required** The status code for the invoice. Supported values: `ERROR`, `CMPLT`
|`Tax`|`string`|-|The tax as shown on the invoice. This is the tax applied by the vendor.
|`TaxReferenceID`|`string`|-|**Required** The tax reference ID of the invoice.
|`Title`|`string`|-|The title of the invoice.
|`Total`|`string`|-|The total amount of the request.
|`URI`|`string`|-|The URI to the resource.
|`VendorInvoiceNumber`|`string`|-|The vendor invoice number that is associated with the invoice.

### <a name="billToAddress"></a>BillToAddress  

|Name | Type | Format | Description
|-----|------|--------|------------
|`Address1`|`string`|-|**Required** Address line 1 of the shipping or billing address.
|`Address2`|`string`|-|Address line 2 of the shipping or billing address.
|`Address3`|`string`|-|Address line 3 of the shipping or billing address.
|`City`|`string`|-|**Required** The city of the shipping or billing address.
|`CountryCode`|`string`|-|**Required** The code of the country for the shipping or billing address.
|`ExternalID`|`string`|-|**Required** A unique value supplied by the customer to identify a particular shipping or billing address.
|`Name`|`string`|-|An optional name that can be given to the shipping or billing address.
|`PostalCode`|`string`|-|**Required** The postal code of the shipping or billing address.
|`State`|`string`|-|**Required** The state or province of the shipping or billing address.
|`StateProvince`|`string`|-|**Required** The state or province of the shipping or billing address.

### <a name="lineItem"></a>LineItem  

|Name | Type | Format | Description
|-----|------|--------|------------
|`Allocations`|[`Allocation`](#allocation)|-|The allocations associated with a line item.
|`CalculatedTaxAmount`|`string`|-|The calculated tax amount for the individual line item.
|`CalculatedTaxRate`|`string`|-|The calculated tax rate for the individual line item.
|`CommodityCode`|`string`|-|The commodity code that is tied to the expense type associated with the line item.
|`CountryCode`|`string`|-|The country code for the line item.
|`CurrencyCode`|`string`|-|The currency code for the individual line item.
|`LineItemKey`|`string`|-|**Required** A value that uniquely identifies the line item.
|`Quantity`|`string`|-|The quantity for the line item.
|`Total`|`string`|-|The total amount for the line item.
|`UnitPrice`|`string`|-|The unit price for the line item.
|`Vendor`|`object`|[`InvoiceVendor`](#Vendor)|Details about the vendor for each line item.

### <a name="allocation"></a>Allocation  

|Name | Type | Format | Description
|-----|------|--------|------------
|`AllocationAmount`|`string`|-|The allocation amount associated with the line item.
|`Custom1`|`string`|-|The code that is applied to custom field 1 if the custom field is in a list.
|`Custom10`|`string`|-|The code that is applied to custom field 10 if the custom field is in a list.
|`Custom10Value`|`string`|-|The value that is applied to custom field 10.
|`Custom11`|`string`|-|The code that is applied to custom field 11 if the custom field is in a list.
|`Custom11Value`|`string`|-|The value that is applied to custom field 11.
|`Custom12`|`string`|-|The code that is applied to custom field 12 if the custom field is in a list.
|`Custom12Value`|`string`|-|The value that is applied to custom field 12.
|`Custom13`|`string`|-|The code that is applied to custom field 13 if the custom field is in a list.
|`Custom13Value`|`string`|-|The value that is applied to custom field 13.
|`Custom14`|`string`|-|The code that is applied to custom field 14 if the custom field is in a list.
|`Custom14Value`|`string`|-|The value that is applied to custom field 14.
|`Custom15`|`string`|-|The code that is applied to custom field 15 if the custom field is in a list.
|`Custom15Value`|`string`|-|The value that is applied to custom field 15.
|`Custom16`|`string`|-|The code that is applied to custom field 16 if the custom field is in a list.
|`Custom16Value`|`string`|-|The value that is applied to custom field 16.
|`Custom17`|`string`|-|The code that is applied to custom field 17 if the custom field is in a list.
|`Custom17Value`|`string`|-|The value that is applied to custom field 17.
|`Custom18`|`string`|-|The code that is applied to custom field 18 if the custom field is in a list.
|`Custom18Value`|`string`|-|The value that is applied to custom field 18.
|`Custom19`|`string`|-|The code that is applied to custom field 19 if the custom field is in a list.
|`Custom19Value`|`string`|-|The value that is applied to custom field 19.
|`Custom1Value`|`string`|-|The value that is applied to custom field 1.
|`Custom2`|`string`|-|The code that is applied to custom field 2 if the custom field is in a list.
|`Custom20`|`string`|-|The code that is applied to custom field 20 if the custom field is in a list.
|`Custom20Value`|`string`|-|The value that is applied to custom field 20.
|`Custom2Value`|`string`|-|The value that is applied to custom field 2.
|`Custom3`|`string`|-|The code that is applied to custom field 3 if the custom field is in a list.
|`Custom3Value`|`string`|-|The value that is applied to custom field 3.
|`Custom4`|`string`|-|The code that is applied to custom field 4 if the custom field is in a list.
|`Custom4Value`|`string`|-|The value that is applied to custom field 4.
|`Custom5`|`string`|-|The code that is applied to custom field 5 if the custom field is in a list.
|`Custom5Value`|`string`|-|The value that is applied to custom field 5.
|`Custom6`|`string`|-|The code that is applied to custom field 6 if the custom field is in a list.
|`Custom6Value`|`string`|-|The value that is applied to custom field 6.
|`Custom7`|`string`|-|The code that is applied to custom field 7 if the custom field is in a list.
|`Custom7Value`|`string`|-|The value that is applied to custom field 7.
|`Custom8`|`string`|-|The code that is applied to custom field 8 if the custom field is in a list.
|`Custom8Value`|`string`|-|The value that is applied to custom field 8.
|`Custom9`|`string`|-|The code that is applied to custom field 9 if the custom field is in a list.
|`Custom9Value`|`string`|-|The value that is applied to custom field 9.

### <a name="vendor"></a>Vendor  

|Name | Type | Format | Description
|-----|------|--------|------------
|`Address1`|`string`|-|**Required** The Vendor Address 1.
|`Address2`|`string`|-|The Vendor Address 2.
|`Address3`|`string`|-|The Vendor Address 3.
|`City`|`string`|-|**Required** The Vendor City.
|`CountryCode`|`string`|-|**Required** The Vendor Country Code.
|`PostalCode`|`string`|-|**Required** The Vendor Postal Code / Zip.
|`State`|`string`|-|**Required** The Vendor State.
|`VendorAddressName`|`string`|-|**Required** Name for Vendor Address.
|`VendorName`|`string`|-|**Required** The name of the vendor.

### <a name="shipToAddress"></a>ShipToAddress  

|Name | Type | Format | Description
|-----|------|--------|------------
|`Address1`|`string`|-|**Required** Address line 1 of the shipping or billing address.
|`Address2`|`string`|-|Address line 2 of the shipping or billing address.
|`Address3`|`string`|-|Address line 3 of the shipping or billing address.
|`City`|`string`|-|**Required** The city of the shipping or billing address.
|`CountryCode`|`string`|-|**Required** The code of the country for the shipping or billing address.
|`ExternalID`|`string`|-|**Required** A unique value supplied by the customer to identify a particular shipping or billing address.
|`Name`|`string`|-|An optional name that can be given to the shipping or billing address.
|`PostalCode`|`string`|-|**Required** The postal code of the shipping or billing address.
|`State`|`string`|-|**Required** The state or province of the shipping or billing address.
|`StateProvince`|`string`|-|**Required** The state or province of the shipping or billing address.
<commit_msg>Updates Sales Tax Validation with condensed schemas<commit_after>---
title: Sales Tax Validation v3
layout: reference
redirect_from:
  - /api-reference/invoice/sales-tax-validation.html
---

* [Get Invoices for Calculating Tax](#get)
* [Update Invoices with the Calcuated Tax Amount and Tax Rate](#put)
* [Schema](#schema)
  * [Invoice](#invoice)
  * [Bill To Address](#billToAddress)
  * [Line Item](#lineItem)
  * [Allocation](#allocation)
  * [Vendor](#vendor)
  * [Ship To Address](#shipToAddress)
* [Status Schema](#schema-status)

## Version

3.0  

## <a name="get"></a>Get Invoices for Calculating Tax

    GET  /api/v3.0/invoice/salestaxvalidationrequest

### Parameters  

|Name | Type | Format | Description
|-----|------|--------|------------
|`offset`|`string`|`query`|The starting point of the next set of results, after the limit specified in the limit field has been reached.
|`limit`|`Int32`|`query`|The number of invoices to retrieve. Maximum value: 1000
|`modifiedafter`|`string`|`query`|A parameter that can be used to limit the results to invoices modified after the specified date.

### Input  

None.

### Response  

[Schema](#schema)

## <a name="put"></a>Update Invoices with a Calculated Tax Amount and Tax Rate  

    PUT  /api/v3.0/invoice/salestaxvalidationrequest

### Parameters  

|Name | Type | Format | Description
|-----|------|--------|------------
|`invoice`|-|`body`|The tax information for the invoice that is to be updated.

### Input  

[Invoice](#invoice)

### Response

[Status schema](#schema-status)

## <a name="schema"></a>Invoices Schema

### Invoices

| Name | Type | Format | Description|
|-----|------|--------|------------|
| `Items`|`array`|`Invoice`|The result collection.|
| `NextPage`|`string`|-|The URI of the next page of results, if any.|
| `TotalCount`|`Int32`|-|

### <a name="invoice"></a>Invoice

|Name | Type | Format | Description
|-----|------|--------|------------
|`BillToAddress`|`object`|[`BillToAddress`](#billToAddress)|
|`CalculatedTaxAmount`|`string`|-|The calculated tax amount for the invoice.
|`CalculatedTaxRate`|`string`|-|The calculated tax rate for the invoice.
|`Comments`|`string`|-|Comments for the invoice.
|`CountryCode`|`string`|-|The country code for the line item.
|`CurrencyCode`|`string`|-|The 3-letter ISO 4217 currency code for the invoice currency. For example, USD or CAD.
|`ID`|`string`|-|The unique identifier of the resource.
|`InvoiceAmount`|`string`|-|The invoice amount (the cost of the purchased items).
|`InvoiceDate`|`string`|-|The invoice date.
|`LineItem`|`array`|[`LineItem`](#LineItem)|The line items associated with the invoice.
|`OrgUnit1 through OrgUnit6`|`string`|-|The code from the Custom fields. These fields may not have data, depending on the configuration.
|`OrgUnit1Value though OrgUnit6Value`|`string`|-|The value from the Custom fields. These fields may not have data, depending on the configuration.
|`PurchaseOrderNumber`|`string`|-|The Purchase Order number (if available) associated to the Payment Request.
|`ShippingAmount`|`string`|-|The shipping amount for the invoice.
|`ShipToAddress`|`object`|[`ShipToAddress`](#ShipToAddress)|
|`Status`|`string`|-|The status of the invoice.
|`StatusCode`|`string`|-| **Required** The status code for the invoice. Supported values: `ERROR`, `CMPLT`
|`Tax`|`string`|-|The tax as shown on the invoice. This is the tax applied by the vendor.
|`TaxReferenceID`|`string`|-|**Required** The tax reference ID of the invoice.
|`Title`|`string`|-|The title of the invoice.
|`Total`|`string`|-|The total amount of the request.
|`URI`|`string`|-|The URI to the resource.
|`VendorInvoiceNumber`|`string`|-|The vendor invoice number that is associated with the invoice.

### <a name="billToAddress"></a>BillToAddress  

|Name | Type | Format | Description
|-----|------|--------|------------
|`Address1`|`string`|-|**Required** Address line 1 of the shipping or billing address.
|`Address2`|`string`|-|Address line 2 of the shipping or billing address.
|`Address3`|`string`|-|Address line 3 of the shipping or billing address.
|`City`|`string`|-|**Required** The city of the shipping or billing address.
|`CountryCode`|`string`|-|**Required** The code of the country for the shipping or billing address.
|`ExternalID`|`string`|-|**Required** A unique value supplied by the customer to identify a particular shipping or billing address.
|`Name`|`string`|-|An optional name that can be given to the shipping or billing address.
|`PostalCode`|`string`|-|**Required** The postal code of the shipping or billing address.
|`State`|`string`|-|**Required** The state or province of the shipping or billing address.
|`StateProvince`|`string`|-|**Required** The state or province of the shipping or billing address.

### <a name="lineItem"></a>LineItem  

|Name | Type | Format | Description
|-----|------|--------|------------
|`Allocations`|[`Allocation`](#allocation)|-|The allocations associated with a line item.
|`CalculatedTaxAmount`|`string`|-|The calculated tax amount for the individual line item.
|`CalculatedTaxRate`|`string`|-|The calculated tax rate for the individual line item.
|`CommodityCode`|`string`|-|The commodity code that is tied to the expense type associated with the line item.
|`CountryCode`|`string`|-|The country code for the line item.
|`CurrencyCode`|`string`|-|The currency code for the individual line item.
|`LineItemKey`|`string`|-|**Required** A value that uniquely identifies the line item.
|`Quantity`|`string`|-|The quantity for the line item.
|`Total`|`string`|-|The total amount for the line item.
|`UnitPrice`|`string`|-|The unit price for the line item.
|`Vendor`|`object`|[`InvoiceVendor`](#Vendor)|Details about the vendor for each line item.

### <a name="allocation"></a>Allocation  

|Name | Type | Format | Description
|-----|------|--------|------------
|`AllocationAmount`|`string`|-|The allocation amount associated with the line item.
|`Custom1 through Custom20`|`string`|-|The code from the Custom fields. These fields may not have data, depending on the configuration.
|`Custom1Value through Custom20Value`|`string`|-|The value from the Custom fields. These fields may not have data, depending on the configuration.

### <a name="vendor"></a>Vendor  

|Name | Type | Format | Description
|-----|------|--------|------------
|`Address1`|`string`|-|**Required** The Vendor Address 1.
|`Address2`|`string`|-|The Vendor Address 2.
|`Address3`|`string`|-|The Vendor Address 3.
|`City`|`string`|-|**Required** The Vendor City.
|`CountryCode`|`string`|-|**Required** The Vendor Country Code.
|`PostalCode`|`string`|-|**Required** The Vendor Postal Code / Zip.
|`State`|`string`|-|**Required** The Vendor State.
|`VendorAddressName`|`string`|-|**Required** Name for Vendor Address.
|`VendorName`|`string`|-|**Required** The name of the vendor.

### <a name="shipToAddress"></a>ShipToAddress  

|Name | Type | Format | Description
|-----|------|--------|------------
|`Address1`|`string`|-|**Required** Address line 1 of the shipping or billing address.
|`Address2`|`string`|-|Address line 2 of the shipping or billing address.
|`Address3`|`string`|-|Address line 3 of the shipping or billing address.
|`City`|`string`|-|**Required** The city of the shipping or billing address.
|`CountryCode`|`string`|-|**Required** The code of the country for the shipping or billing address.
|`ExternalID`|`string`|-|**Required** A unique value supplied by the customer to identify a particular shipping or billing address.
|`Name`|`string`|-|An optional name that can be given to the shipping or billing address.
|`PostalCode`|`string`|-|**Required** The postal code of the shipping or billing address.
|`State`|`string`|-|**Required** The state or province of the shipping or billing address.
|`StateProvince`|`string`|-|**Required** The state or province of the shipping or billing address.

{'fraction_non_alphanumeric': 0.17317383558157293, 'fraction_numerical': 0.011300585390684653, 'mean_word_length': 4.642159678345778, 'pattern_counts': {'":': 0, '<': 39, '<?xml version=': 0, '>': 39, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2273395', 'n_tokens_mistral': 6480, 'n_tokens_neox': 5989, 'n_words': 2167}