@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/get_recurring_invoices.json

@@ -0,0 +1,139 @@
+{
+  "slug": "get_recurring_invoices",
+  "operationId": "getRecurringInvoices",
+  "method": "GET",
+  "path": "/api/v1/recurring_invoices",
+  "name": "List recurring invoices",
+  "category": "recurring_invoices",
+  "mutating": false,
+  "description": "## GET /api/v1/recurring_invoices\n\nLists invoices with the option to chain multiple query parameters allowing fine grained filtering of the list.",
+  "whenToUse": "List or filter many recurring invoices by client, status, frequency, or next-send date; use to browse or search, 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": "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=next_send_date|asc`.\n\n*Multiple sorts** — for example\n`sort[]=id|desc&sort[]=number|asc`.\n\nRecurring invoices use the recurring-invoice table columns plus the client/contact-style sorts exposed by `RecurringInvoiceFilters`. Unsupported keys are ignored.",
+      "example": [
+        "number|asc",
+        "next_send_date|desc"
+      ]
+    },
+    {
+      "name": "client_id",
+      "type": "string",
+      "required": false,
+      "description": "Filters the entity list by client_id. Suitable when you only want the entities of a specific client.\n\n```html\nGET /api/v1/invoices?client_id=AxB7Hjk9\nReturns only invoices for the specified client\n```",
+      "example": "?client_id={client_id}"
+    },
+    {
+      "name": "created_at",
+      "type": "integer",
+      "required": false,
+      "description": "Filters the entity list by the created at timestamp. Parameter value can be a datetime string or unix timestamp\n\n```html\nGET /api/v1/invoices?created_at=2022-01-10\nReturns entities created on January 10th, 2022\n```",
+      "example": 1641772800
+    },
+    {
+      "name": "updated_at",
+      "type": "integer",
+      "required": false,
+      "description": "Filters the entity list by the updated at timestamp. Parameter value can be a datetime string or unix timestamp\n\n```html\nGET /api/v1/invoices?updated_at=2022-01-10\nReturns entities last updated on January 10th, 2022\n```",
+      "example": 1641772800
+    },
+    {
+      "name": "is_deleted",
+      "type": "boolean",
+      "required": false,
+      "description": "Filters the entity list by entities that have been deleted.\n\n```html\nGET /api/v1/invoices?is_deleted=true\nReturns only soft-deleted entities\n```",
+      "example": true
+    },
+    {
+      "name": "filter_deleted_clients",
+      "type": "string",
+      "required": false,
+      "description": "Filters the entity list and only returns entities for clients that have not been deleted\n\n```html\nGET /api/v1/invoices?filter_deleted_clients=true\nReturns only invoices for active (non-deleted) clients\n```",
+      "example": "?filter_deleted_clients=true"
+    },
+    {
+      "name": "vendor_id",
+      "type": "string",
+      "required": false,
+      "description": "Filters the entity list by an associated vendor\n\n```html\nGET /api/v1/purchases?vendor_id=AxB7Hjk9\nReturns only purchases for the specified vendor\n```",
+      "example": "?vendor_id={vendor_id}"
+    },
+    {
+      "name": "filter",
+      "type": "string",
+      "required": false,
+      "description": "Searches across a range of columns including:\n- custom_value1\n- custom_value2\n- custom_value3\n- custom_value4",
+      "example": "?filter=bob"
+    },
+    {
+      "name": "client_status",
+      "type": "string",
+      "required": false,
+      "description": "A comma separated list of invoice status strings. Valid options include:\n- all\n- active\n- paused\n- completed",
+      "example": "?client_status=active,paused"
+    },
+    {
+      "name": "number",
+      "type": "string",
+      "required": false,
+      "description": "Filters the list by number.",
+      "example": "?number=123"
+    },
+    {
+      "name": "product_key",
+      "type": "string",
+      "required": false,
+      "description": "Filters the list by product_key.",
+      "example": "?product_key=123"
+    },
+    {
+      "name": "next_send_between",
+      "type": "string",
+      "required": false,
+      "description": "Filters the list by next_send_between.",
+      "example": "?next_send_between=2025-01-01|2025-01-31"
+    },
+    {
+      "name": "frequency_id",
+      "type": "string",
+      "required": false,
+      "description": "Filters the list by frequency_id.",
+      "example": "?frequency_id=1,2,3"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "RecurringInvoice[]"
+}

package/dist/catalog/endpoints/get_recurring_invoices_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_recurring_invoices_create",
+  "operationId": "getRecurringInvoicesCreate",
+  "method": "GET",
+  "path": "/api/v1/recurring_invoices/create",
+  "name": "Blank recurring invoice",
+  "category": "recurring_invoices",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank recurring invoice with default values; use to pre-populate a new-record form before calling store.",
+  "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": "RecurringInvoice"
+}

package/dist/catalog/endpoints/get_recurring_quotes.json

@@ -0,0 +1,47 @@
+{
+  "slug": "get_recurring_quotes",
+  "operationId": "getRecurringQuotes",
+  "method": "GET",
+  "path": "/api/v1/recurring_quotes",
+  "name": "Gets a list of recurring_quotes",
+  "category": "recurring_quotes",
+  "mutating": false,
+  "description": "Lists recurring_quotes, 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 recurring_quotes, these are handled by the RecurringQuoteFilters class which defines the methods available",
+  "whenToUse": "List or filter many recurring quotes with search, sort, and pagination; use when browsing or finding recurring quotes rather than fetching 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": "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=next_send_date|desc`.\n\n*Multiple sorts** — for example\n`sort[]=number|asc&sort[]=id|desc`.\n\nRecurring quotes use their table columns and related sorts from `RecurringQuoteFilters`. Unsupported keys are ignored.",
+      "example": [
+        "number|asc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "RecurringQuote[]"
+}

package/dist/catalog/endpoints/get_recurring_quotes_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_recurring_quotes_create",
+  "operationId": "getRecurringQuotesCreate",
+  "method": "GET",
+  "path": "/api/v1/recurring_quotes/create",
+  "name": "Gets a new blank RecurringQuote object",
+  "category": "recurring_quotes",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank recurring quote with default values; use to prefill a new-record form before calling store_recurring_quote.",
+  "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": "RecurringQuote"
+}

package/dist/catalog/endpoints/get_refresh_accounts.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_refresh_accounts",
+  "operationId": "getRefreshAccounts",
+  "method": "POST",
+  "path": "/api/v1/bank_integrations/refresh_accounts",
+  "name": "Gets the list of accounts from the remote server",
+  "category": "bank_integrations",
+  "mutating": true,
+  "description": "Adds an bank_integration to a company",
+  "whenToUse": "Refresh the list of accounts from the remote bank provider; use to re-sync available bank accounts into integrations (mutating).",
+  "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": "BankIntegration"
+}

package/dist/catalog/endpoints/get_remove_account.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_remove_account",
+  "operationId": "getRemoveAccount",
+  "method": "POST",
+  "path": "/api/v1/bank_integrations/remove_account/account_id",
+  "name": "Removes an account from the integration",
+  "category": "bank_integrations",
+  "mutating": true,
+  "description": "Removes an account from the integration",
+  "whenToUse": "Remove a single account from a bank integration; use to detach one linked account, not to delete the whole integration (mutating).",
+  "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": "BankIntegration"
+}

package/dist/catalog/endpoints/get_report_preview.json

@@ -0,0 +1,25 @@
+{
+  "slug": "get_report_preview",
+  "operationId": "getReportPreview",
+  "method": "POST",
+  "path": "/api/v1/reports/preview/{hash}",
+  "name": "Report preview",
+  "category": "reports",
+  "mutating": false,
+  "description": "Preview a report by hash",
+  "whenToUse": "Preview a generated report by its report hash before exporting or downloading it; use after queuing a report to inspect results",
+  "pathParameters": [
+    {
+      "name": "hash",
+      "type": "string",
+      "required": true,
+      "description": "The report hash"
+    }
+  ],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": []
+  }
+}

package/dist/catalog/endpoints/get_scheduler.json

@@ -0,0 +1,15 @@
+{
+  "slug": "get_scheduler",
+  "operationId": "getScheduler",
+  "method": "GET",
+  "path": "/api/v1/scheduler",
+  "name": "Get scheduler status",
+  "category": "scheduler",
+  "mutating": false,
+  "description": "Returns the task scheduler status and job list",
+  "whenToUse": "Call to read the task scheduler status and its current job list; read-only, does not trigger or run any jobs.",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/get_settings_passkeys.json

@@ -0,0 +1,15 @@
+{
+  "slug": "get_settings_passkeys",
+  "operationId": "getSettingsPasskeys",
+  "method": "GET",
+  "path": "/api/v1/settings/passkeys",
+  "name": "List passkeys",
+  "category": "auth",
+  "mutating": false,
+  "description": "List passkeys",
+  "whenToUse": "List the current authenticated user's registered passkeys when reviewing or managing their saved credentials (read-only).",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/get_show_template.json

@@ -0,0 +1,47 @@
+{
+  "slug": "get_show_template",
+  "operationId": "getShowTemplate",
+  "method": "POST",
+  "path": "/api/v1/templates",
+  "name": "Returns a entity template with the template variables replaced with the Entities",
+  "category": "templates",
+  "mutating": false,
+  "description": "Returns a entity template with the template variables replaced with the Entities",
+  "whenToUse": "Render an entity template with its variables substituted from real entities; use to produce filled template output rather than a raw preview",
+  "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": "subject",
+        "type": "string",
+        "required": false,
+        "description": "The email template subject"
+      },
+      {
+        "name": "body",
+        "type": "string",
+        "required": false,
+        "description": "The email template body"
+      }
+    ]
+  },
+  "responseSchema": "Template"
+}

package/dist/catalog/endpoints/get_statics.json

@@ -0,0 +1,23 @@
+{
+  "slug": "get_statics",
+  "operationId": "getStatics",
+  "method": "GET",
+  "path": "/api/v1/statics",
+  "name": "Gets a list of statics",
+  "category": "statics",
+  "mutating": false,
+  "description": "Lists all statics",
+  "whenToUse": "Call to fetch the app's static reference data (currencies, countries, languages, payment types, industries) for populating selectors; read-only.",
+  "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
+}

package/dist/catalog/endpoints/get_subscriptions.json

@@ -0,0 +1,47 @@
+{
+  "slug": "get_subscriptions",
+  "operationId": "getSubscriptions",
+  "method": "GET",
+  "path": "/api/v1/subscriptions",
+  "name": "Gets a list of subscriptions",
+  "category": "subscriptions",
+  "mutating": false,
+  "description": "Lists subscriptions.",
+  "whenToUse": "List or paginate many subscription products, sorted by column; use to browse, 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": "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=created_at|desc`.\n\n*Multiple sorts** — for example\n`sort[]=id|desc&sort[]=created_at|asc`.\n\nOnly `subscriptions` table columns are recognized. Unsupported keys are ignored.",
+      "example": [
+        "created_at|desc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Subscription[]"
+}

package/dist/catalog/endpoints/get_subscriptions_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_subscriptions_create",
+  "operationId": "getSubscriptionsCreate",
+  "method": "GET",
+  "path": "/api/v1/subscriptions/create",
+  "name": "Gets a new blank subscriptions object",
+  "category": "subscriptions",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank subscription object with default values (read-only) to seed a new-record form before storing.",
+  "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": "Subscription"
+}

package/dist/catalog/endpoints/get_system_logs.json

@@ -0,0 +1,47 @@
+{
+  "slug": "get_system_logs",
+  "operationId": "getSystemLogs",
+  "method": "GET",
+  "path": "/api/v1/system_logs",
+  "name": "Gets a list of system logs",
+  "category": "system_logs",
+  "mutating": false,
+  "description": "Lists system logs, 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 system logs, these are handled by the SystemLogFilters class which defines the methods available",
+  "whenToUse": "List and filter many system log records with pagination and sorting; reach for it to audit events or search logs broadly rather than 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": "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=created_at|desc`.\n\n*Multiple sorts** — for example\n`sort[]=id|desc&sort[]=created_at|desc`.\n\nLog rows sort by columns exposed through `SystemLogFilters`. Unsupported keys are ignored.",
+      "example": [
+        "created_at|desc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "SystemLog[]"
+}

package/dist/catalog/endpoints/get_tags.json

@@ -0,0 +1,63 @@
+{
+  "slug": "get_tags",
+  "operationId": "getTags",
+  "method": "GET",
+  "path": "/api/v1/tags",
+  "name": "List tags",
+  "category": "tags",
+  "mutating": false,
+  "description": "Lists company tags for a single taggable entity type.\n\n`entity_type` is required so task tags and project tags never bleed into the same picker.",
+  "whenToUse": "List company tags for one required entity_type (task or project), with name filter and sort; use to browse tag pickers.",
+  "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": "entity_type",
+      "type": "string",
+      "required": true,
+      "description": "Supported values: App\\Models\\Task, App\\Models\\Project",
+      "enum": [
+        "task",
+        "project"
+      ],
+      "example": "App\\Models\\Task"
+    },
+    {
+      "name": "filter",
+      "type": "string",
+      "required": false,
+      "description": "Search by tag name",
+      "example": "urgent"
+    },
+    {
+      "name": "sort",
+      "type": "string",
+      "required": false,
+      "description": "Sort using column|direction, for example name|asc or created_at|desc",
+      "example": "name|asc"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Tag[]"
+}

package/dist/catalog/endpoints/get_tags_create.json

@@ -0,0 +1,16 @@
+{
+  "slug": "get_tags_create",
+  "operationId": "getTagsCreate",
+  "method": "GET",
+  "path": "/api/v1/tags/create",
+  "name": "Blank tag",
+  "category": "tags",
+  "mutating": false,
+  "description": "Returns a blank tag object with default values.",
+  "whenToUse": "Fetch a blank tag object with default values (read-only) to seed a new-tag form before storing.",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Tag"
+}