action bunq_list_all_schedule_instance_for_user_monetary_account_schedule {
  description: "view for reading, updating and listing the scheduled instance."
  provider: bunq
  method: GET
  path: "/user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance"
  encoding: json
  input: {
    type: "object"
    properties: {
      "monetary-accountID": {
        type: "integer"
      }
      scheduleID: {
        type: "integer"
      }
      userID: {
        type: "integer"
      }
    }
    required: ["monetary-accountID", "scheduleID", "userID"]
    additionalProperties: false
  }
  output: {
    type: "array"
    items: {
      type: "object"
      properties: {
        error_message: {
          type: "array"
          description: "The message when the scheduled instance has run and failed due to user error."
          items: {
            type: "array"
            items: {
              type: "object"
              properties: {
                error_description: {
                  type: "string"
                  description: "The error description in English."
                }
                error_description_translated: {
                  type: "string"
                  description: "The error description translated to the user's language."
                }
              }
            }
          }
        }
        request_reference_split_the_bill: {
          type: "array"
          description: "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch"
          items: {
            type: "object"
            properties: {
              id: {
                type: "integer"
                description: "The id of the request inquiry (batch)."
              }
              type: {
                type: "string"
                description: "The type of request inquiry. Can be RequestInquiry or RequestInquiryBatch."
              }
            }
          }
        }
        result_object: {
          type: "object"
          properties: {
            Payment: {
              type: "object"
              properties: {
                address_billing: {
                  type: "object"
                  properties: {
                    city: {
                      type: "string"
                      description: "The city."
                    }
                    country: {
                      type: "string"
                      description: "The country as an ISO 3166-1 alpha-2 country code."
                    }
                    extra: {
                      type: "string"
                      description: "The apartment, building or other extra information for addresses."
                    }
                    house_number: {
                      type: "string"
                      description: "The house number."
                    }
                    is_user_address_updated: {
                      type: "boolean"
                      description: "To show whether user created or updated her address for app event listing."
                    }
                    mailbox_name: {
                      type: "string"
                      description: "The name on the mailbox (only used for Postal addresses)."
                    }
                    po_box: {
                      type: "string"
                      description: "The PO box."
                    }
                    postal_code: {
                      type: "string"
                      description: "The postal code."
                    }
                    province: {
                      type: "string"
                      description: "The province according to local standard."
                    }
                    street: {
                      type: "string"
                      description: "The street."
                    }
                  }
                }
                address_shipping: {
                  type: "object"
                  additionalProperties: true
                }
                alias: {
                  type: "object"
                  properties: {
                    avatar: {
                      type: "object"
                      properties: {
                        anchor_uuid: {
                          type: "string"
                          description: "The public UUID of object this avatar is anchored to."
                        }
                        image: {
                          type: "array"
                          description: "The actual image information of this avatar."
                          items: {
                            type: "object"
                            properties: {
                              attachment_public_uuid: {
                                type: "object"
                                additionalProperties: true
                              }
                              content_type: {
                                type: "object"
                                additionalProperties: true
                              }
                              height: {
                                type: "object"
                                additionalProperties: true
                              }
                              width: {
                                type: "object"
                                additionalProperties: true
                              }
                            }
                          }
                        }
                        style: {
                          type: "string"
                          description: "The style (if applicable) for this Avatar."
                        }
                        uuid: {
                          type: "string"
                          description: "The public UUID of the avatar."
                        }
                      }
                    }
                    bunq_me: {
                      type: "object"
                      properties: {
                        name: {
                          type: "string"
                          description: "The alias name."
                        }
                        service: {
                          type: "string"
                          description: "The pointer service. Only required for external counterparties."
                        }
                        type: {
                          type: "string"
                          description: "The alias type, can be: EMAIL|PHONE_NUMBER|IBAN."
                        }
                        value: {
                          type: "string"
                          description: "The alias value."
                        }
                      }
                    }
                    country: {
                      type: "string"
                      description: "The country of the user. Formatted as a ISO 3166-1 alpha-2 country code."
                    }
                    display_name: {
                      type: "string"
                      description: "The name to display with this monetary account."
                    }
                    iban: {
                      type: "string"
                      description: "The IBAN of the monetary account."
                    }
                    is_light: {
                      type: "boolean"
                      description: "Whether or not the monetary account is light."
                    }
                    label_user: {
                      type: "object"
                      properties: {
                        avatar: {
                          type: "object"
                          additionalProperties: true
                        }
                        country: {
                          type: "string"
                          description: "The country of the user. 000 stands for \"unknown\""
                        }
                        display_name: {
                          type: "string"
                          description: "The name to be displayed for this user, as it was given on the request."
                        }
                        public_nick_name: {
                          type: "string"
                          description: "The current nickname of the user."
                        }
                        uuid: {
                          type: "string"
                          description: "The public UUID of the label-user."
                        }
                      }
                    }
                    merchant_category_code: {
                      type: "string"
                      description: "The merchant category code."
                    }
                    swift_account_number: {
                      type: "string"
                      description: "The account number used for a SWIFT payment. May or may not be an IBAN."
                    }
                    swift_bic: {
                      type: "string"
                      description: "The BIC used for a SWIFT payment."
                    }
                    transferwise_account_number: {
                      type: "string"
                      description: "The account number used for a Transferwise payment. May or may not be an IBAN."
                    }
                    transferwise_bank_code: {
                      type: "string"
                      description: "The bank code used for a Transferwise payment. May or may not be a BIC."
                    }
                  }
                }
                allow_bunqto: {
                  type: "boolean"
                  description: "Whether or not sending a bunq.to payment is allowed."
                }
                amount: {
                  type: "object"
                  properties: {
                    currency: {
                      type: "string"
                      description: "The currency of the amount. It is an ISO 4217 formatted currency code."
                    }
                    value: {
                      type: "string"
                      description: "The amount formatted to two decimal places."
                    }
                  }
                }
                attachment: {
                  type: "array"
                  description: "The Attachments attached to the Payment."
                  items: {
                    type: "object"
                    properties: {
                      id: {
                        type: "integer"
                        description: "The id of the attached Attachment."
                      }
                      monetary_account_id: {
                        type: "integer"
                        description: "The id of the MonetaryAccount this Attachment is attached from."
                      }
                    }
                  }
                }
                balance_after_mutation: {
                  type: "object"
                  additionalProperties: true
                }
                batch_id: {
                  type: "integer"
                  description: "The id of the PaymentBatch if this Payment was part of one."
                }
                bunqto_expiry: {
                  type: "string"
                  description: "When bunq.to payment is about to expire."
                }
                bunqto_share_url: {
                  type: "string"
                  description: "The status of the bunq.to payment."
                }
                bunqto_status: {
                  type: "string"
                  description: "The status of the bunq.to payment."
                }
                bunqto_sub_status: {
                  type: "string"
                  description: "The sub status of the bunq.to payment."
                }
                bunqto_time_responded: {
                  type: "string"
                  description: "The timestamp of when the bunq.to payment was responded to."
                }
                counterparty_alias: {
                  type: "object"
                  additionalProperties: true
                }
                created: {
                  type: "string"
                  description: "The timestamp when the Payment was done."
                }
                description: {
                  type: "string"
                  description: "The description for the Payment. Maximum 140 characters for Payments to external IBANs, 9000 characters for Payments to only other bunq MonetaryAccounts."
                }
                geolocation: {
                  type: "object"
                  properties: {
                    altitude: {
                      type: "integer"
                      description: "The altitude for a geolocation restriction."
                    }
                    latitude: {
                      type: "integer"
                      description: "The latitude for a geolocation restriction."
                    }
                    longitude: {
                      type: "integer"
                      description: "The longitude for a geolocation restriction."
                    }
                    radius: {
                      type: "integer"
                      description: "The radius for a geolocation restriction."
                    }
                  }
                }
                id: {
                  type: "integer"
                  description: "The id of the created Payment."
                }
                merchant_reference: {
                  type: "string"
                  description: "Optional data included with the Payment specific to the merchant."
                }
                monetary_account_id: {
                  type: "integer"
                  description: "The id of the MonetaryAccount the Payment was made to or from (depending on whether this is an incoming or outgoing Payment)."
                }
                payment_auto_allocate_instance: {
                  type: "object"
                  properties: {
                    created: {
                      type: "string"
                      description: "The timestamp when the PaymentAutoAllocateInstance was created."
                    }
                    error_message: {
                      type: "array"
                      description: "The error message, if the payment auto allocating failed."
                      items: {
                        type: "object"
                        additionalProperties: true
                      }
                    }
                    id: {
                      type: "integer"
                      description: "The id of the PaymentAutoAllocateInstance."
                    }
                    payment_auto_allocate_id: {
                      type: "integer"
                      description: "The ID of the payment auto allocate this instance belongs to."
                    }
                    payment_batch: {
                      type: "object"
                      properties: {
                        payments: {
                          type: "object"
                          properties: {
                            Payment: {
                              type: "array"
                              items: {
                                type: "object"
                                additionalProperties: true
                              }
                            }
                          }
                        }
                      }
                    }
                    payment_id: {
                      type: "integer"
                      description: "The ID of the payment that triggered the allocating of the payments."
                    }
                    status: {
                      type: "string"
                      description: "The status of the payment auto allocate instance. SUCCEEDED or FAILED."
                    }
                    updated: {
                      type: "string"
                      description: "The timestamp when the PaymentAutoAllocateInstance was last updated."
                    }
                  }
                }
                request_reference_split_the_bill: {
                  type: "array"
                  description: "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch"
                  items: {
                    type: "object"
                    additionalProperties: true
                  }
                }
                scheduled_id: {
                  type: "integer"
                  description: "The id of the JobScheduled if the Payment was scheduled."
                }
                sub_type: {
                  type: "string"
                  description: "The sub-type of the Payment, can be PAYMENT, WITHDRAWAL, REVERSAL, REQUEST, BILLING, SCT, SDD or NLO."
                }
                type: {
                  type: "string"
                  description: "The type of Payment, can be BUNQ, EBA_SCT, EBA_SDD, IDEAL, SWIFT or FIS (card)."
                }
                updated: {
                  type: "string"
                  description: "The timestamp when the Payment was last updated (will be updated when chat messages are received)."
                }
              }
            }
            PaymentBatch: {
              type: "object"
              additionalProperties: true
            }
          }
        }
        scheduled_object: {
          type: "object"
          properties: {
            Payment: {
              type: "object"
              additionalProperties: true
            }
            PaymentBatch: {
              type: "object"
              additionalProperties: true
            }
          }
        }
        state: {
          type: "string"
          description: "The state of the scheduleInstance. (FINISHED_SUCCESSFULLY, RETRY, FAILED_USER_ERROR)"
        }
        time_end: {
          type: "string"
          description: "The schedule end time (UTC)."
        }
        time_start: {
          type: "string"
          description: "The schedule start time (UTC)."
        }
      }
    }
  }
}