{
  "name": "RetrieveBankTransactions",
  "fully_qualified_name": "XeroApi.RetrieveBankTransactions@0.1.0",
  "description": "Retrieve spent or received money transactions from Xero.\n\nUse this tool to get a list of transactions where money was spent or received. This is useful for financial tracking and reporting.",
  "toolkit": {
    "name": "ArcadeXeroApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "xero_tenant_id",
        "required": true,
        "description": "Xero identifier for the Tenant, required to specify which account to access.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Xero identifier for Tenant"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "xero-tenant-id"
      },
      {
        "name": "filter_by_element",
        "required": false,
        "description": "Specify criteria to filter transactions by any element. Use valid filter expressions based on transaction fields.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Filter by an any element"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "where"
      },
      {
        "name": "order_transactions_by",
        "required": false,
        "description": "Specify the element by which to order the transactions, such as date or amount.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Order by an any element"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "order"
      },
      {
        "name": "transaction_page_number",
        "required": false,
        "description": "Specifies which page of up to 100 bank transactions to retrieve.",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Up to 100 bank transactions will be returned in a single API call with line items details"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "page"
      },
      {
        "name": "use_four_decimal_places",
        "required": false,
        "description": "Indicate if unit amounts should use four decimal places (e.g., 4).",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "e.g. unitdp=4 \u2013 (Unit Decimal Places) You can opt in to use four decimal places for unit amounts"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "unitdp"
      },
      {
        "name": "records_per_page",
        "required": false,
        "description": "Specify the number of records to retrieve per page. This controls the pagination size.",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Number of records to retrieve per page"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "pageSize"
      },
      {
        "name": "modified_since_timestamp",
        "required": false,
        "description": "Return records created or modified since this UTC timestamp (ISO 8601 format).",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Only records created or modified since this timestamp will be returned"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "If-Modified-Since"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'getBankTransactions'.",
    "available_modes": [
      "value",
      "error",
      "null"
    ],
    "value_schema": {
      "val_type": "json",
      "inner_val_type": null,
      "enum": null,
      "properties": null,
      "inner_properties": null,
      "description": null
    }
  },
  "requirements": {
    "authorization": {
      "provider_id": "arcade-xero",
      "provider_type": "oauth2",
      "id": null,
      "oauth2": {
        "scopes": [
          "accounting.transactions.read",
          "accounting.transactions"
        ]
      }
    },
    "secrets": null,
    "metadata": null
  },
  "deprecation_message": null,
  "metadata": {
    "object_type": "api_wrapper_tool",
    "version": "1.0.0",
    "description": "Tools that enable LLMs to interact directly with the Xero API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.0.0",
      "description": ""
    },
    "url": "https://api.xero.com/api.xro/2.0/BankTransactions",
    "http_method": "GET",
    "headers": {
      "Accept": "application/json"
    },
    "parameters": [
      {
        "name": "where",
        "tool_parameter_name": "filter_by_element",
        "description": "Filter by an any element",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Filter by an any element"
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "order",
        "tool_parameter_name": "order_transactions_by",
        "description": "Order by an any element",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Order by an any element"
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "page",
        "tool_parameter_name": "transaction_page_number",
        "description": "Up to 100 bank transactions will be returned in a single API call with line items details",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Up to 100 bank transactions will be returned in a single API call with line items details"
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "unitdp",
        "tool_parameter_name": "use_four_decimal_places",
        "description": "e.g. unitdp=4 \u2013 (Unit Decimal Places) You can opt in to use four decimal places for unit amounts",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "e.g. unitdp=4 \u2013 (Unit Decimal Places) You can opt in to use four decimal places for unit amounts"
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "pageSize",
        "tool_parameter_name": "records_per_page",
        "description": "Number of records to retrieve per page",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Number of records to retrieve per page"
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "xero-tenant-id",
        "tool_parameter_name": "xero_tenant_id",
        "description": "Xero identifier for Tenant",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Xero identifier for Tenant"
        },
        "accepted_as": "header",
        "required": true,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "If-Modified-Since",
        "tool_parameter_name": "modified_since_timestamp",
        "description": "Only records created or modified since this timestamp will be returned",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Only records created or modified since this timestamp will be returned"
        },
        "accepted_as": "header",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      }
    ],
    "documentation_urls": [],
    "secrets": [
      {
        "arcade_key": "auth_token",
        "parameter_name": "Authorization",
        "accepted_as": "header",
        "formatted_value": "Bearer {authorization}",
        "description": "The OAuth token to use for authentication.",
        "is_auth_token": true
      }
    ]
  }
}