Xero · Schema

CurrentStatementResponse

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
startDate string Looking at the most recent bank statement, this field indicates the first date which transactions on this statement pertain to. This date is represented in ISO 8601 format.
endDate string Looking at the most recent bank statement, this field indicates the last date which transactions on this statement pertain to. This date is represented in ISO 8601 format.
startBalance number Looking at the most recent bank statement, this field indicates the balance before the transactions on the statement are applied (note, this is not always populated by the bank in every single instanc
endBalance number Looking at the most recent bank statement, this field indicates the balance after the transactions on the statement are applied (note, this is not always populated by the bank in every single instance
importedDateTimeUtc string Looking at the most recent bank statement, this field indicates when the document was imported into Xero. This date is represented in ISO 8601 format.
importSourceType string Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, file upload, or manual keying).
View JSON Schema on GitHub

JSON Schema

xero-currentstatementresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CurrentStatementResponse",
  "title": "CurrentStatementResponse",
  "type": "object",
  "properties": {
    "startDate": {
      "type": "string",
      "description": "Looking at the most recent bank statement, this field indicates the first date which transactions on this statement pertain to. This date is represented in ISO 8601 format.",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "description": "Looking at the most recent bank statement, this field indicates the last date which transactions on this statement pertain to. This date is represented in ISO 8601 format.",
      "format": "date"
    },
    "startBalance": {
      "type": "number",
      "description": "Looking at the most recent bank statement, this field indicates the balance before the transactions on the statement are applied (note, this is not always populated by the bank in every single instance (~10%)).",
      "format": "double",
      "x-is-money": true
    },
    "endBalance": {
      "type": "number",
      "description": "Looking at the most recent bank statement, this field indicates the balance after the transactions on the statement are applied (note, this is not always populated by the bank in every single instance (~10%)).",
      "format": "double",
      "x-is-money": true
    },
    "importedDateTimeUtc": {
      "type": "string",
      "description": "Looking at the most recent bank statement, this field indicates when the document was imported into Xero.  This date is represented in ISO 8601 format.",
      "format": "date-time"
    },
    "importSourceType": {
      "type": "string",
      "description": "Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, file upload, or manual keying)."
    }
  },
  "additionalProperties": false
}