evenbooks
Sign inStart for free

Sales tax

Sales tax rates.

Paths are relative to https://evenbooks.org/api/v1. How keys, errors, paging and versions work is in the guide; the whole reference is also an OpenAPI 3.1 document.

Administrator key marks endpoints that need a key with the admin role, Write access those a read-only key can’t call, and Idempotent those that accept an idempotency key.

List sales tax rates

get/tax-rates

By name. Archived rates are left out unless includeInactive=true. withUsage=true adds usage: how many active items default to each rate and how many issued, unpaid invoices carry it.

Parameters

Response 200

array of TaxRateDto

Errors 400 · 401 · 403 · 404 · 409 · 429

Create a sales tax rate

post/tax-rates
Administrator keyWrite access

Administrators only. rate is a fraction (0.0825 for 8.25%). Tax charged at this rate posts to the Sales Tax Payable account (liabilityAccountId).

Request body

CreateTaxRateInput

  • namestringrequired

    1–100 characters

  • ratestringrequired

    pattern ^0(\.\d{1,6})?$

  • agencystring or null

    up to 200 characters

Response 200

TaxRateDto (fields under Schemas)

Errors 400 · 401 · 403 · 404 · 409 · 429

Change a sales tax rate

patch/tax-rates/{id}
Administrator keyWrite access

Administrators only. Omitted fields stay as they are; isActive: false archives the rate. Issued invoices keep the rate they were issued with. Needs version from the last read (409 version_conflict otherwise).

Parameters

  • idstring (uuid)path · required

Request body

UpdateTaxRateInput

  • versionintegerrequired
  • namestring

    1–100 characters

  • ratestring

    pattern ^0(\.\d{1,6})?$

  • agencystring or null

    up to 200 characters

  • isActiveboolean

Response 200

TaxRateDto (fields under Schemas)

Errors 400 · 401 · 403 · 404 · 409 · 429

Schemas

The types these endpoints take or return, by name. Type names above link here.

QueryBoolean

boolean

TaxRateDto

  • idstring
  • namestring
  • ratestring
  • agencystring or null
  • liabilityAccountIdstring
  • isActiveboolean
  • versioninteger
  • usageobjectoptional
    Show 2 fields
    • itemsinteger
    • openInvoicesinteger