Xero · Schema

Folder

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
Name string The name of the folder
FileCount integer The number of files in the folder
Email string The email address used to email files to the inbox. Only the inbox will have this element.
IsInbox boolean to indicate if the folder is the Inbox. The Inbox cannot be renamed or deleted.
Id string Xero unique identifier for a folder Files
View JSON Schema on GitHub

JSON Schema

xero-folder-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Folder",
  "title": "Folder",
  "required": [
    "name"
  ],
  "properties": {
    "Name": {
      "description": "The name of the folder",
      "type": "string",
      "example": "assets"
    },
    "FileCount": {
      "description": "The number of files in the folder",
      "type": "integer",
      "example": 5
    },
    "Email": {
      "description": "The email address used to email files to the inbox. Only the inbox will have this element.",
      "type": "string",
      "example": "[email protected]"
    },
    "IsInbox": {
      "description": "to indicate if the folder is the Inbox. The Inbox cannot be renamed or deleted.",
      "type": "boolean",
      "example": true
    },
    "Id": {
      "description": "Xero unique identifier for a folder  Files",
      "type": "string",
      "format": "uuid",
      "example": "4ff1e5cc-9835-40d5-bb18-09fdb118db9c"
    }
  }
}