BankTransaction

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BankTransaction",
  "title": "BankTransaction",
  "externalDocs": {
    "url": "http://developer.xero.com/documentation/api/banktransactions/"
  },
  "properties": {
    "Type": {
      "description": "See Bank Transaction Types",
      "type": "string",
      "enum": [
        "RECEIVE",
        "RECEIVE-OVERPAYMENT",
        "RECEIVE-PREPAYMENT",
        "SPEND",
        "SPEND-OVERPAYMENT",
        "SPEND-PREPAYMENT",
        "RECEIVE-TRANSFER",
        "SPEND-TRANSFER"
      ]
    },
    "Contact": {
      "$ref": "#/components/schemas/Contact"
    },
    "LineItems": {
      "description": "See LineItems",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LineItem"
      }
    },
    "BankAccount": {
      "$ref": "#/components/schemas/Account"
    },
    "IsReconciled": {
      "description": "Boolean to show if transaction is reconciled",
      "type": "boolean"
    },
    "Date": {
      "description": "Date of transaction \u2013 YYYY-MM-DD",
      "type": "string",
      "x-is-msdate": true
    },
    "Reference": {
      "description": "Reference for the transaction. Only supported for SPEND and RECEIVE transactions.",
      "type": "string"
    },
    "CurrencyCode": {
      "$ref": "#/components/schemas/CurrencyCode",
      "type": "string"
    },
    "CurrencyRate": {
      "description": "Exchange rate to base currency when money is spent or received. e.g.0.7500 Only used for bank transactions in non base currency. If this isn\u2019t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments.",
      "type": "number",
      "format": "double",
      "x-is-money": true
    },
    "Url": {
      "description": "URL link to a source document \u2013 shown as \u201cGo to App Name\u201d",
      "type": "string"
    },
    "Status": {
      "description": "See Bank Transaction Status Codes",
      "type": "string",
      "enum": [
        "AUTHORISED",
        "DELETED",
        "VOIDED"
      ]
    },
    "LineAmountTypes": {
      "$ref": "#/components/schemas/LineAmountTypes",
      "type": "string"
    },
    "SubTotal": {
      "description": "Total of bank transaction excluding taxes",
      "type": "number",
      "format": "double",
      "x-is-money": true
    },
    "TotalTax": {
      "description": "Total tax on bank transaction",
      "type": "number",
      "format": "double",
      "x-is-money": true
    },
    "Total": {
      "description": "Total of bank transaction tax inclusive",
      "type": "number",
      "format": "double",
      "x-is-money": true
    },
    "BankTransactionID": {
      "description": "Xero generated unique identifier for bank transaction",
      "type": "string",
      "format": "uuid",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "PrepaymentID": {
      "description": "Xero generated unique identifier for a Prepayment. This will be returned on BankTransactions with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT",
      "readOnly": true,
      "type": "string",
      "format": "uuid",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "OverpaymentID": {
      "description": "Xero generated unique identifier for an Overpayment. This will be returned on BankTransactions with a Type of SPEND-OVERPAYMENT or RECEIVE-OVERPAYMENT",
      "readOnly": true,
      "type": "string",
      "format": "uuid",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "UpdatedDateUTC": {
      "description": "Last modified date UTC format",
      "type": "string",
      "x-is-msdate-time": true,
      "example": "/Date(1573755038314)/",
      "readOnly": true
    },
    "HasAttachments": {
      "description": "Boolean to indicate if a bank transaction has an attachment",
      "readOnly": true,
      "type": "boolean",
      "default": "false",
      "example": "false"
    },
    "StatusAttributeString": {
      "description": "A string to indicate if a invoice status",
      "type": "string"
    },
    "ValidationErrors": {
      "description": "Displays array of validation error messages from the API",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      }
    }
  },
  "required": [
    "Type",
    "LineItems",
    "BankAccount"
  ],
  "type": "object"
}