action stripe_get_balance_transactions {
  label: "GetBalanceTransactions"
  description: "<p>Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.</p>\n\n<p>Note that this endpoint was previously called “Balance history” and used the path <code>/v1/balance/history</code>.</p>"
  provider: stripe
  method: GET
  path: "/v1/balance_transactions"
  encoding: form
  input: {
    type: "object"
    properties: {
      created: {
        type: "object"
      }
      currency: {
        type: "string"
      }
      ending_before: {
        type: "string"
      }
      expand: {
        type: "array"
        items: {
          type: "string"
        }
      }
      limit: {
        type: "integer"
      }
      payout: {
        type: "string"
      }
      source: {
        type: "string"
      }
      starting_after: {
        type: "string"
      }
      type: {
        type: "string"
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["data", "has_more", "object", "url"]
    properties: {
      data: {
        type: "array"
        items: {
          type: "object"
          description: "Balance transactions represent funds moving through your Stripe account.\nThey're created for every type of transaction that comes into or flows out of your Stripe account balance.\n\nRelated guide: [Balance Transaction Types](https://stripe.com/docs/reports/balance-transaction-types)."
          required: ["amount", "available_on", "created", "currency", "fee", "fee_details", "id", "net", "object", "reporting_category", "status", "type"]
          properties: {
            amount: {
              type: "integer"
              description: "Gross amount of the transaction, in %s."
            }
            available_on: {
              type: "integer"
              format: "unix-time"
              description: "The date the transaction's net funds will become available in the Stripe balance."
            }
            created: {
              type: "integer"
              format: "unix-time"
              description: "Time at which the object was created. Measured in seconds since the Unix epoch."
            }
            currency: {
              type: "string"
              description: "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
            }
            description: {
              type: "string"
              description: "An arbitrary string attached to the object. Often useful for displaying to users."
            }
            exchange_rate: {
              type: "number"
              description: "The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the `amount` in currency A, times `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `exchange_rate` would be `1.234`."
            }
            fee: {
              type: "integer"
              description: "Fees (in %s) paid for this transaction."
            }
            fee_details: {
              type: "array"
              description: "Detailed breakdown of fees (in %s) paid for this transaction."
              items: {
                type: "object"
                required: ["amount", "currency", "type"]
                properties: {
                  amount: {
                    type: "integer"
                    description: "Amount of the fee, in cents."
                  }
                  application: {
                    type: "string"
                    description: "ID of the Connect application that earned the fee."
                  }
                  currency: {
                    type: "string"
                    description: "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
                  }
                  description: {
                    type: "string"
                    description: "An arbitrary string attached to the object. Often useful for displaying to users."
                  }
                  type: {
                    type: "string"
                    description: "Type of the fee, one of: `application_fee`, `stripe_fee` or `tax`."
                  }
                }
              }
            }
            id: {
              type: "string"
              description: "Unique identifier for the object."
            }
            net: {
              type: "integer"
              description: "Net amount of the transaction, in %s."
            }
            object: {
              type: "string"
              description: "String representing the object's type. Objects of the same type share the same value."
              enum: ["balance_transaction"]
            }
            reporting_category: {
              type: "string"
              description: "[Learn more](https://stripe.com/docs/reports/reporting-categories) about how reporting categories can help you understand balance transactions from an accounting perspective."
            }
            source: {
              description: "The Stripe object to which this transaction is related."
              type: "object"
            }
            status: {
              type: "string"
              description: "If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`."
            }
            type: {
              type: "string"
              description: "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. [Learn more](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead."
              enum: ["adjustment", "advance", "advance_funding", "anticipation_repayment", "application_fee", "application_fee_refund", "charge", "connect_collection_transfer", "contribution", "issuing_authorization_hold", "issuing_authorization_release", "issuing_dispute", "issuing_transaction", "payment", "payment_failure_refund", "payment_refund", "payout", "payout_cancel", "payout_failure", "refund", "refund_failure", "reserve_transaction", "reserved_funds", "stripe_fee", "stripe_fx_fee", "tax_fee", "topup", "topup_reversal", "transfer", "transfer_cancel", "transfer_failure", "transfer_refund"]
            }
          }
        }
      }
      has_more: {
        type: "boolean"
        description: "True if this list has another page of items after this one that can be fetched."
      }
      object: {
        type: "string"
        description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        enum: ["list"]
      }
      url: {
        type: "string"
        description: "The URL where this list can be accessed."
      }
    }
  }
}