Finance/YNAB API Endpoints

List payees

v1.0.0

Returns all payees

Input

{
  "type": "object",
  "properties": {
    "budget_id": {
      "type": "string"
    },
    "last_knowledge_of_server": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "budget_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "payees",
        "server_knowledge"
      ],
      "properties": {
        "payees": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "name",
              "deleted"
            ],
            "properties": {
              "deleted": {
                "type": "boolean",
                "description": "Whether or not the payee has been deleted.  Deleted payees will only be included in delta requests."
              },
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "name": {
                "type": "string"
              },
              "transfer_account_id": {
                "type": "string",
                "description": "If a transfer payee, the `account_id` to which this payee transfers to"
              }
            }
          }
        },
        "server_knowledge": {
          "type": "integer",
          "format": "int64",
          "description": "The knowledge of the server"
        }
      }
    }
  }
}