pineapplesour.github.io

{
  "type": "object",
  "properties": {
    "from": {
      "type": "string",
      "description": "Only include transactions on or after this date (YYYY-MM-DD)."
    },
    "to": {
      "type": "string",
      "description": "Only include transactions on or before this date (YYYY-MM-DD)."
    },
    "category": {
      "type": "string",
      "description": "Restrict to one category. Use 'Uncategorised' for rows with no category yet."
    },
    "account": {
      "type": "string",
      "description": "Restrict to accounts whose name contains this text."
    },
    "merchant": {
      "type": "string",
      "description": "Restrict to a merchant. Matching is fuzzy, so 'starbucks' catches every branch and spelling."
    },
    "search": {
      "type": "string",
      "description": "Free-text match against the transaction description."
    },
    "flow": {
      "type": "string",
      "enum": [
        "all",
        "spend",
        "income"
      ],
      "description": "Which side of the ledger to include. Defaults to all."
    },
    "minAmount": {
      "type": "number",
      "description": "Minimum absolute amount."
    },
    "maxAmount": {
      "type": "number",
      "description": "Maximum absolute amount."
    },
    "sort": {
      "type": "string",
      "enum": [
        "date-desc",
        "date-asc",
        "amount-desc",
        "amount-asc"
      ],
      "description": "How to order the table."
    },
    "groupBy": {
      "type": "string",
      "enum": [
        "category",
        "merchant",
        "month",
        "account"
      ],
      "description": "What the chart groups by."
    },
    "highlightIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Transaction ids to mark in the table."
    },
    "message": {
      "type": "string",
      "description": "A short line shown above the table, e.g. 'These are the three charges I think are duplicates.'"
    },
    "reset": {
      "type": "boolean",
      "description": "Clear every filter first."
    }
  }
}