/accounting-categories

post

https://api.dev.orbit.do/v5/accounting-categories

Create a tenant accounting category.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

key

string

required

length ≥ 1

^[a-zA-Z0-9-]+$

Stable tenant-scoped category key, for example freight. It cannot be changed after creation.

localizedName

object

required

Localized category name. At least one language must be non-empty.

localizedDescription

object

Optional localized category description.

active

boolean

Defaults to true

Inactive categories remain referenceable by saved lines and are omitted from new selections.

subtypeAliases

array of strings

Defaults to []

Exact subtype aliases or prefix aliases ending in an asterisk, for example marketplace-* .

subtypeAliases

externalReferences

object

Opaque string references for accounting integrations. Keys use letters, digits, dots, underscores, or hyphens and are limited to 64 characters.

defaultAmount

number

Optional amount in minor currency units, such as cents, prefilled for a new line.

unit

string

length ≤ 64

Optional unit prefilled for a new line.

defaultVatPercentage

number

0 to 100

Optional VAT percentage prefilled for a new line.

Responses

403

The role of the API key does not allow this action. The key needs a role with the matching permission, for example full access.

409

Category key already exists

200Created accounting category