{
  "name": "RetrievePurchaseOrders",
  "fully_qualified_name": "XeroApi.RetrievePurchaseOrders@0.1.0",
  "description": "Retrieve purchase orders from Xero.\n\nUse this tool to obtain purchase orders from Xero. Call when you need a list of purchase orders with details such as order status, dates, and amounts.",
  "toolkit": {
    "name": "ArcadeXeroApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "xero_tenant_id",
        "required": true,
        "description": "Unique identifier for the Xero tenant to access specific organization's 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_status",
        "required": false,
        "description": "Filter purchase orders by status. Accepted values are: 'DRAFT', 'SUBMITTED', 'AUTHORISED', 'BILLED', 'DELETED'.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": [
            "DRAFT",
            "SUBMITTED",
            "AUTHORISED",
            "BILLED",
            "DELETED"
          ],
          "properties": null,
          "inner_properties": null,
          "description": "Filter by purchase order status"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "Status"
      },
      {
        "name": "filter_by_start_date",
        "required": false,
        "description": "Specify the start date for filtering purchase orders. Use format 'YYYY-MM-DD'.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "DateFrom"
      },
      {
        "name": "filter_by_end_date",
        "required": false,
        "description": "Filter purchase orders by end date (format: YYYY-MM-DD).",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "DateTo"
      },
      {
        "name": "order_by_element",
        "required": false,
        "description": "Specifies the element by which to sort the purchase orders, such as date or status. Accepts any valid field name.",
        "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": "page_number",
        "required": false,
        "description": "Specifies the page of results to retrieve. Increment to access subsequent pages of purchase orders.",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "page"
      },
      {
        "name": "records_per_page",
        "required": false,
        "description": "Specify the number of purchase order 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"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "pageSize"
      },
      {
        "name": "modified_since_timestamp",
        "required": false,
        "description": "Timestamp to filter records created or modified since this time. Use ISO 8601 format (e.g., '2023-01-01T00:00:00Z').",
        "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 'getPurchaseOrders'.",
    "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/PurchaseOrders",
    "http_method": "GET",
    "headers": {
      "Accept": "application/json"
    },
    "parameters": [
      {
        "name": "Status",
        "tool_parameter_name": "filter_by_status",
        "description": "Filter by purchase order status",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": [
            "DRAFT",
            "SUBMITTED",
            "AUTHORISED",
            "BILLED",
            "DELETED"
          ],
          "properties": null,
          "inner_properties": null,
          "description": "Filter by purchase order status"
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "DateFrom",
        "tool_parameter_name": "filter_by_start_date",
        "description": "Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31"
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "DateTo",
        "tool_parameter_name": "filter_by_end_date",
        "description": "Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31"
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "order",
        "tool_parameter_name": "order_by_element",
        "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": "page_number",
        "description": "To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned.",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned."
        },
        "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
      }
    ]
  }
}