@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/get_projects.json

@@ -0,0 +1,55 @@
+{
+  "slug": "get_projects",
+  "operationId": "getProjects",
+  "method": "GET",
+  "path": "/api/v1/projects",
+  "name": "List projects",
+  "category": "projects",
+  "mutating": false,
+  "description": "Lists projects",
+  "whenToUse": "List and filter many projects in your company, with search, sorting, and pagination; reach for it to browse or find projects by criteria.",
+  "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|desc`.\n\n*Multiple sorts** — for example\n`sort[]=id|desc&sort[]=name|asc`.\n\nProjects accept `projects` columns plus `client.name`, `client_id`, `contact.*`, `documents`, and dotted `client.*` / `contact.*` relationship sorts where supported. Unsupported keys are ignored.",
+      "example": [
+        "name|asc",
+        "due_date|desc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Project[]"
+}

package/dist/catalog/endpoints/get_projects_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_projects_create",
+  "operationId": "getProjectsCreate",
+  "method": "GET",
+  "path": "/api/v1/projects/create",
+  "name": "Blank project",
+  "category": "projects",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank project template with default values (read-only); use to prefill a new-project form before calling store_project.",
+  "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": "Project"
+}

package/dist/catalog/endpoints/get_purchase_order_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_purchase_order_create",
+  "operationId": "getPurchaseOrderCreate",
+  "method": "GET",
+  "path": "/api/v1/purchase_orders/create",
+  "name": "Blank purchase order",
+  "category": "purchase_orders",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank purchase order object with default values to seed a new-PO form; read-only, does not create 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": "PurchaseOrder"
+}

package/dist/catalog/endpoints/get_purchase_orders.json

@@ -0,0 +1,55 @@
+{
+  "slug": "get_purchase_orders",
+  "operationId": "getPurchaseOrders",
+  "method": "GET",
+  "path": "/api/v1/purchase_orders",
+  "name": "List purchase orders",
+  "category": "purchase_orders",
+  "mutating": false,
+  "description": "Lists purchase orders, 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 purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available",
+  "whenToUse": "List and filter many purchase orders with sorting/pagination when you need a set of 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=date|desc`.\n\n*Multiple sorts** — for example\n`sort[]=number|asc&sort[]=date|desc`.\n\nPurchase orders use PO table columns and vendor- or client-related sorts as defined in `PurchaseOrderFilters`. Unsupported keys are ignored.",
+      "example": [
+        "number|asc",
+        "date|desc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "PurchaseOrder[]"
+}

package/dist/catalog/endpoints/get_quote_item_report.json

@@ -0,0 +1,64 @@
+{
+  "slug": "get_quote_item_report",
+  "operationId": "getQuoteItemReport",
+  "method": "POST",
+  "path": "/api/v1/reports/quote_items",
+  "name": "Quote item reports",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export Quote item reports",
+  "whenToUse": "Export a paginated report of individual quote line items over a date range; use for per-line quote detail, not whole-quote totals",
+  "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_quote_report.json

@@ -0,0 +1,64 @@
+{
+  "slug": "get_quote_report",
+  "operationId": "getQuoteReport",
+  "method": "POST",
+  "path": "/api/v1/reports/quotes",
+  "name": "Quote reports",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export quote reports",
+  "whenToUse": "Export a paginated report of quote records and totals over a date range; use for quote-level summaries, not their individual line items",
+  "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_quotes.json

@@ -0,0 +1,125 @@
+{
+  "slug": "get_quotes",
+  "operationId": "getQuotes",
+  "method": "GET",
+  "path": "/api/v1/quotes",
+  "name": "List quotes",
+  "category": "quotes",
+  "mutating": false,
+  "description": "## GET /api/v1/quotes\n\nLists quotes, search and filters allow fine grained lists to be generated.\n\nQuery parameters can be added to performed more fine grained filtering of the quotes, these are handled by the QuoteFilters class which defines the methods available",
+  "whenToUse": "List or filter many quotes by client, status, number, or date; use to find or browse quotes, 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=date|desc`.\n\n*Multiple sorts** — for example\n`sort[]=id|desc&sort[]=number|asc`.\n\nQuotes follow the same style as invoices: base `quotes` columns plus `client.name`, `client_id`, `documents`, and `client.*` / `contact.*` where implemented. Unsupported keys are ignored.",
+      "example": [
+        "number|asc",
+        "id|desc"
+      ]
+    },
+    {
+      "name": "status",
+      "type": "string",
+      "required": false,
+      "description": "Filter the entity based on their status. ie active / archived / deleted. Format is a comma separated string with any of the following options:\n- active\n- archived\n- deleted\n\n```html\nGET /api/v1/invoices?status=archived,deleted\nReturns only archived and deleted invoices\n```",
+      "example": "?status=archived,deleted"
+    },
+    {
+      "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- number\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 quote status strings. Valid options include:\n- all\n- draft\n- sent\n- approved\n- expired\n- upcoming",
+      "example": "?client_status=paid,unpaid"
+    },
+    {
+      "name": "number",
+      "type": "string",
+      "required": false,
+      "description": "Search quote by quote number",
+      "example": "?number=Q-001"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Quote[]"
+}

package/dist/catalog/endpoints/get_quotes_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_quotes_create",
+  "operationId": "getQuotesCreate",
+  "method": "GET",
+  "path": "/api/v1/quotes/create",
+  "name": "Blank quote",
+  "category": "quotes",
+  "mutating": false,
+  "description": "## GET /api/v1/quotes/create\n\nReturns a blank object with default values",
+  "whenToUse": "Fetch a blank quote object with default values (read-only); use to seed a new quote form before calling store_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": "Quote"
+}

package/dist/catalog/endpoints/get_recurring_expenses.json

@@ -0,0 +1,54 @@
+{
+  "slug": "get_recurring_expenses",
+  "operationId": "getRecurringExpenses",
+  "method": "GET",
+  "path": "/api/v1/recurring_expenses",
+  "name": "Gets a list of recurring_expenses",
+  "category": "recurring_expenses",
+  "mutating": false,
+  "description": "Lists recurring_expenses, 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_expenses, these are handled by the RecurringExpenseFilters class which defines the methods available",
+  "whenToUse": "List or filter many recurring expense templates, with pagination and sorting; 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": "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[]=amount|desc`.\n\nRecurring expenses combine table columns with client- or vendor-related sorts from `RecurringExpenseFilters`. Unsupported keys are ignored.",
+      "example": [
+        "next_send_date|asc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "RecurringExpense[]"
+}

package/dist/catalog/endpoints/get_recurring_expenses_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_recurring_expenses_create",
+  "operationId": "getRecurringExpensesCreate",
+  "method": "GET",
+  "path": "/api/v1/recurring_expenses/create",
+  "name": "Gets a new blank recurring expense object",
+  "category": "recurring_expenses",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank recurring expense 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": "RecurringExpense"
+}

package/dist/catalog/endpoints/get_recurring_invoice_report.json

@@ -0,0 +1,64 @@
+{
+  "slug": "get_recurring_invoice_report",
+  "operationId": "getRecurringInvoiceReport",
+  "method": "POST",
+  "path": "/api/v1/reports/recurring_invoices",
+  "name": "Recurring Invoice reports",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export recurring invoice reports",
+  "whenToUse": "Export a paginated report of recurring-invoice templates/schedules over a date range; use for subscriptions, not one-off invoices issued",
+  "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"
+  }
+}