Fix CertCapture API errors
This article applies to:CertCapture
CertCapture sends exemption certificate data to AvaTax via an API call. If there are issues with the customer or certificate data that prevent the API call from being sent, the CertCapture document History tab displays the error messages. Here are some common errors messages you may see, and the ways to resolve those errors.
Before you begin
To see a full list of unresolved API errors on all certificates, generate a Failed API Calls report.
CertCapture API error messages
This table lists the error messages you might see on a certificate History, as well as what they mean and what might have caused them.
Error message | What it means | How to fix it |
---|---|---|
Reason Code X is not exempt in region(s): XX. (Invalid ExemptReasonId and region combination) | The exemption reason is not valid for these regions. For multi-jurisdictional certificates, the exemption reason must be valid for all regions. |
|
Certificate exempt reason does not exist in AvaTaxCalcApi. | The exemption reason isn't available in AvaTax. | To change the exemption reason, go to the certificate Details tab and then select Edit to enter a new exemption reason. See the exempt reason matrix for the U.S. and Canada for a full list of exemption reasons. |
DocumentRefNo is required. (This value must be specified.) | The exemption certificate is a single-use certificate, but does not have a certificate PO number. | Go to the certificate Details tab and select Add PO Number. |
CustomerName is required. (This value must be specified.) | The Customer Name field is empty for at least one of the customers linked to the certificate. |
|
The certificate customer(customer number) does not contain an address. | The Address Line 1 field is empty for the customers listed here. | Go to the Details tab for each customer and then select Edit to enter the street address. |
Address1 length must be between 1 and 50 characters. | The Address Line 1 field is too long for at least one of the customers linked to the certificate. |
|
The Address Line 2 field is too long for at least one of the customers linked to the certificate. | The Address Line 2 field is too long for at least one of the customers linked to the certificate. |
|
The certificate customer(customer number) does not contain a city. | The City field is empty for the customers listed here. | Go to the Details tab for each customer and then select Edit to enter the city name. |
Region is required. (This value must be specified.) | The Region field is empty for a customer linked to the certificate. |
|
The certificate customer(customer number) does not contain a zip. | The ZIP field is empty for the customer numbers listed here. | Go to the Details tab for each customer and then select Edit to enter the ZIP code. |
The certificate customer(customer number) is not associated to a country. | The Country field is empty for the customer numbers listed here. | Go to the Details tab for each customer and then select Edit to enter the country name. |
Certificate record could not be found or did not meet send credentials. | Typically, this means the certificate's effective date is in the future. |
|
Error saving the Certificate, InvalidEndDate. (Error saving the certificate. This certificate has been applied to a transaction dated x/xx/20xx. The End Date cannot be set prior to that date.) | The certificate has already been applied to a transaction in AvaTax. For auditing purposes, the certificate expiration date cannot be changed to a date earlier than the transaction date. |
If you need to completely invalidate the certificate:
|
ExemptCertDetail.IdNo is required. | The certificate Tax ID field is empty. A Tax ID is required for exemption certificates in SST states. | Go to the certificate Details tab and then select Edit to enter a tax ID. |