arcade-mcp/toolkits/squareup_api/arcade_squareup_api/wrapper_tools/CancelInvoice.json

{
  "name": "CancelInvoice",
  "fully_qualified_name": "SquareupApi.CancelInvoice@2.0.0",
  "description": "Cancel an invoice to prevent further transactions.\n\nThis tool cancels an invoice, ensuring that no payments can be collected. It cannot be used for invoices in the `DRAFT`, `PAID`, `REFUNDED`, `CANCELED`, or `FAILED` states.",
  "toolkit": {
    "name": "ArcadeSquareupApi",
    "description": null,
    "version": "2.0.0"
  },
  "input": {
    "parameters": [
      {
        "name": "invoice_id",
        "required": true,
        "description": "The ID of the invoice you want to cancel. This is required to specify which invoice will be affected.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID of the [invoice](entity:Invoice) to cancel."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "invoice_id"
      },
      {
        "name": "invoice_version_to_cancel",
        "required": true,
        "description": "The version number of the invoice to be canceled. Use GetInvoice or ListInvoices to find it if unknown.",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The version of the [invoice](entity:Invoice) to cancel.\nIf you do not know the version, you can call \n[GetInvoice](api-endpoint:Invoices-GetInvoice) or [ListInvoices](api-endpoint:Invoices-ListInvoices)."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "version"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'CancelInvoice'.",
    "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-squareup",
      "provider_type": "oauth2",
      "id": null,
      "oauth2": {
        "scopes": [
          "INVOICES_WRITE",
          "ORDERS_WRITE"
        ]
      }
    },
    "secrets": null,
    "metadata": null
  },
  "deprecation_message": null,
  "metadata": {
    "object_type": "api_wrapper_tool",
    "version": "1.1.0",
    "description": "Tools that enable LLMs to interact directly with the squareup API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.2.0",
      "description": ""
    },
    "url": "https://connect.squareup.com/v2/invoices/{invoice_id}/cancel",
    "http_method": "POST",
    "headers": {},
    "parameters": [
      {
        "name": "invoice_id",
        "tool_parameter_name": "invoice_id",
        "description": "The ID of the [invoice](entity:Invoice) to cancel.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID of the [invoice](entity:Invoice) to cancel."
        },
        "accepted_as": "path",
        "required": true,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "version",
        "tool_parameter_name": "invoice_version_to_cancel",
        "description": "The version of the [invoice](entity:Invoice) to cancel.\nIf you do not know the version, you can call \n[GetInvoice](api-endpoint:Invoices-GetInvoice) or [ListInvoices](api-endpoint:Invoices-ListInvoices).",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The version of the [invoice](entity:Invoice) to cancel.\nIf you do not know the version, you can call \n[GetInvoice](api-endpoint:Invoices-GetInvoice) or [ListInvoices](api-endpoint:Invoices-ListInvoices)."
        },
        "accepted_as": "body",
        "required": true,
        "deprecated": false,
        "default": null,
        "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
      }
    ],
    "request_body_spec": "{\n  \"required\": true,\n  \"description\": \"An object containing the fields to POST for the request.\\n\\nSee the corresponding object definition for field details.\",\n  \"content\": {\n    \"application/json\": {\n      \"schema\": {\n        \"type\": \"object\",\n        \"description\": \"Describes a `CancelInvoice` request.\",\n        \"x-release-status\": \"PUBLIC\",\n        \"required\": [\n          \"version\"\n        ],\n        \"properties\": {\n          \"version\": {\n            \"type\": \"integer\",\n            \"description\": \"The version of the [invoice](entity:Invoice) to cancel.\\nIf you do not know the version, you can call \\n[GetInvoice](api-endpoint:Invoices-GetInvoice) or [ListInvoices](api-endpoint:Invoices-ListInvoices).\"\n          }\n        },\n        \"example\": {\n          \"version\": 0\n        }\n      }\n    }\n  }\n}",
    "use_request_body_schema_mode": false,
    "validate_request_body_schema": false
  }
}