Skip to main content
PATCH
Modify an account

Editing an account

The name, description and colour of an account can be changed. Only the fields you provide are changed; to remove a description or colour, set it to null:
Changes apply to the account in every open fiscal year, so the chart of accounts stays consistent. The account number, type and currency of an account cannot be changed.

Authorizations

x-api-token
string
header
required

API token for authentication. Obtain from your Infinity account settings.

Path Parameters

accountNumber
integer
required

The account number of the account

Required range: 1000 <= x <= 9999

Body

application/json

Provide the changes to save to the account in the request body. Any fields that are not provided are left unchanged.

name
string

The new name of the account.

Required string length: 1 - 100
description
string | null

The new description of the account. Set to null to remove the description.

Maximum string length: 500
colour
string | null

The new hex colour code of the account. Set to null to remove the colour.

Pattern: ^#[0-9a-fA-F]{6}$

Response

Changes saved successfully.

account
Account · object
required

An account of the chart of accounts. Accounts are identified by their account number.