BankReconciliationResponseDto

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/fis/main/json-schema/fis-bank-reconciliation-response-dto-schema.json",
  "title": "BankReconciliationResponseDto",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/fis-bank-api-openapi.yml#/components/schemas/BankReconciliationResponseDto",
  "type": "object",
  "properties": {
    "pagination": {
      "$ref": "#/$defs/PaginationMetaData"
    },
    "count": {
      "type": "number",
      "readOnly": true,
      "format": "integer"
    },
    "reports": {
      "readOnly": false,
      "type": "array",
      "items": {
        "$ref": "#/$defs/BankReconciliationReport"
      }
    }
  },
  "required": [
    "pagination",
    "count",
    "reports"
  ],
  "$defs": {
    "BankReconciliationData": {
      "type": "object",
      "properties": {
        "bankTransactionsCount": {
          "type": "number"
        },
        "accountingTransactionsCount": {
          "type": "number"
        },
        "bankTransactionsAmount": {
          "type": "number",
          "format": "float"
        },
        "accountingTransactionsAmount": {
          "type": "number",
          "format": "float"
        },
        "bankTransactionsTotalValue": {
          "type": "number",
          "format": "float"
        },
        "accountingTransactionsTotalValue": {
          "type": "number",
          "format": "float"
        },
        "weightedPercentageError": {
          "type": "number",
          "format": "float"
        },
        "accuracyScore": {
          "type": "number",
          "format": "float"
        },
        "bankTransactionsUnreconciledCount": {
          "type": "number"
        },
        "bankTransactionsUnreconciledAmount": {
          "type": "number",
          "format": "float"
        },
        "dailyAccuracyScore": {
          "type": "number",
          "format": "float"
        },
        "unreconciledBankTransactions": {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "$ref": "#/$defs/BankTransactions"
              }
            ]
          }
        },
        "reconciledBankTransactions": {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "$ref": "#/$defs/ReconciledBankTransactions"
              }
            ]
          }
        }
      },
      "required": [
        "bankTransactionsCount",
        "accountingTransactionsCount",
        "bankTransactionsAmount",
        "accountingTransactionsAmount",
        "bankTransactionsTotalValue",
        "accountingTransactionsTotalValue",
        "weightedPercentageError",
        "accuracyScore",
        "bankTransactionsUnreconciledCount",
        "bankTransactionsUnreconciledAmount",
        "dailyAccuracyScore"
      ]
    },
    "BankReconciliationReport": {
      "type": "object",
      "properties": {
        "meta": {
          "$ref": "#/$defs/BankReconciliationReportMetaData"
        },
        "data": {
          "readOnly": false,
          "type": "array",
          "items": {
            "$ref": "#/$defs/BankReconciliationData"
          }
        }
      },
      "required": [
        "meta",
        "data"
      ]
    },
    "BankReconciliationReportMetaData": {
      "type": "object",
      "properties": {
        "reportId": {
          "type": "string",
          "readOnly": true
        },
        "serviceName": {
          "type": "string",
          "readOnly": true,
          "enum": [
            "freshbooks",
            "quickbooks",
            "quickbooksDesktop",
            "xero",
            "oracleNetsuite",
            "sageBusinessCloud",
            "sageIntacct",
            "dynamicsBusinessCentral",
            "dynamics365Finance",
            "wave",
            "myob",
            "zohoBooks",
            "byod"
          ]
        },
        "businessName": {
          "type": "string",
          "readOnly": true
        },
        "startDate": {
          "type": "string",
          "readOnly": true,
          "format": "date-time"
        },
        "endDate": {
          "type": "string",
          "readOnly": true,
          "format": "date-time"
        },
        "createdAt": {
          "type": "string",
          "readOnly": true,
          "format": "date-time"
        },
        "updatedAt": {
          "type": "string",
          "readOnly": false,
          "format": "date-time"
        }
      },
      "required": [
        "reportId",
        "serviceName",
        "businessName",
        "startDate",
        "endDate",
        "createdAt",
        "updatedAt"
      ]
    },
    "BankTransactions": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "readOnly": false
        },
        "date": {
          "type": "string",
          "readOnly": false,
          "format": "date-time"
        },
        "amount": {
          "type": "number",
          "readOnly": false
        },
        "accountType": {
          "type": "string"
        },
        "accountId": {
          "type": "string"
        },
        "description": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "date",
        "amount",
        "accountId"
      ]
    },
    "EntityRef": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "PaginationMetaData": {
      "type": "object",
      "properties": {
        "offset": {
          "type": "number",
          "readOnly": true
        },
        "limit": {
          "type": "number",
          "readOnly": true
        },
        "count": {
          "type": "number",
          "readOnly": true
        }
      },
      "required": [
        "offset",
        "limit",
        "count"
      ]
    },
    "ReconcilationAccountRef": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "readOnly": false
        },
        "name": {
          "type": "string",
          "readOnly": false
        },
        "section": {
          "type": "string",
          "readOnly": false,
          "enum": [
            "Assets",
            "Expenses",
            "Income",
            "Liabilities",
            "Equity"
          ]
        },
        "subSection": {
          "type": "string",
          "readOnly": false,
          "enum": [
            "Current Assets",
            "Non-Current Assets",
            "Current Liabilities",
            "Non-Current Liabilities",
            "Equity",
            "Income",
            "Other Income",
            "Operating Expenses",
            "Other Expenses",
            "Cost of Goods Sold"
          ]
        },
        "group": {
          "type": "string",
          "readOnly": false
        },
        "subGroup": {
          "type": "string",
          "readOnly": false
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "ReconciledBankTransactions": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "readOnly": false
        },
        "date": {
          "type": "string",
          "readOnly": false,
          "format": "date-time"
        },
        "amount": {
          "type": "number",
          "readOnly": false
        },
        "accountType": {
          "type": "string"
        },
        "accountId": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "accountingTransactionId": {
          "type": "string"
        },
        "accountingTransactionType": {
          "type": "string",
          "enum": [
            "expense",
            "invoice",
            "payment",
            "payroll",
            "journalEntry",
            "bill",
            "vendorCreditNote",
            "creditNote",
            "billPayment",
            "bankTransaction",
            "transfer",
            "deposit",
            "refund",
            "estimate",
            "inventoryAdjustment",
            "purchaseOrder",
            "taxPayment",
            "taxAdjustment",
            "taxRefund",
            "taxReversal",
            "other",
            "unknown"
          ]
        },
        "isPosting": {
          "type": "boolean"
        },
        "isSplitTransaction": {
          "type": "boolean"
        },
        "subTotal": {
          "type": "number",
          "format": "float"
        },
        "transactionNumber": {
          "type": "string"
        },
        "transactionReportId": {
          "type": "string"
        },
        "accountRef": {
          "$ref": "#/$defs/ReconcilationAccountRef"
        },
        "entityRef": {
          "$ref": "#/$defs/EntityRef"
        }
      },
      "required": [
        "id",
        "date",
        "amount",
        "accountId",
        "accountingTransactionId",
        "accountRef"
      ]
    }
  }
}