Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchGetTaxExemptions

Get the active tax exemptions for a given list of accounts. The IAM action is tax:GetExemptions.

Request Syntax


POST /BatchGetTaxExemptions HTTP/1.1
Content-type: application/json

{
   "accountIds": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

accountIds

List of unique account identifiers.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Fixed length of 12.

Pattern: ^\d+$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "failedAccounts": [ "string" ],
   "taxExemptionDetailsMap": { 
      "string" : { 
         "heritageObtainedDetails": boolean,
         "heritageObtainedParentEntity": "string",
         "heritageObtainedReason": "string",
         "taxExemptions": [ 
            { 
               "authority": { 
                  "country": "string",
                  "state": "string"
               },
               "effectiveDate": number,
               "expirationDate": number,
               "status": "string",
               "systemEffectiveDate": number,
               "taxExemptionType": { 
                  "applicableJurisdictions": [ 
                     { 
                        "country": "string",
                        "state": "string"
                     }
                  ],
                  "description": "string",
                  "displayName": "string"
               }
            }
         ]
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

failedAccounts

The list of accounts that failed to get tax exemptions.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Fixed length of 12.

Pattern: ^\d+$

taxExemptionDetailsMap

The tax exemption details map of accountId and tax exemption details.

Type: String to TaxExemptionDetails object map

Key Length Constraints: Fixed length of 12.

Key Pattern: ^\d+$

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The exception thrown when an unexpected error occurs when processing a request.

HTTP Status Code: 500

ResourceNotFoundException

The exception thrown when the input doesn't have a resource associated to it.

HTTP Status Code: 404

ValidationException

The exception when the input doesn't pass validation for at least one of the input parameters.

HTTP Status Code: 400