Evenbead docs
Contents

Sales tax

6 operations. All areas

POST/v1/tax-agencies

Add a sales-tax agency (optionally linked to a vendor for paying it)

  • Operation createTaxAgency
  • Scope: admin
  • Write: needs Idempotency-Key (or dry_run)
Request body
  • name string, required
  • contact_id string
Responses
  • 201 Created (object)
  • Errors 400, 401, 403, 409, 422, 429, 500 (Error: error.type, message)

GET/v1/tax-agencies

Sales-tax agencies

  • Operation listTaxAgencies
  • Scope: read
  • Read
Parameters
  • include_inactive query, boolean
Responses
  • 200 Agencies (object)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

POST/v1/tax-rates

Add a sales-tax rate (percent with up to 4 decimals) collected for an agency into a liability account. Rates are never edited: add a new one and deactivate the old.

  • Operation createTaxRate
  • Scope: admin
  • Write: needs Idempotency-Key (or dry_run)
Request body
  • name string, required
  • agency_id string, required
  • rate_percent string, required e.g. "9.75"
  • payable_account string, required Sales tax payable (a liability account)
Responses
  • 201 Created (object)
  • Errors 400, 401, 403, 409, 422, 429, 500 (Error: error.type, message)

GET/v1/tax-rates

Sales-tax rates

  • Operation listTaxRates
  • Scope: read
  • Read
Parameters
  • include_inactive query, boolean
Responses
  • 200 Rates (object)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

POST/v1/tax-rates/{id}/status

Deactivate (or reactivate) a tax rate; documents keep the rate they used

  • Operation setTaxRateStatus
  • Scope: admin
  • Write: needs Idempotency-Key (or dry_run)
Parameters
  • id path, string, required
Request body
  • active boolean, required
  • reason string, required
Responses
  • 200 Updated (object)
  • Errors 400, 401, 403, 404, 409, 422, 429, 500 (Error: error.type, message)

POST/v1/tax-rates/combined

Combine 2-10 single-agency rates into one rate for documents (e.g. state + county + city). Its rate is their sum; a document taxed at it carries one tax line per jurisdiction, each rounded on its own and posted to that agency's payable account. Never edited: create a new combined rate and deactivate the old (deactivating a component deactivates it too).

  • Operation createCombinedTaxRate
  • Scope: admin
  • Write: needs Idempotency-Key (or dry_run)
Request body
  • name string, required
  • component_ids array of string, required Single-agency tax rates, in the order shown on documents
Responses
  • 201 Created (object)
  • Errors 400, 401, 403, 409, 422, 429, 500 (Error: error.type, message)