@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/get_contact_report.json

@@ -0,0 +1,64 @@
+{
+  "slug": "get_contact_report",
+  "operationId": "getContactReport",
+  "method": "POST",
+  "path": "/api/v1/reports/contacts",
+  "name": "Contact reports",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export contact reports",
+  "whenToUse": "Export a paginated report of all contact records over a date range; use for a full contact list across clients, not client-grouped contacts",
+  "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_credit_report.json

@@ -0,0 +1,49 @@
+{
+  "slug": "get_credit_report",
+  "operationId": "getCreditReport",
+  "method": "POST",
+  "path": "/api/v1/reports/credits",
+  "name": "Credit reports",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export credit reports",
+  "whenToUse": "Export a report of credit (credit note) records over a date range; use for credits issued, not invoices, payments, or quotes",
+  "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_credits.json

@@ -0,0 +1,55 @@
+{
+  "slug": "get_credits",
+  "operationId": "getCredits",
+  "method": "GET",
+  "path": "/api/v1/credits",
+  "name": "List credits",
+  "category": "credits",
+  "mutating": false,
+  "description": "Lists credits, 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 credits, these are handled by the CreditFilters class which defines the methods available",
+  "whenToUse": "List or filter many credits by client, number, or balance with pagination; reach for it to browse credits, 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=balance|desc`.\n\n*Multiple sorts** — for example\n`sort[]=number|asc&sort[]=date|desc`.\n\nCredits accept credit table columns plus `client.name`, `client_id`, `documents`, and `client.*` / `contact.*` style keys per `CreditFilters`. Unsupported keys are ignored.",
+      "example": [
+        "number|asc",
+        "balance|desc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Credit[]"
+}

package/dist/catalog/endpoints/get_credits_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_credits_create",
+  "operationId": "getCreditsCreate",
+  "method": "GET",
+  "path": "/api/v1/credits/create",
+  "name": "Blank credit",
+  "category": "credits",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank credit template with default values (read-only); reach for it to seed a new-credit 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": "Credit"
+}

package/dist/catalog/endpoints/get_designs.json

@@ -0,0 +1,54 @@
+{
+  "slug": "get_designs",
+  "operationId": "getDesigns",
+  "method": "GET",
+  "path": "/api/v1/designs",
+  "name": "Gets a list of designs",
+  "category": "designs",
+  "mutating": false,
+  "description": "Lists designs",
+  "whenToUse": "List or filter many invoice/quote templates with paging and sorting when you need to browse designs or find a design's 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\nOnly `designs` table columns apply. Unsupported keys are ignored.",
+      "example": [
+        "name|asc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Design[]"
+}

package/dist/catalog/endpoints/get_designs_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_designs_create",
+  "operationId": "getDesignsCreate",
+  "method": "GET",
+  "path": "/api/v1/designs/create",
+  "name": "Gets a new blank design object",
+  "category": "designs",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank design object with default values to prefill a new-design form before calling store_design.",
+  "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": "Design"
+}

package/dist/catalog/endpoints/get_document_report.json

@@ -0,0 +1,64 @@
+{
+  "slug": "get_document_report",
+  "operationId": "getDocumentReport",
+  "method": "POST",
+  "path": "/api/v1/reports/documents",
+  "name": "Document reports",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export document reports",
+  "whenToUse": "Export a paginated report of uploaded document/attachment records over a date range; use to inventory files, not the entities they attach to",
+  "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_documents.json

@@ -0,0 +1,54 @@
+{
+  "slug": "get_documents",
+  "operationId": "getDocuments",
+  "method": "GET",
+  "path": "/api/v1/documents",
+  "name": "Gets a list of documents",
+  "category": "documents",
+  "mutating": false,
+  "description": "Lists documents, 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 documents, these are handled by the DocumentsFilters class which defines the methods available",
+  "whenToUse": "List and filter many uploaded document records with pagination and sorting; use to browse or search attachments across entities, not 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=created_at|desc`.\n\n*Multiple sorts** — for example\n`sort[]=id|desc&sort[]=created_at|asc`.\n\nDocuments accept base table columns and any extra relationship sorts implemented in `DocumentFilters`. Unsupported keys are ignored.",
+      "example": [
+        "created_at|desc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Document[]"
+}

package/dist/catalog/endpoints/get_expense_category_create.json

@@ -0,0 +1,16 @@
+{
+  "slug": "get_expense_category_create",
+  "operationId": "getExpenseCategoryCreate",
+  "method": "GET",
+  "path": "/api/v1/expense_categories/create",
+  "name": "Gets a new blank Expens Category object",
+  "category": "expense_categories",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank expense category object with defaults to prefill a new-category form before calling store_expense_category.",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "ExpenseCategory"
+}

package/dist/catalog/endpoints/get_expense_categorys.json

@@ -0,0 +1,47 @@
+{
+  "slug": "get_expense_categorys",
+  "operationId": "getExpenseCategorys",
+  "method": "GET",
+  "path": "/api/v1/expense_categories",
+  "name": "Gets a list of expense_categories",
+  "category": "expense_categories",
+  "mutating": false,
+  "description": "Lists tax rates",
+  "whenToUse": "List or filter many expense categories with paging and sorting when browsing categories or finding a category id.",
+  "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[]=id|desc&sort[]=name|asc`.\n\nOnly columns on `expense_categories` are recognized. Unsupported keys are ignored.",
+      "example": [
+        "name|asc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "ExpenseCategory[]"
+}

package/dist/catalog/endpoints/get_expense_report.json

@@ -0,0 +1,49 @@
+{
+  "slug": "get_expense_report",
+  "operationId": "getExpenseReport",
+  "method": "POST",
+  "path": "/api/v1/reports/expenses",
+  "name": "Expense reports",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export expense reports",
+  "whenToUse": "Export a report of expense records over a date range; use for money spent/costs, not revenue, invoices, or payments",
+  "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_expenses.json

@@ -0,0 +1,55 @@
+{
+  "slug": "get_expenses",
+  "operationId": "getExpenses",
+  "method": "GET",
+  "path": "/api/v1/expenses",
+  "name": "Gets a list of expenses",
+  "category": "expenses",
+  "mutating": false,
+  "description": "Lists 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 expenses, these are handled by the ExpenseFilters class which defines the methods available",
+  "whenToUse": "List or filter many expenses with paging, sorting, and filters when browsing spending or finding an expense's 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[]=amount|asc&sort[]=date|desc`.\n\nExpenses accept expense columns plus client, contact, and document-related sorts per `ExpenseFilters`. Unsupported keys are ignored.",
+      "example": [
+        "date|desc",
+        "amount|asc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Expense[]"
+}

package/dist/catalog/endpoints/get_expenses_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_expenses_create",
+  "operationId": "getExpensesCreate",
+  "method": "GET",
+  "path": "/api/v1/expenses/create",
+  "name": "Gets a new blank expense object",
+  "category": "expenses",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank expense object with default values to prefill a new-expense form before calling store_expense.",
+  "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": "Expense"
+}

package/dist/catalog/endpoints/get_export.json

@@ -0,0 +1,15 @@
+{
+  "slug": "get_export",
+  "operationId": "getExport",
+  "method": "POST",
+  "path": "/api/v1/export",
+  "name": "Export data from the system",
+  "category": "export",
+  "mutating": true,
+  "description": "Export data from the system",
+  "whenToUse": "Export system data out of Invoice Ninja for backup or migration; use to bulk-extract records rather than read individual entities (mutating).",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/get_export_preview.json

@@ -0,0 +1,25 @@
+{
+  "slug": "get_export_preview",
+  "operationId": "getExportPreview",
+  "method": "POST",
+  "path": "/api/v1/exports/preview/{hash}",
+  "name": "Export preview",
+  "category": "reports",
+  "mutating": false,
+  "description": "Preview an export by hash",
+  "whenToUse": "Preview the contents of a generated data export by its export hash before downloading or finalizing it",
+  "pathParameters": [
+    {
+      "name": "hash",
+      "type": "string",
+      "required": true,
+      "description": "The export hash"
+    }
+  ],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": []
+  }
+}