arcade-mcp/toolkits/xero_api/arcade_xero_api/wrapper_tools/RetrieveFullChartOfAccounts.json
2025-10-10 16:35:55 -03:00

204 lines
6.2 KiB
JSON

{
"name": "RetrieveFullChartOfAccounts",
"fully_qualified_name": "XeroApi.RetrieveFullChartOfAccounts@0.1.0",
"description": "Retrieves the full chart of accounts from Xero.\n\nUse this tool to obtain the complete chart of accounts from Xero, which includes all accounting categories and their details. It is useful for analyzing financial structures within the Xero platform.",
"toolkit": {
"name": "ArcadeXeroApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "xero_tenant_identifier",
"required": true,
"description": "Unique identifier for the Xero tenant to retrieve its accounts.",
"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_attribute",
"required": false,
"description": "Filter accounts by specific attributes or conditions using string syntax.",
"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_by_element",
"required": false,
"description": "Specify a field to order the returned accounts (e.g., 'Name' or 'AccountType').",
"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": "only_modified_since_timestamp",
"required": false,
"description": "Specify a timestamp to return only records created or modified since that time. The timestamp should be in 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 'getAccounts'.",
"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.settings",
"accounting.settings.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/Accounts",
"http_method": "GET",
"headers": {
"Accept": "application/json"
},
"parameters": [
{
"name": "where",
"tool_parameter_name": "filter_by_attribute",
"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_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": "xero-tenant-id",
"tool_parameter_name": "xero_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": "If-Modified-Since",
"tool_parameter_name": "only_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
}
]
}
}