Finance/YNAB API Endpoints

List locations for a payee

v1.0.0

Returns all payee locations for a specified payee

Input

{
  "type": "object",
  "properties": {
    "budget_id": {
      "type": "string"
    },
    "payee_id": {
      "type": "string"
    }
  },
  "required": [
    "budget_id",
    "payee_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "payee_locations"
      ],
      "properties": {
        "payee_locations": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "payee_id",
              "latitude",
              "longitude",
              "deleted"
            ],
            "properties": {
              "deleted": {
                "type": "boolean",
                "description": "Whether or not the payee location has been deleted.  Deleted payee locations will only be included in delta requests."
              },
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "latitude": {
                "type": "string"
              },
              "longitude": {
                "type": "string"
              },
              "payee_id": {
                "type": "string",
                "format": "uuid"
              }
            }
          }
        }
      }
    }
  }
}