Pleo · Schema

BookkeepingAccountSearchRequestV4

Represents a request to search for accounts.

Expense ManagementCompany CardsSpend ManagementReimbursementsAccountingFinTechFinance

Properties

Name	Type	Description
archived	boolean	Filter by archived status.
code	string	Search by code.
companyId	string	Filter by company ID.
externalId	string	Search by external id.
ids	array	Filter by a list of account IDs.
name	string	Search by name.

View JSON Schema on GitHub

JSON Schema

{
  "required": [
    "companyId"
  ],
  "type": "object",
  "properties": {
    "archived": {
      "type": "boolean",
      "description": "Filter by archived status.",
      "nullable": true,
      "example": false
    },
    "code": {
      "type": "string",
      "description": "Search by code.",
      "nullable": true,
      "example": "2001"
    },
    "companyId": {
      "type": "string",
      "description": "Filter by company ID.",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174011"
    },
    "externalId": {
      "type": "string",
      "description": "Search by external id.",
      "nullable": true,
      "example": "123e4567-e89b-12d3-a456-426614174011"
    },
    "ids": {
      "uniqueItems": true,
      "type": "array",
      "description": "Filter by a list of account IDs.",
      "nullable": true,
      "items": {
        "type": "string",
        "description": "Filter by a list of account IDs.",
        "format": "uuid",
        "nullable": true
      }
    },
    "name": {
      "type": "string",
      "description": "Search by name.",
      "nullable": true,
      "example": "Bank Charges"
    }
  },
  "description": "Represents a request to search for accounts.",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BookkeepingAccountSearchRequestV4"
}