TRtrykintsugi
Exemptions

Get exemption by id

Changed on

The Get Exemption By ID API retrieves a specific exemption record by its unique ID. This API is useful for retrieving detailed information about a particular exemption, including its associated customer, organisation id, status, etc.

get/v1/exemptions/{exemption_id}

Request

  • Base URL
    https://api.trykintsugi.com
  • URL
    https://api.trykintsugi.com/v1/exemptions/{exemption_id}
  • Auth
    API key in header X-API-KEY

Path parameters

exemption_idstring required

The unique identifier for the exemption being retrieved.

Headers

x-organization-idstring nullable required

The unique identifier for the organization making the request

Response

Successfully retrieved exemption by id

exemption_type'customer' | 'wholesale' | 'transaction' | 'reverse_charge' | 'partial' required
jurisdictionstring nullable

The jurisdiction identifier for the exemption

country_code'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'CI' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'XK' | 'ZZ_EU'
start_datestring date required

Start date for the exemption validity period (YYYY-MM-DD format)

end_datestring date nullable

End date for the exemption validity period (YYYY-MM-DD format)

customer_idstring nullable

Unique identifier for the customer associated with the exemption

transaction_idstring nullable

Unique identifier for the transaction associated with the exemption, if applicable.

resellerboolean

Indicates whether the exemption is for a reseller

FEINstring nullable

Federal Employer Identification Number associated with the exemption.

sales_tax_idstring nullable

Sales tax ID for the exemption

status'ACTIVE' | 'INACTIVE' | 'EXPIRED' | 'DEACTIVATED' | 'ARCHIVED'
idstring required
customer_namestring nullable
attachment_idstring nullable
certificate_typestring nullable

Changes

  • 0ce064e1bf38Revision changes
    • warning

      added the new partial enum value to the response property for the response status

    • info

      added the optional property to the response with the status

  • 6ba4f4c774c3Revision changes
    • breaking

      added the new required header request parameter x-organization-id

    • breaking

      response property FEIN list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property attachment_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property customer_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property customer_name list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property end_date list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property jurisdiction list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property sales_tax_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property transaction_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • warning

      added the new reverse_charge enum value to the response property for the response status

    • info

      the endpoint scheme security APIKeyHeader was added to the API

    • info

      the endpoint scheme security APIKeyHeader AND CustomHeader was removed from the API

    • info

      added subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #2 to the response property anyOf list for the response status

    • info

      removed the ACTIVE enum value from the response property for the response status

    • info

      removed the AD enum value from the response property for the response status

    • info

      removed the AE enum value from the response property for the response status

    • info

      removed the AF enum value from the response property for the response status

    • info

      removed the AG enum value from the response property for the response status

    • info

      removed the AI enum value from the response property for the response status

    • info

      removed the AL enum value from the response property for the response status

    • info

      removed the AM enum value from the response property for the response status

    • info

      removed the AO enum value from the response property for the response status

    • info

      removed the AQ enum value from the response property for the response status

    • info

      removed the AR enum value from the response property for the response status

    • info

      removed the ARCHIVED enum value from the response property for the response status

    • info

      removed the AS enum value from the response property for the response status

    • info

      removed the AT enum value from the response property for the response status

    • info

      removed the AU enum value from the response property for the response status

    • info

      removed the AW enum value from the response property for the response status

    • info

      removed the AX enum value from the response property for the response status

    • info

      removed the AZ enum value from the response property for the response status

    • info

      removed the BA enum value from the response property for the response status

    • info

      removed the BB enum value from the response property for the response status

    • info

      removed the BD enum value from the response property for the response status

    • info

      removed the BE enum value from the response property for the response status

    • info

      removed the BF enum value from the response property for the response status

    • info

      removed the BG enum value from the response property for the response status

    • info

      removed the BH enum value from the response property for the response status

    • info

      removed the BI enum value from the response property for the response status

    • info

      removed the BJ enum value from the response property for the response status

    • info

      removed the BL enum value from the response property for the response status

    • info

      removed the BM enum value from the response property for the response status

    • info

      removed the BN enum value from the response property for the response status

    • info

      removed the BO enum value from the response property for the response status

    • info

      removed the BQ enum value from the response property for the response status

    • info

      removed the BR enum value from the response property for the response status

    • info

      removed the BS enum value from the response property for the response status

    • info

      removed the BT enum value from the response property for the response status

    • info

      removed the BV enum value from the response property for the response status

    • info

      removed the BW enum value from the response property for the response status

    • info

      removed the BY enum value from the response property for the response status

    • info

      removed the BZ enum value from the response property for the response status

    • info

      removed the CA enum value from the response property for the response status

    • info

      removed the CC enum value from the response property for the response status

    • info

      removed the CD enum value from the response property for the response status

    • info

      removed the CF enum value from the response property for the response status

    • info

      removed the CG enum value from the response property for the response status

    • info

      removed the CH enum value from the response property for the response status

    • info

      removed the CI enum value from the response property for the response status

    • info

      removed the CK enum value from the response property for the response status

    • info

      removed the CL enum value from the response property for the response status

    • info

      removed the CM enum value from the response property for the response status

    • info

      removed the CN enum value from the response property for the response status

    • info

      removed the CO enum value from the response property for the response status

    • info

      removed the CR enum value from the response property for the response status

    • info

      removed the CU enum value from the response property for the response status

    • info

      removed the CV enum value from the response property for the response status

    • info

      removed the CW enum value from the response property for the response status

    • info

      removed the CX enum value from the response property for the response status

    • info

      removed the CY enum value from the response property for the response status

    • info

      removed the CZ enum value from the response property for the response status

    • info

      removed the DE enum value from the response property for the response status

    • info

      removed the DEACTIVATED enum value from the response property for the response status

    • info

      removed the DJ enum value from the response property for the response status

    • info

      removed the DK enum value from the response property for the response status

    • info

      removed the DM enum value from the response property for the response status

    • info

      removed the DO enum value from the response property for the response status

    • info

      removed the DZ enum value from the response property for the response status

    • info

      removed the EC enum value from the response property for the response status

    • info

      removed the EE enum value from the response property for the response status

    • info

      removed the EG enum value from the response property for the response status

    • info

      removed the EH enum value from the response property for the response status

    • info

      removed the ER enum value from the response property for the response status

    • info

      removed the ES enum value from the response property for the response status

    • info

      removed the ET enum value from the response property for the response status

    • info

      removed the EXPIRED enum value from the response property for the response status

    • info

      removed the FI enum value from the response property for the response status

    • info

      removed the FJ enum value from the response property for the response status

    • info

      removed the FK enum value from the response property for the response status

    • info

      removed the FM enum value from the response property for the response status

    • info

      removed the FO enum value from the response property for the response status

    • info

      removed the FR enum value from the response property for the response status

    • info

      removed the GA enum value from the response property for the response status

    • info

      removed the GB enum value from the response property for the response status

    • info

      removed the GD enum value from the response property for the response status

    • info

      removed the GE enum value from the response property for the response status

    • info

      removed the GF enum value from the response property for the response status

    • info

      removed the GG enum value from the response property for the response status

    • info

      removed the GH enum value from the response property for the response status

    • info

      removed the GI enum value from the response property for the response status

    • info

      removed the GL enum value from the response property for the response status

    • info

      removed the GM enum value from the response property for the response status

    • info

      removed the GN enum value from the response property for the response status

    • info

      removed the GP enum value from the response property for the response status

    • info

      removed the GQ enum value from the response property for the response status

    • info

      removed the GR enum value from the response property for the response status

    • info

      removed the GS enum value from the response property for the response status

    • info

      removed the GT enum value from the response property for the response status

    • info

      removed the GU enum value from the response property for the response status

    • info

      removed the GW enum value from the response property for the response status

    • info

      removed the GY enum value from the response property for the response status

    • info

      removed the HK enum value from the response property for the response status

    • info

      removed the HM enum value from the response property for the response status

    • info

      removed the HN enum value from the response property for the response status

    • info

      removed the HR enum value from the response property for the response status

    • info

      removed the HT enum value from the response property for the response status

    • info

      removed the HU enum value from the response property for the response status

    • info

      removed the ID enum value from the response property for the response status

    • info

      removed the IE enum value from the response property for the response status

    • info

      removed the IL enum value from the response property for the response status

    • info

      removed the IM enum value from the response property for the response status

    • info

      removed the IN enum value from the response property for the response status

    • info

      removed the INACTIVE enum value from the response property for the response status

    • info

      removed the IO enum value from the response property for the response status

    • info

      removed the IQ enum value from the response property for the response status

    • info

      removed the IR enum value from the response property for the response status

    • info

      removed the IS enum value from the response property for the response status

    • info

      removed the IT enum value from the response property for the response status

    • info

      removed the JE enum value from the response property for the response status

    • info

      removed the JM enum value from the response property for the response status

    • info

      removed the JO enum value from the response property for the response status

    • info

      removed the JP enum value from the response property for the response status

    • info

      removed the KE enum value from the response property for the response status

    • info

      removed the KG enum value from the response property for the response status

    • info

      removed the KH enum value from the response property for the response status

    • info

      removed the KI enum value from the response property for the response status

    • info

      removed the KM enum value from the response property for the response status

    • info

      removed the KN enum value from the response property for the response status

    • info

      removed the KP enum value from the response property for the response status

    • info

      removed the KR enum value from the response property for the response status

    • info

      removed the KW enum value from the response property for the response status

    • info

      removed the KY enum value from the response property for the response status

    • info

      removed the KZ enum value from the response property for the response status

    • info

      removed the LA enum value from the response property for the response status

    • info

      removed the LB enum value from the response property for the response status

    • info

      removed the LC enum value from the response property for the response status

    • info

      removed the LI enum value from the response property for the response status

    • info

      removed the LK enum value from the response property for the response status

    • info

      removed the LR enum value from the response property for the response status

    • info

      removed the LS enum value from the response property for the response status

    • info

      removed the LT enum value from the response property for the response status

    • info

      removed the LU enum value from the response property for the response status

    • info

      removed the LV enum value from the response property for the response status

    • info

      removed the LY enum value from the response property for the response status

    • info

      removed the MA enum value from the response property for the response status

    • info

      removed the MC enum value from the response property for the response status

    • info

      removed the MD enum value from the response property for the response status

    • info

      removed the ME enum value from the response property for the response status

    • info

      removed the MF enum value from the response property for the response status

    • info

      removed the MG enum value from the response property for the response status

    • info

      removed the MH enum value from the response property for the response status

    • info

      removed the MK enum value from the response property for the response status

    • info

      removed the ML enum value from the response property for the response status

    • info

      removed the MM enum value from the response property for the response status

    • info

      removed the MN enum value from the response property for the response status

    • info

      removed the MO enum value from the response property for the response status

    • info

      removed the MP enum value from the response property for the response status

    • info

      removed the MQ enum value from the response property for the response status

    • info

      removed the MR enum value from the response property for the response status

    • info

      removed the MS enum value from the response property for the response status

    • info

      removed the MT enum value from the response property for the response status

    • info

      removed the MU enum value from the response property for the response status

    • info

      removed the MV enum value from the response property for the response status

    • info

      removed the MW enum value from the response property for the response status

    • info

      removed the MX enum value from the response property for the response status

    • info

      removed the MY enum value from the response property for the response status

    • info

      removed the MZ enum value from the response property for the response status

    • info

      removed the NA enum value from the response property for the response status

    • info

      removed the NC enum value from the response property for the response status

    • info

      removed the NE enum value from the response property for the response status

    • info

      removed the NF enum value from the response property for the response status

    • info

      removed the NG enum value from the response property for the response status

    • info

      removed the NI enum value from the response property for the response status

    • info

      removed the NL enum value from the response property for the response status

    • info

      removed the NO enum value from the response property for the response status

    • info

      removed the NP enum value from the response property for the response status

    • info

      removed the NR enum value from the response property for the response status

    • info

      removed the NU enum value from the response property for the response status

    • info

      removed the NZ enum value from the response property for the response status

    • info

      removed the OM enum value from the response property for the response status

    • info

      removed the PA enum value from the response property for the response status

    • info

      removed the PE enum value from the response property for the response status

    • info

      removed the PF enum value from the response property for the response status

    • info

      removed the PG enum value from the response property for the response status

    • info

      removed the PH enum value from the response property for the response status

    • info

      removed the PK enum value from the response property for the response status

    • info

      removed the PL enum value from the response property for the response status

    • info

      removed the PM enum value from the response property for the response status

    • info

      removed the PN enum value from the response property for the response status

    • info

      removed the PR enum value from the response property for the response status

    • info

      removed the PS enum value from the response property for the response status

    • info

      removed the PT enum value from the response property for the response status

    • info

      removed the PW enum value from the response property for the response status

    • info

      removed the PY enum value from the response property for the response status

    • info

      removed the QA enum value from the response property for the response status

    • info

      removed the RE enum value from the response property for the response status

    • info

      removed the RO enum value from the response property for the response status

    • info

      removed the RS enum value from the response property for the response status

    • info

      removed the RU enum value from the response property for the response status

    • info

      removed the RW enum value from the response property for the response status

    • info

      removed the SA enum value from the response property for the response status

    • info

      removed the SB enum value from the response property for the response status

    • info

      removed the SC enum value from the response property for the response status

    • info

      removed the SD enum value from the response property for the response status

    • info

      removed the SE enum value from the response property for the response status

    • info

      removed the SG enum value from the response property for the response status

    • info

      removed the SH enum value from the response property for the response status

    • info

      removed the SI enum value from the response property for the response status

    • info

      removed the SJ enum value from the response property for the response status

    • info

      removed the SK enum value from the response property for the response status

    • info

      removed the SL enum value from the response property for the response status

    • info

      removed the SM enum value from the response property for the response status

    • info

      removed the SN enum value from the response property for the response status

    • info

      removed the SO enum value from the response property for the response status

    • info

      removed the SR enum value from the response property for the response status

    • info

      removed the SS enum value from the response property for the response status

    • info

      removed the ST enum value from the response property for the response status

    • info

      removed the SV enum value from the response property for the response status

    • info

      removed the SX enum value from the response property for the response status

    • info

      removed the SY enum value from the response property for the response status

    • info

      removed the SZ enum value from the response property for the response status

    • info

      removed the TC enum value from the response property for the response status

    • info

      removed the TD enum value from the response property for the response status

    • info

      removed the TF enum value from the response property for the response status

    • info

      removed the TG enum value from the response property for the response status

    • info

      removed the TH enum value from the response property for the response status

    • info

      removed the TJ enum value from the response property for the response status

    • info

      removed the TK enum value from the response property for the response status

    • info

      removed the TL enum value from the response property for the response status

    • info

      removed the TM enum value from the response property for the response status

    • info

      removed the TN enum value from the response property for the response status

    • info

      removed the TO enum value from the response property for the response status

    • info

      removed the TR enum value from the response property for the response status

    • info

      removed the TT enum value from the response property for the response status

    • info

      removed the TV enum value from the response property for the response status

    • info

      removed the TW enum value from the response property for the response status

    • info

      removed the TZ enum value from the response property for the response status

    • info

      removed the UA enum value from the response property for the response status

    • info

      removed the UG enum value from the response property for the response status

    • info

      removed the UM enum value from the response property for the response status

    • info

      removed the US enum value from the response property for the response status

    • info

      removed the UY enum value from the response property for the response status

    • info

      removed the UZ enum value from the response property for the response status

    • info

      removed the VA enum value from the response property for the response status

    • info

      removed the VC enum value from the response property for the response status

    • info

      removed the VE enum value from the response property for the response status

    • info

      removed the VG enum value from the response property for the response status

    • info

      removed the VI enum value from the response property for the response status

    • info

      removed the VN enum value from the response property for the response status

    • info

      removed the VU enum value from the response property for the response status

    • info

      removed the WF enum value from the response property for the response status

    • info

      removed the WS enum value from the response property for the response status

    • info

      removed the XK enum value from the response property for the response status

    • info

      removed the YE enum value from the response property for the response status

    • info

      removed the YT enum value from the response property for the response status

    • info

      removed the ZA enum value from the response property for the response status

    • info

      removed the ZM enum value from the response property for the response status

    • info

      removed the ZW enum value from the response property for the response status

    • info

      removed the ZZ_EU enum value from the response property for the response status

    This list may be incomplete.