Taxes

A Tax represents a tax rate that applies in a given Country - a VAT rate, for example. It has a rate (a percentage from 0 to 100), a translatable name and description, and belongs to exactly one country.

Taxes are how Flowkiwi turns a tax-excluded price into a tax-included one. A Sale offer carries a taxExcludedPrice and references a tax; the tax-included price a buyer pays is computed from that tax’s rate. Purchase offers reference a tax the same way on the buying side.

The Tax object

Property	Type	Required	Description
id	string	-	The resource's unique identifier (UUID).
name	string | null	-	This property supports translations. The name of the tax.
description	string | null	-	This property supports translations. A short description of the tax.
rate	number	-	The tax rate as a percentage (0-100), with up to two decimals.
country	string	required	The Country to which this tax belongs.
createdAt	string	-	The date and time when the resource was created (ISO 8601 format).
updatedAt	string	-	The date and time when the resource was last modified (ISO 8601 format).

Common workflows

• Set up a country’s VAT. Create a tax with the country’s standard rate and link it to the Country, then reference it from your offers.
• Apply a reduced rate. Create a second tax for the same country with a lower rate (for goods that qualify) and point the relevant offers at it.
• Update a rate. Patch the rate when legislation changes; offers that reference the tax pick up the new rate.

Conventions

Authentication and headers

All requests require an OAuth 2.0 bearer token and the organization scope header:

Authorization: Bearer <token>
X-Flowkiwi-Organization-Id: <organization-id>

For the translatable name and description, set the active locale (and optionally a fallback):

X-Flowkiwi-Locale: fr-FR
X-Flowkiwi-Locale-Fallback: en-US

Partial updates

PATCH uses JSON Merge Patch with Content-Type: application/merge-patch+json.