Xero · Schema

Attachment

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
AttachmentID string Unique ID for the file
FileName string Name of the file
Url string URL to the file on xero.com
MimeType string Type of file
ContentLength integer Length of the file content
IncludeOnline boolean Include the file with the online invoice
View JSON Schema on GitHub

JSON Schema

xero-attachment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Attachment",
  "title": "Attachment",
  "type": "object",
  "externalDocs": {
    "url": "http://developer.xero.com/documentation/api/attachments/"
  },
  "properties": {
    "AttachmentID": {
      "description": "Unique ID for the file",
      "type": "string",
      "format": "uuid",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "FileName": {
      "description": "Name of the file",
      "type": "string",
      "example": "xero-dev.jpg"
    },
    "Url": {
      "description": "URL to the file on xero.com",
      "type": "string",
      "example": "https://api.xero.com/api.xro/2.0/Accounts/da962997-a8bd-4dff-9616-01cdc199283f/Attachments/sample5.jpg"
    },
    "MimeType": {
      "description": "Type of file",
      "type": "string",
      "example": "image/jpg"
    },
    "ContentLength": {
      "description": "Length of the file content",
      "type": "integer"
    },
    "IncludeOnline": {
      "description": "Include the file with the online invoice",
      "type": "boolean"
    }
  }
}