arcade-mcp/toolkits/xero_api/arcade_xero_api/wrapper_tools/RetrieveBudgets.json

{
  "name": "RetrieveBudgets",
  "fully_qualified_name": "XeroApi.RetrieveBudgets@0.1.0",
  "description": "Retrieve a list of budgets from Xero.\n\nUse this tool to obtain detailed budgeting information from the Xero platform, helping manage and analyze budget data.",
  "toolkit": {
    "name": "ArcadeXeroApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "tenant_identifier",
        "required": true,
        "description": "The unique Xero identifier for the tenant. Required for accessing specific tenant data.",
        "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_budget_id",
        "required": false,
        "description": "Filter to retrieve a specific budget by its BudgetID.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Filter by BudgetID. Allows you to retrieve a specific individual budget."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "IDs"
      },
      {
        "name": "filter_start_date",
        "required": false,
        "description": "The start date to filter budgets until. Expected format is YYYY-MM-DD.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Filter by start date"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "DateTo"
      },
      {
        "name": "filter_by_end_date",
        "required": false,
        "description": "Specify the end date to filter the budgets. Use the format YYYY-MM-DD.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Filter by end date"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "DateFrom"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'getBudgets'.",
    "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.budgets.read"
        ]
      }
    },
    "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/Budgets",
    "http_method": "GET",
    "headers": {
      "Accept": "application/json"
    },
    "parameters": [
      {
        "name": "IDs",
        "tool_parameter_name": "filter_by_budget_id",
        "description": "Filter by BudgetID. Allows you to retrieve a specific individual budget.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Filter by BudgetID. Allows you to retrieve a specific individual budget."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "DateTo",
        "tool_parameter_name": "filter_start_date",
        "description": "Filter by start date",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Filter by start date"
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "DateFrom",
        "tool_parameter_name": "filter_by_end_date",
        "description": "Filter by end date",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Filter by end date"
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "xero-tenant-id",
        "tool_parameter_name": "tenant_identifier",
        "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": []
      }
    ],
    "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
      }
    ]
  }
}