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."
    },
    "groupBy": {
      "type": "string",
      "enum": [
        "category",
        "merchant",
        "month",
        "account",
        "day"
      ],
      "description": "What to group by. Defaults to category."
    },
    "top": {
      "type": "number",
      "description": "Keep only the largest N groups and fold the rest into 'Other'."
    }
  }
}