@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/get_task_report.json

@@ -0,0 +1,64 @@
+{
+  "slug": "get_task_report",
+  "operationId": "getTaskReport",
+  "method": "POST",
+  "path": "/api/v1/reports/tasks",
+  "name": "Task reports",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export task reports",
+  "whenToUse": "Export a paginated report of task and time-tracking records over a date range; use for logged work/billable time, not the projects above them",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "per_page",
+      "type": "integer",
+      "required": false,
+      "description": "The number of records to return for each request, default is 20",
+      "example": 20
+    },
+    {
+      "name": "page",
+      "type": "integer",
+      "required": false,
+      "description": "The page number to return for this request (when performing pagination), default is 1",
+      "example": 1
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "date_range",
+        "type": "string",
+        "required": false,
+        "description": "The string representation of the date range of data to be returned"
+      },
+      {
+        "name": "date_key",
+        "type": "string",
+        "required": false,
+        "description": "The date column to search between."
+      },
+      {
+        "name": "start_date",
+        "type": "string",
+        "required": false,
+        "description": "The start date to search between"
+      },
+      {
+        "name": "end_date",
+        "type": "string",
+        "required": false,
+        "description": "The end date to search between"
+      },
+      {
+        "name": "report_keys",
+        "type": "array",
+        "required": false
+      }
+    ],
+    "schemaRef": "GenericReportSchema"
+  }
+}

package/dist/catalog/endpoints/get_task_scheduler.json

@@ -0,0 +1,38 @@
+{
+  "slug": "get_task_scheduler",
+  "operationId": "getTaskScheduler",
+  "method": "GET",
+  "path": "/api/v1/task_schedulers/create",
+  "name": "Gets a new blank scheduler object",
+  "category": "task_schedulers",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank scheduler object with default values to prefill a new scheduler before calling create_task_scheduler.",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "include",
+      "type": "string",
+      "required": false,
+      "description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
+      "example": "first_load"
+    },
+    {
+      "name": "per_page",
+      "type": "integer",
+      "required": false,
+      "description": "The number of records to return for each request, default is 20",
+      "example": 20
+    },
+    {
+      "name": "page",
+      "type": "integer",
+      "required": false,
+      "description": "The page number to return for this request (when performing pagination), default is 1",
+      "example": 1
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "TaskSchedulerSchema"
+}

package/dist/catalog/endpoints/get_task_schedulers.json

@@ -0,0 +1,15 @@
+{
+  "slug": "get_task_schedulers",
+  "operationId": "getTaskSchedulers",
+  "method": "GET",
+  "path": "/api/v1/task_schedulers",
+  "name": "Task Scheduler Index",
+  "category": "task_schedulers",
+  "mutating": false,
+  "description": "Get all schedulers with associated jobs",
+  "whenToUse": "List all task schedulers with their associated jobs; use to browse or find scheduled recurring jobs.",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/get_task_statuses.json

@@ -0,0 +1,54 @@
+{
+  "slug": "get_task_statuses",
+  "operationId": "getTaskStatuses",
+  "method": "GET",
+  "path": "/api/v1/task_statuses",
+  "name": "Gets a list of task statuses",
+  "category": "task_status",
+  "mutating": false,
+  "description": "Lists task statuses",
+  "whenToUse": "List or filter many task statuses with pagination, sorting, and includes; use to browse all statuses, not to fetch one by id.",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "include",
+      "type": "string",
+      "required": false,
+      "description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
+      "example": "first_load"
+    },
+    {
+      "name": "index",
+      "type": "string",
+      "required": false,
+      "description": "Replaces the default response index from data to a user specific string\n\nie.\n\n```html\n  ?index=new_index\n```\n\nresponse is wrapped\n\n```json\n  {\n    'new_index' : [\n      .....\n    ]\n  }\n```",
+      "example": "user"
+    },
+    {
+      "name": "per_page",
+      "type": "integer",
+      "required": false,
+      "description": "The number of records to return for each request, default is 20",
+      "example": 20
+    },
+    {
+      "name": "page",
+      "type": "integer",
+      "required": false,
+      "description": "The page number to return for this request (when performing pagination), default is 1",
+      "example": 1
+    },
+    {
+      "name": "sort",
+      "type": "array",
+      "required": false,
+      "description": "Order the list by choosing a column and direction. Each value uses the form `column|asc` or `column|desc`.\n\n*Single sort** — for example `sort=sort_order|asc`.\n\n*Multiple sorts** — for example\n`sort[]=sort_order|asc&sort[]=name|asc`.\n\nOnly `task_statuses` columns are recognized. Unsupported keys are ignored.",
+      "example": [
+        "sort_order|asc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "TaskStatus[]"
+}

package/dist/catalog/endpoints/get_task_statuss_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_task_statuss_create",
+  "operationId": "getTaskStatussCreate",
+  "method": "GET",
+  "path": "/api/v1/task_statuses/create",
+  "name": "Gets a new blank TaskStatus object",
+  "category": "task_status",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Get a blank task status template with default values to prefill a create form; read-only, does not save anything.",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "include",
+      "type": "string",
+      "required": false,
+      "description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
+      "example": "first_load"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "TaskStatus"
+}

package/dist/catalog/endpoints/get_tasks.json

@@ -0,0 +1,55 @@
+{
+  "slug": "get_tasks",
+  "operationId": "getTasks",
+  "method": "GET",
+  "path": "/api/v1/tasks",
+  "name": "List tasks",
+  "category": "tasks",
+  "mutating": false,
+  "description": "Lists tasks, search and filters allow fine grained lists to be generated.\n\n  Query parameters can be added to performed more fine grained filtering of the tasks, these are handled by the TaskFilters class which defines the methods available",
+  "whenToUse": "List or filter many tasks with pagination, includes, and sort; use when you need a set of task records, not one by id.",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "include",
+      "type": "string",
+      "required": false,
+      "description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
+      "example": "first_load"
+    },
+    {
+      "name": "index",
+      "type": "string",
+      "required": false,
+      "description": "Replaces the default response index from data to a user specific string\n\nie.\n\n```html\n  ?index=new_index\n```\n\nresponse is wrapped\n\n```json\n  {\n    'new_index' : [\n      .....\n    ]\n  }\n```",
+      "example": "user"
+    },
+    {
+      "name": "per_page",
+      "type": "integer",
+      "required": false,
+      "description": "The number of records to return for each request, default is 20",
+      "example": 20
+    },
+    {
+      "name": "page",
+      "type": "integer",
+      "required": false,
+      "description": "The page number to return for this request (when performing pagination), default is 1",
+      "example": 1
+    },
+    {
+      "name": "sort",
+      "type": "array",
+      "required": false,
+      "description": "Order the list by choosing a column and direction. Each value uses the form `column|asc` or `column|desc`.\n\n*Single sort** — for example `sort=due_date|asc`.\n\n*Multiple sorts** — for example\n`sort[]=status_id|asc&sort[]=id|desc`.\n\nTasks accept `tasks` columns plus `client.name`, `client_id`, `contact.*`, and `documents` where the filter implements them. Unsupported keys are ignored.",
+      "example": [
+        "due_date|asc",
+        "id|desc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Task[]"
+}

package/dist/catalog/endpoints/get_tasks_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_tasks_create",
+  "operationId": "getTasksCreate",
+  "method": "GET",
+  "path": "/api/v1/tasks/create",
+  "name": "Blank task",
+  "category": "tasks",
+  "mutating": false,
+  "description": "Returns a blank task with default values",
+  "whenToUse": "GET a blank task object with default values (read-only); use to pre-populate a create form before calling store_task.",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "include",
+      "type": "string",
+      "required": false,
+      "description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
+      "example": "first_load"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Task"
+}

package/dist/catalog/endpoints/get_tax_period_report.json

@@ -0,0 +1,49 @@
+{
+  "slug": "get_tax_period_report",
+  "operationId": "getTaxPeriodReport",
+  "method": "POST",
+  "path": "/api/v1/reports/tax_period_report",
+  "name": "Tax period report",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export tax period report",
+  "whenToUse": "Export a tax report broken out by reporting period over a date range; use for period-by-period tax filing, not a single rolled-up summary",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "date_range",
+        "type": "string",
+        "required": false,
+        "description": "The string representation of the date range of data to be returned"
+      },
+      {
+        "name": "date_key",
+        "type": "string",
+        "required": false,
+        "description": "The date column to search between."
+      },
+      {
+        "name": "start_date",
+        "type": "string",
+        "required": false,
+        "description": "The start date to search between"
+      },
+      {
+        "name": "end_date",
+        "type": "string",
+        "required": false,
+        "description": "The end date to search between"
+      },
+      {
+        "name": "report_keys",
+        "type": "array",
+        "required": false
+      }
+    ],
+    "schemaRef": "GenericReportSchema"
+  }
+}

package/dist/catalog/endpoints/get_tax_rate_create.json

@@ -0,0 +1,16 @@
+{
+  "slug": "get_tax_rate_create",
+  "operationId": "getTaxRateCreate",
+  "method": "GET",
+  "path": "/api/v1/tax_rates/create",
+  "name": "Gets a new blank Tax Rate object",
+  "category": "tax_rates",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank tax rate template with default values to prefill a new-rate form (read-only); use store flow to create it.",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "TaxRate"
+}

package/dist/catalog/endpoints/get_tax_rates.json

@@ -0,0 +1,47 @@
+{
+  "slug": "get_tax_rates",
+  "operationId": "getTaxRates",
+  "method": "GET",
+  "path": "/api/v1/tax_rates",
+  "name": "Gets a list of tax_rates",
+  "category": "tax_rates",
+  "mutating": false,
+  "description": "Lists tax rates",
+  "whenToUse": "List or filter many tax rates with pagination, sorting, and indexing when you need to browse or search the company's tax rates.",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "index",
+      "type": "string",
+      "required": false,
+      "description": "Replaces the default response index from data to a user specific string\n\nie.\n\n```html\n  ?index=new_index\n```\n\nresponse is wrapped\n\n```json\n  {\n    'new_index' : [\n      .....\n    ]\n  }\n```",
+      "example": "user"
+    },
+    {
+      "name": "per_page",
+      "type": "integer",
+      "required": false,
+      "description": "The number of records to return for each request, default is 20",
+      "example": 20
+    },
+    {
+      "name": "page",
+      "type": "integer",
+      "required": false,
+      "description": "The page number to return for this request (when performing pagination), default is 1",
+      "example": 1
+    },
+    {
+      "name": "sort",
+      "type": "array",
+      "required": false,
+      "description": "Order the list by choosing a column and direction. Each value uses the form `column|asc` or `column|desc`.\n\n*Single sort** — for example `sort=name|asc`.\n\n*Multiple sorts** — for example\n`sort[]=rate|asc&sort[]=name|asc`.\n\nOnly `tax_rates` table columns apply. Unsupported keys are ignored.",
+      "example": [
+        "name|asc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "TaxRate[]"
+}

package/dist/catalog/endpoints/get_tax_summary_report.json

@@ -0,0 +1,49 @@
+{
+  "slug": "get_tax_summary_report",
+  "operationId": "getTaxSummaryReport",
+  "method": "POST",
+  "path": "/api/v1/reports/tax_summary_report",
+  "name": "Tax summary report",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export tax summary report",
+  "whenToUse": "Export a rolled-up tax summary report of collected taxes over a date range; use for total tax owed, not a period-by-period breakdown",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "date_range",
+        "type": "string",
+        "required": false,
+        "description": "The string representation of the date range of data to be returned"
+      },
+      {
+        "name": "date_key",
+        "type": "string",
+        "required": false,
+        "description": "The date column to search between."
+      },
+      {
+        "name": "start_date",
+        "type": "string",
+        "required": false,
+        "description": "The start date to search between"
+      },
+      {
+        "name": "end_date",
+        "type": "string",
+        "required": false,
+        "description": "The end date to search between"
+      },
+      {
+        "name": "report_keys",
+        "type": "array",
+        "required": false
+      }
+    ],
+    "schemaRef": "GenericReportSchema"
+  }
+}

package/dist/catalog/endpoints/get_template_preview.json

@@ -0,0 +1,25 @@
+{
+  "slug": "get_template_preview",
+  "operationId": "getTemplatePreview",
+  "method": "POST",
+  "path": "/api/v1/templates/preview/{hash}",
+  "name": "Preview template by hash",
+  "category": "templates",
+  "mutating": false,
+  "description": "Returns a template preview for the given hash",
+  "whenToUse": "Preview a template identified by its hash with supplied data; use when you have a template hash and want to see its rendered result",
+  "pathParameters": [
+    {
+      "name": "hash",
+      "type": "string",
+      "required": true,
+      "description": "The template hash"
+    }
+  ],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": []
+  }
+}

package/dist/catalog/endpoints/get_tokens.json

@@ -0,0 +1,54 @@
+{
+  "slug": "get_tokens",
+  "operationId": "getTokens",
+  "method": "GET",
+  "path": "/api/v1/tokens",
+  "name": "Gets a list of company tokens",
+  "category": "tokens",
+  "mutating": false,
+  "description": "Lists company tokens.\n\n  Query parameters can be added to performed more fine grained filtering of the tokens, these are handled by the TokenFilters class which defines the methods available",
+  "whenToUse": "List or filter many company API tokens with pagination and sorting; use to browse tokens, not to fetch one by id.",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "include",
+      "type": "string",
+      "required": false,
+      "description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
+      "example": "first_load"
+    },
+    {
+      "name": "index",
+      "type": "string",
+      "required": false,
+      "description": "Replaces the default response index from data to a user specific string\n\nie.\n\n```html\n  ?index=new_index\n```\n\nresponse is wrapped\n\n```json\n  {\n    'new_index' : [\n      .....\n    ]\n  }\n```",
+      "example": "user"
+    },
+    {
+      "name": "per_page",
+      "type": "integer",
+      "required": false,
+      "description": "The number of records to return for each request, default is 20",
+      "example": 20
+    },
+    {
+      "name": "page",
+      "type": "integer",
+      "required": false,
+      "description": "The page number to return for this request (when performing pagination), default is 1",
+      "example": 1
+    },
+    {
+      "name": "sort",
+      "type": "array",
+      "required": false,
+      "description": "Order the list by choosing a column and direction. Each value uses the form `column|asc` or `column|desc`.\n\n*Single sort** — for example `sort=name|asc`.\n\n*Multiple sorts** — for example\n`sort[]=id|desc&sort[]=name|asc`.\n\nCompany tokens sort by columns on `company_tokens`. Unsupported keys are ignored.",
+      "example": [
+        "name|asc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "CompanyToken[]"
+}

package/dist/catalog/endpoints/get_tokens_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_tokens_create",
+  "operationId": "getTokensCreate",
+  "method": "GET",
+  "path": "/api/v1/tokens/create",
+  "name": "Gets a new blank token object",
+  "category": "tokens",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Get a blank company token template with default values to prefill a create form; read-only, does not save anything.",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "include",
+      "type": "string",
+      "required": false,
+      "description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
+      "example": "first_load"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "CompanyToken"
+}

package/dist/catalog/endpoints/get_user_sales_report.json

@@ -0,0 +1,49 @@
+{
+  "slug": "get_user_sales_report",
+  "operationId": "getUserSalesReport",
+  "method": "POST",
+  "path": "/api/v1/reports/user_sales_report",
+  "name": "User sales report",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export user sales report",
+  "whenToUse": "Export a report of sales/revenue attributed to each user (staff) over a date range; use to compare salesperson performance, not client sales",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "date_range",
+        "type": "string",
+        "required": false,
+        "description": "The string representation of the date range of data to be returned"
+      },
+      {
+        "name": "date_key",
+        "type": "string",
+        "required": false,
+        "description": "The date column to search between."
+      },
+      {
+        "name": "start_date",
+        "type": "string",
+        "required": false,
+        "description": "The start date to search between"
+      },
+      {
+        "name": "end_date",
+        "type": "string",
+        "required": false,
+        "description": "The end date to search between"
+      },
+      {
+        "name": "report_keys",
+        "type": "array",
+        "required": false
+      }
+    ],
+    "schemaRef": "GenericReportSchema"
+  }
+}

package/dist/catalog/endpoints/get_users.json

@@ -0,0 +1,48 @@
+{
+  "slug": "get_users",
+  "operationId": "getUsers",
+  "method": "GET",
+  "path": "/api/v1/users",
+  "name": "Gets a list of users",
+  "category": "users",
+  "mutating": false,
+  "description": "Lists users, search and filters allow fine grained lists to be generated.\n\n    Query parameters can be added to performed more fine grained filtering of the users, these are handled by the UserFilters class which defines the methods available",
+  "whenToUse": "List or filter many users with paging and sorting; use to browse or search the user directory, not to fetch one.",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "include",
+      "type": "string",
+      "required": false,
+      "description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
+      "example": "first_load"
+    },
+    {
+      "name": "per_page",
+      "type": "integer",
+      "required": false,
+      "description": "The number of records to return for each request, default is 20",
+      "example": 20
+    },
+    {
+      "name": "page",
+      "type": "integer",
+      "required": false,
+      "description": "The page number to return for this request (when performing pagination), default is 1",
+      "example": 1
+    },
+    {
+      "name": "sort",
+      "type": "array",
+      "required": false,
+      "description": "Order the list by choosing a column and direction. Each value uses the form `column|asc` or `column|desc`.\n\n*Single sort** — for example `sort=email|asc`.\n\n*Multiple sorts** — for example\n`sort[]=last_name|asc&sort[]=first_name|asc`.\n\nOnly `users` table columns are recognized. Unsupported keys are ignored.",
+      "example": [
+        "first_name|asc",
+        "email|asc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "User[]"
+}