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

{
  "name": "RetrieveInvoiceAttachmentById",
  "fully_qualified_name": "XeroApi.RetrieveInvoiceAttachmentById@0.1.0",
  "description": "Retrieve a specific invoice attachment by ID.\n\nUse this tool to obtain a specific attachment from an invoice or purchase bill using its unique attachment ID in Xero. Call this tool when you need to access or review an attachment related to an invoice.",
  "toolkit": {
    "name": "ArcadeXeroApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "invoice_id",
        "required": true,
        "description": "The unique identifier for the invoice to retrieve the attachment from.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Unique identifier for an Invoice"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "InvoiceID"
      },
      {
        "name": "attachment_id",
        "required": true,
        "description": "Unique identifier for the attachment object in Xero.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Unique identifier for Attachment object"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "AttachmentID"
      },
      {
        "name": "tenant_identifier",
        "required": true,
        "description": "Xero identifier for the tenant. Required to specify the tenant from which the attachment is being retrieved.",
        "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": "attachment_mime_type",
        "required": true,
        "description": "The MIME type of the attachment file, e.g., image/jpg or application/pdf.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "contentType"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'getInvoiceAttachmentById'.",
    "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.attachments",
          "accounting.attachments.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/Invoices/{InvoiceID}/Attachments/{AttachmentID}",
    "http_method": "GET",
    "headers": {
      "Accept": "application/json"
    },
    "parameters": [
      {
        "name": "InvoiceID",
        "tool_parameter_name": "invoice_id",
        "description": "Unique identifier for an Invoice",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Unique identifier for an Invoice"
        },
        "accepted_as": "path",
        "required": true,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "AttachmentID",
        "tool_parameter_name": "attachment_id",
        "description": "Unique identifier for Attachment object",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Unique identifier for Attachment object"
        },
        "accepted_as": "path",
        "required": true,
        "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": []
      },
      {
        "name": "contentType",
        "tool_parameter_name": "attachment_mime_type",
        "description": "The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf"
        },
        "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
      }
    ]
  }
}