Skip to main content
PUT
Update an account

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Include the token in the Authorization header as: Bearer <token>

Path Parameters

accountId
string<uuid>
required

ID of the account to update.

Body

application/json;charset=UTF-8

Represents a request to update an account.

archived
boolean
required

Boolean flag used to determine if the account is archived.

name
string
required

Name of the account. Maximum length: 255 characters.

Maximum string length: 255
code
string | null

Account code or number used in the accounting system's chart of accounts. Maximum length: 255 characters.

Maximum string length: 255
metadata
object | null

Place for API users to store flexible data.

taxCodeExternalId
string | null

The identifier in the target system for the tax code the account is associated with.

  • This is NOT the tax percentage (e.g. 20%)
  • This is NOT the Pleo UUID of the tax code

Response

Update of account successful.

data
object
required

Represents an account in Pleo.