api.setup.tax_exemptions

/api/setup/tax_exemptions/

GET /api/setup/tax_exemptions/

Description:

List the existing tax exemptions,
can_lock requires_lock has_etag requires_etag
False False False False

Response:

<tax_exemptions>
        <tax_exemption uri="/setup/tax_exemptions/X/" id="X">
            <name>[str]</name>
            <taxes>
                <!-- Always 5 taxes -->
                <tax id="1">
                    <exempt>[bool]</exempt>
                </tax>
                [...]
            </taxes>
            <active>[bool]</active>
        </tax_exemption>
        ...
</tax_exemptions>

POST /api/setup/tax_exemptions/

Description:

Create a new tax exemption.
can_lock requires_lock has_etag requires_etag
False False True False

Request:

<tax_exemption>
    <name>[str]</name> <!-- Mandatory -->
    <taxes> <!-- Optional, default to false -->
        <!-- Up to 5 taxes, id=1-5 -->
        <tax id="1">
            <exempt>[bool]</exempt>
        </tax>
        [...]
    </taxes>
    <active>[bool]</active> <!-- Optional, default to true -->
</tax_exemption>

Response:

<tax_exemption uri="/setup/tax_exemptions/X/" id="X">
    <name>[str]</name>
    <taxes>
        <!-- Always 5 taxes -->
        <tax id="1">
            <exempt>[bool]</exempt>
        </tax>
        [...]
    </taxes>
    <active>[bool]</active>
</tax_exemption>

/api/setup/tax_exemptions/(d+)/

GET /api/setup/tax_exemptions/(d+)/

Description:

Return the details for an existing tax exemption,
can_lock requires_lock has_etag requires_etag
False False True False

Response:

<tax_exemption uri="/setup/tax_exemptions/X/" id="X">
    <name>[str]</name>
    <taxes>
        <!-- Always 5 taxes -->
        <tax id="1">
            <exempt>[bool]</exempt>
        </tax>
        [...]
    </taxes>
    <active>[bool]</active>
</tax_exemption>

PUT /api/setup/tax_exemptions/(d+)/

Description:

Update an existing tax exemption.
can_lock requires_lock has_etag requires_etag
False False True True
Header Name Description
if-match “[int]”

Request:

<tax_exemption>
    <name>[str]</name> <!-- Optional -->
    <taxes> <!-- Optional -->
        <!-- Up to 5 taxes -->
        <tax id="1">
            <exempt>[bool]</exempt>
        </tax>
        [...]
    </taxes>
    <active>[bool]</active> <!-- Optional -->
</tax_exemption>

Response:

<tax_exemption uri="/setup/tax_exemptions/X/" id="X">
    <name>[str]</name>
    <taxes>
        <!-- Always 5 taxes -->
        <tax id="1">
            <exempt>[bool]</exempt>
        </tax>
        [...]
    </taxes>
    <active>[bool]</active>
</tax_exemption>
Expected Errors:

DELETE /api/setup/tax_exemptions/(d+)/

Description:

Delete an existing tax exemption.
can_lock requires_lock has_etag requires_etag
False False False True
Header Name Description
if-match “[int]”

Response:

<tax_exemption uri="/setup/tax_exemptions/X/" id="X" deleted="true"/>
Expected Errors: