Skip to main content
POST
Create a new account

Authorizations

Authorization
string
header
required

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

Body

application/json;charset=UTF-8
archived
boolean
required

Boolean flag used to determine if the account is archived.

companyId
string<uuid>
required

Pleo's internal identifier for the company the account is associated with.

externalId
string
required

Non empty unique external identifier of the account, assigned in the external ERP/accounting system. Can be the same as code if no other identifier is available. Maximum length: 255 characters.

Required string length: 1 - 255
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

Request matched existing account.

data
object
required

Represents an account in Pleo.