268 lines
8.4 KiB
JSON
268 lines
8.4 KiB
JSON
{
|
|
"name": "RetrieveManualJournals",
|
|
"fully_qualified_name": "XeroApi.RetrieveManualJournals@0.1.0",
|
|
"description": "Retrieve manual journals from Xero.\n\nUse this tool to get a list of manual journals from Xero, typically when needing insights into financial entries or audits.",
|
|
"toolkit": {
|
|
"name": "ArcadeXeroApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "tenant_identifier",
|
|
"required": true,
|
|
"description": "The unique Xero identifier for the Tenant to retrieve manual journals from.",
|
|
"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_criteria",
|
|
"required": false,
|
|
"description": "Filter manual journals based on specified criteria, such as date or amount.",
|
|
"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 the element to order the results by. Use field names like date, amount, etc.",
|
|
"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": "The page number to retrieve, e.g., page=1. Returns up to 100 manual journals per call.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "e.g. page=1 \u2013 Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment"
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "page"
|
|
},
|
|
{
|
|
"name": "records_per_page",
|
|
"required": false,
|
|
"description": "Specify the number of manual journal 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": "Retrieve records created or modified since this timestamp (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 'getManualJournals'.",
|
|
"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/ManualJournals",
|
|
"http_method": "GET",
|
|
"headers": {
|
|
"Accept": "application/json"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "where",
|
|
"tool_parameter_name": "filter_criteria",
|
|
"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": "page",
|
|
"tool_parameter_name": "page_number",
|
|
"description": "e.g. page=1 \u2013 Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "e.g. page=1 \u2013 Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment"
|
|
},
|
|
"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": "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": "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
|
|
}
|
|
]
|
|
}
|
|
}
|