Pleo · Schema

BookkeepingAccountRestModelV4

Represents an account in Pleo.

Expense ManagementCompany CardsSpend ManagementReimbursementsAccountingFinTechFinance

Properties

Name	Type	Description
archived	boolean	Boolean flag used to determine if the account is archived.
code	string	Account code or number used in the accounting system's chart of accounts.
companyId	string	Pleo's internal identifier of the company the account is associated with.
externalId	string	Unique external identifier of account, assigned in the external ERP/accounting system. Can be the same as code if no other identifier is available.
id	string	Pleo's internal identifier of the account.
metadata	object	Place for API users to store flexible data.
name	string	Name of the account.
taxCodeExternalId	string	The identifier in the target system for the tax code the account is associated with.

View JSON Schema on GitHub

JSON Schema

{
  "required": [
    "archived",
    "companyId",
    "externalId",
    "id",
    "name"
  ],
  "type": "object",
  "properties": {
    "archived": {
      "type": "boolean",
      "description": "Boolean flag used to determine if the account is archived."
    },
    "code": {
      "type": "string",
      "description": "Account code or number used in the accounting system's chart of accounts.",
      "nullable": true
    },
    "companyId": {
      "type": "string",
      "description": "Pleo's internal identifier of the company the account is associated with.",
      "format": "uuid"
    },
    "externalId": {
      "type": "string",
      "description": "\n            Unique external identifier of account, assigned in the external ERP/accounting system. \n            Can be the same as code if no other identifier is available.\n        "
    },
    "id": {
      "type": "string",
      "description": "Pleo's internal identifier of the account.",
      "format": "uuid"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "description": "Place for API users to store flexible data.",
        "nullable": true
      },
      "description": "Place for API users to store flexible data.",
      "nullable": true
    },
    "name": {
      "type": "string",
      "description": "Name of the account."
    },
    "taxCodeExternalId": {
      "type": "string",
      "description": "The identifier in **the target system** for the tax code the account is associated with. ",
      "nullable": true
    }
  },
  "description": "Represents an account in Pleo.",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BookkeepingAccountRestModelV4"
}