action up_get_transactions {
  label: "List transactions"
  description: "Retrieve a list of all transactions across all accounts for the currently\nauthenticated user. The returned list is [paginated](#pagination) and can\nbe scrolled by following the `next` and `prev` links where present. To\nnarrow the results to a specific date range pass one or both of\n`filter[since]` and `filter[until]` in the query string. These filter\nparameters **should not** be used for pagination. Results are ordered\nnewest first to oldest last.\n"
  provider: up
  method: GET
  path: "/transactions"
  encoding: json
  input: {
    type: "object"
    properties: {
      "filter[category]": {
        type: "string"
      }
      "filter[since]": {
        type: "string"
        format: "date-time"
      }
      "filter[status]": {
        description: "Specifies which stage of processing a transaction is currently at.\nCurrently returned values are `HELD` and `SETTLED`. When a transaction is\nheld, its account’s `availableBalance` is affected. When a transaction is\nsettled, its account’s `currentBalance` is affected.\n"
        enum: ["HELD", "SETTLED"]
        type: "object"
      }
      "filter[tag]": {
        type: "string"
      }
      "filter[until]": {
        type: "string"
        format: "date-time"
      }
      "page[size]": {
        type: "integer"
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "Successful response to get all transactions. This returns a paginated\nlist of transactions, which can be scrolled by following the `prev` and\n`next` links if present.\n"
    required: ["data", "links"]
    properties: {
      data: {
        type: "array"
        description: "The list of transactions returned in this response.\n"
        items: {
          type: "object"
          required: ["type", "id", "attributes", "relationships"]
          properties: {
            attributes: {
              type: "object"
              required: ["status", "rawText", "description", "message", "isCategorizable", "holdInfo", "roundUp", "cashback", "amount", "foreignAmount", "settledAt", "createdAt"]
              properties: {
                amount: {
                  description: "The amount of this transaction in Australian dollars. For\ntransactions that were once `HELD` but are now `SETTLED`, refer to\nthe `holdInfo` field for the original `amount` the transaction was\n`HELD` at.\n"
                  type: "object"
                }
                cashback: {
                  description: "If all or part of this transaction was instantly reimbursed in the\nform of cashback, details of the reimbursement.\n"
                  type: "object"
                }
                createdAt: {
                  type: "string"
                  format: "date-time"
                  description: "The date-time at which this transaction was first encountered.\n"
                }
                description: {
                  type: "string"
                  description: "A short description for this transaction. Usually the merchant name\nfor purchases.\n"
                }
                foreignAmount: {
                  description: "The foreign currency amount of this transaction. This field will be\n`null` for domestic transactions. The amount was converted to the AUD\namount reflected in the `amount` of this transaction. Refer to the\n`holdInfo` field for the original `foreignAmount` the transaction was\n`HELD` at.\n"
                  type: "object"
                }
                holdInfo: {
                  description: "If this transaction is currently in the `HELD` status, or was ever in\nthe `HELD` status, the `amount` and `foreignAmount` of the\ntransaction while `HELD`.\n"
                  type: "object"
                }
                isCategorizable: {
                  type: "boolean"
                  description: "Boolean flag set to true on transactions that support the use of\ncategories.\n"
                }
                message: {
                  type: "string"
                  description: "Attached message for this transaction, such as a payment message, or a\ntransfer note.\n"
                }
                rawText: {
                  type: "string"
                  description: "The original, unprocessed text of the transaction. This is often not\na perfect indicator of the actual merchant, but it is useful for\nreconciliation purposes in some cases.\n"
                }
                roundUp: {
                  description: "Details of how this transaction was rounded-up. If no Round Up was\napplied this field will be `null`.\n"
                  type: "object"
                }
                settledAt: {
                  type: "string"
                  format: "date-time"
                  description: "The date-time at which this transaction settled. This field will be\n`null` for transactions that are currently in the `HELD` status.\n"
                }
                status: {
                  description: "The current processing status of this transaction, according to\nwhether or not this transaction has settled or is still held.\n"
                  type: "object"
                }
              }
            }
            id: {
              type: "string"
              description: "The unique identifier for this transaction.\n"
            }
            links: {
              type: "object"
              required: ["self"]
              properties: {
                self: {
                  type: "string"
                  description: "The canonical link to this resource within the API.\n"
                }
              }
            }
            relationships: {
              type: "object"
              required: ["account", "transferAccount", "category", "parentCategory", "tags"]
              properties: {
                account: {
                  type: "object"
                  required: ["data"]
                  properties: {
                    data: {
                      type: "object"
                      required: ["type", "id"]
                      properties: {
                        id: {
                          type: "string"
                          description: "The unique identifier of the resource within its type.\n"
                        }
                        type: {
                          type: "string"
                          description: "The type of this resource: `accounts`"
                        }
                      }
                    }
                    links: {
                      type: "object"
                      required: ["related"]
                      properties: {
                        related: {
                          type: "string"
                          description: "The link to retrieve the related resource(s) in this relationship.\n"
                        }
                      }
                    }
                  }
                }
                category: {
                  type: "object"
                  required: ["data"]
                  properties: {
                    data: {
                      type: "object"
                      required: ["type", "id"]
                      properties: {
                        id: {
                          type: "string"
                          description: "The unique identifier of the resource within its type.\n"
                        }
                        type: {
                          type: "string"
                          description: "The type of this resource: `categories`"
                        }
                      }
                    }
                    links: {
                      type: "object"
                      required: ["self"]
                      properties: {
                        related: {
                          type: "string"
                          description: "The link to retrieve the related resource(s) in this relationship.\n"
                        }
                        self: {
                          type: "string"
                          description: "The link to retrieve or modify linkage between this resources and the\nrelated resource(s) in this relationship.\n"
                        }
                      }
                    }
                  }
                }
                parentCategory: {
                  type: "object"
                  required: ["data"]
                  properties: {
                    data: {
                      type: "object"
                      required: ["type", "id"]
                      properties: {
                        id: {
                          type: "string"
                          description: "The unique identifier of the resource within its type.\n"
                        }
                        type: {
                          type: "string"
                          description: "The type of this resource: `categories`"
                        }
                      }
                    }
                    links: {
                      type: "object"
                      required: ["related"]
                      properties: {
                        related: {
                          type: "string"
                          description: "The link to retrieve the related resource(s) in this relationship.\n"
                        }
                      }
                    }
                  }
                }
                tags: {
                  type: "object"
                  required: ["data"]
                  properties: {
                    data: {
                      type: "array"
                      items: {
                        type: "object"
                        required: ["type", "id"]
                        properties: {
                          id: {
                            type: "string"
                            description: "The label of the tag, which also acts as the tag’s unique identifier.\n"
                          }
                          type: {
                            type: "string"
                            description: "The type of this resource: `tags`"
                          }
                        }
                      }
                    }
                    links: {
                      type: "object"
                      required: ["self"]
                      properties: {
                        self: {
                          type: "string"
                          description: "The link to retrieve or modify linkage between this resources and the\nrelated resource(s) in this relationship.\n"
                        }
                      }
                    }
                  }
                }
                transferAccount: {
                  type: "object"
                  description: "If this transaction is a transfer between accounts, this relationship\nwill contain the account the transaction went to/came from. The\n`amount` field can be used to determine the direction of the transfer.\n"
                  required: ["data"]
                  properties: {
                    data: {
                      type: "object"
                      required: ["type", "id"]
                      properties: {
                        id: {
                          type: "string"
                          description: "The unique identifier of the resource within its type.\n"
                        }
                        type: {
                          type: "string"
                          description: "The type of this resource: `accounts`"
                        }
                      }
                    }
                    links: {
                      type: "object"
                      required: ["related"]
                      properties: {
                        related: {
                          type: "string"
                          description: "The link to retrieve the related resource(s) in this relationship.\n"
                        }
                      }
                    }
                  }
                }
              }
            }
            type: {
              type: "string"
              description: "The type of this resource: `transactions`"
            }
          }
        }
      }
      links: {
        type: "object"
        required: ["next", "prev"]
        properties: {
          next: {
            type: "string"
            description: "The link to the next page in the results. If this value is `null`\nthere is no next page.\n"
          }
          prev: {
            type: "string"
            description: "The link to the previous page in the results. If this value is `null`\nthere is no previous page.\n"
          }
        }
      }
    }
  }
}