Create a tax

post /api/taxes

Creates a Tax resource.

Creates a tax in the current organization. Give it a rate (a percentage from 0 to 100), a name, and the Country it applies to as an IRI in country. Send Flowkiwi-Locale to set the translatable name and description for a specific locale.

Headers

Name	Type	Required	Description
Flowkiwi-Locale	string	-	Specifies the locale for properties that support localization. If not provided, the default locale will be used.

Request body

Property	Type	Required	Description
country	string	required	The Country to which this tax belongs. Requires the instance_params:read scope. Returned null when the scope is missing.
description	string | null	-	A short description of the tax.
name	string | null	-	The name of the tax.
rate	string	-	The tax rate as a percentage between 0 and 100, as a decimal string with up to two decimals (e.g. "20", "5.5"). A JSON number is rejected with a 422; the stored rate is read back with exactly two decimals.

Response

201 - Tax resource created

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
country	string | Country | null	required	The Country to which this tax belongs. Requires the instance_params:read scope. Returned null when the scope is missing.
createdAt	string	-	The date and time when the resource was created (ISO 8601 format).
description	string | null	-	This property supports translations. A short description of the tax.
id	string	-	The resource's unique identifier (UUID).
name	string | null	-	This property supports translations. The name of the tax.
rate	string	-	The tax rate as a percentage between 0 and 100, serialized as a decimal string with exactly two decimals (e.g. "20.00", "5.50") so that no floating-point rounding can alter it. Parse it with a decimal type, not a float.
updatedAt	string	-	The date and time when the resource was last modified (ISO 8601 format).

Errors

400 - Invalid input

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
code	string	-	Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
description	string | null	-
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
message	string	-	End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
slug	string	-	Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
status	integer | null	-
title	string | null	-	A short, human-readable summary of the problem. For a catalogued error it repeats the slug.
type	string	-	A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.

403 - Access denied. The caller is missing one or more permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
detail	string	-
missingPermissions	string[]	-	Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission.
status	integer	-
title	string	-
type	string	-

422 - An error occurred

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
description	string	-
detail	string	-
instance	string | null	-
status	integer	-
title	string | null	-
type	string	-
violations	object[]	-
Show violations fields Property Type Required Description code string - The code of the violation hint string - An extra hint to understand the violation message string required The message associated with the violation parameters object - Dynamic placeholder values for the violation message template (substitute into the code catalogue message). payload object - The serialized payload of the violation propertyPath string required The property path of the violation slug string - Stable centralized error-code slug for this violation (see /api/error-codes).