Pleo · Schema

BookkeepingAccountCreateRequestV1

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. Maximum length: 255 characters.
companyId	string	Pleo's internal identifier for the company the account is associated with.
externalId	string	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.
metadata	object	Place for API users to store flexible data.
name	string	Name of the account. Maximum length: 255 characters.
taxCodeExternalId	string	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

View JSON Schema on GitHub

JSON Schema

{
  "required": [
    "archived",
    "companyId",
    "externalId",
    "name"
  ],
  "type": "object",
  "properties": {
    "archived": {
      "type": "boolean",
      "description": "Boolean flag used to determine if the account is archived."
    },
    "code": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "Account code or number used in the accounting system's chart of accounts. Maximum length: 255 characters.",
      "nullable": true
    },
    "companyId": {
      "type": "string",
      "description": "Pleo's internal identifier for the company the account is associated with.",
      "format": "uuid"
    },
    "externalId": {
      "maxLength": 255,
      "minLength": 1,
      "type": "string",
      "description": "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."
    },
    "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": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "Name of the account. Maximum length: 255 characters."
    },
    "taxCodeExternalId": {
      "type": "string",
      "description": "The identifier in **the target system** for the tax code the account is associated with.\n- This is NOT the tax percentage (e.g. 20%)\n- This is NOT the Pleo UUID of the tax code",
      "nullable": true
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BookkeepingAccountCreateRequestV1"
}