Create a new account.

post https://external.pleo.io/v1-beta/accounts

The integration sends a request to this endpoint to create a corresponding account in Pleo for any
new record created in the external ERP/accounting system. The request fails if any similar accounts with
the same externalId and companyId already exists in Pleo.

Body Params

archived

boolean

required

Boolean flag used to determine if the account is archived.

code

string | null

Account code or number used in the accounting system's chart of accounts.

companyId

string

required

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

externalId

string

required

length between 0 and 255

        Unique external identifier of account, assigned in the external ERP/accounting system. 
        Can be the same as code if no other identifier is available.

metadata

object | null

Place for API users to store flexible data.

name

string

required

length between 0 and 255

Name of the account.

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

Responses

Response body

object

data

object

required

Represents an account in Pleo.

archived

boolean

required

Boolean flag used to determine if the account is archived.

code

string | null

Account code or number used in the accounting system's chart of accounts.

companyId

string

required

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

externalId

string

required

        Unique external identifier of account, assigned in the external ERP/accounting system. 
        Can be the same as code if no other identifier is available.

string

required

Pleo's internal identifier of the account.

metadata

object | null

Place for API users to store flexible data.

name

string

required

Name of the account.

taxCodeExternalId

string | null

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

Response body

object

data

object

required

Represents an account in Pleo.

archived

boolean

required

Boolean flag used to determine if the account is archived.

code

string | null

Account code or number used in the accounting system's chart of accounts.

companyId

string

required

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

externalId

string

required

        Unique external identifier of account, assigned in the external ERP/accounting system. 
        Can be the same as code if no other identifier is available.

string

required

Pleo's internal identifier of the account.

metadata

object | null

Place for API users to store flexible data.

name

string

required

Name of the account.

taxCodeExternalId

string | null

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

400

Bad request (e.g. missing required fields).

409

                Conflict (account with the same `externalId` exists in Pleo)

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://external.pleo.io/v1-beta/accounts \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json;charset=UTF-8' \
5
     --data '{"archived":true}'


xxxxxxxxxx
11
 
1
{
2
  "data": {
3
    "archived": false,
4
    "code": "2001",
5
    "companyId": "123e4567-e89b-12d3-a456-426614174006",
6
    "externalId": "External Id",
7
    "id": "123e4567-e89b-12d3-a456-426614174005",
8
    "name": "Bank Charges",
9
    "taxCodeExternalId": "IVA 20"
10
  }
11
}

200Request matched existing account.

201Account created.