Codat · Schema

Data integrity summary

Unified_API
View JSON Schema on GitHub

JSON Schema

codat-dataintegritysummary-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DataIntegritySummary",
  "title": "Data integrity summary",
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/DataIntegritySummary/definitions/dataIntegrityType"
    },
    {
      "type": "object",
      "properties": {
        "byAmount": {
          "$ref": "#/components/schemas/DataIntegritySummary/definitions/dataIntegrityByAmount"
        },
        "byCount": {
          "$ref": "#/components/schemas/DataIntegritySummary/definitions/dataIntegrityByCount"
        }
      }
    }
  ],
  "definitions": {
    "dataIntegrityType": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "The data type which the data type in the URL has been matched against. For example, if you've matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions."
        }
      }
    },
    "dataIntegrityByAmount": {
      "title": "Data integrity by amount",
      "type": "object",
      "properties": {
        "matchPercentage": {
          "type": "number",
          "format": "decimal",
          "description": "The percentage of the absolute value of transactions of the type specified in the route which have a match."
        },
        "unmatched": {
          "type": "number",
          "format": "decimal",
          "description": "The sum of the absolute value of transactions of the type specified in the route which don't have a match."
        },
        "matched": {
          "type": "number",
          "format": "decimal",
          "description": "The sum of the absolute value of transactions of the type specified in the route which have a match."
        },
        "total": {
          "type": "number",
          "format": "decimal",
          "description": "The total of unmatched and matched."
        },
        "currency": {
          "$ref": "#/components/schemas/SourceAccount/properties/currency"
        }
      }
    },
    "dataIntegrityByCount": {
      "title": "Data integrity by count",
      "type": "object",
      "properties": {
        "matchPercentage": {
          "type": "number",
          "format": "decimal",
          "description": "The percentage of records of the type specified in the route which have a match."
        },
        "unmatched": {
          "type": "number",
          "format": "decimal",
          "description": "The number of records of the type specified in the route which don't have a match."
        },
        "matched": {
          "type": "number",
          "format": "decimal",
          "description": "The number of records of the type specified in the route which do have a match."
        },
        "total": {
          "type": "number",
          "format": "decimal",
          "description": "The total of unmatched and matched."
        }
      }
    }
  }
}