Skip to content
Developers
Pilot. The API is open to a small number of organisations and may change — every change is in the changelog.

Reference · Taxes

Update a tax

PATCH/v1/sites/{siteId}/taxes/{code}

Changes a tax. Only the fields sent change. Nothing is deleted: retire it with active false.

Needs Catalogue: writeChanges live data

Path

  • siteIdrequired

    The site, from GET /v1/sites.

    string

  • coderequired

    The record's code.

    string

Headers

  • Authorizationrequired

    An API key from Automation > Access in the Dnero portal, sent as Authorization: Bearer <key>.

    string

Body

  • active

    False to retire it, true to bring it back.

    boolean

  • name

    A new name.

    string · 1–200 characters

  • ratePercent

    A new rate, as a percentage. Every product carrying the tax is charged the new rate from then on.

    number · double · ≥ 0 · ≤ 100

Responses

200 OK

  • activerequired

    False for a retired tax.

    boolean

  • coderequired

    The tax's code. Products carry these.

    string

  • namerequired

    The tax's name.

    string

  • ratePercentrequired

    The rate, as a percentage.

    number · double

  • updatedAt

    When the tax last changed.

    string · date-time