@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/update_user.json

@@ -0,0 +1,33 @@
+{
+  "slug": "update_user",
+  "operationId": "updateUser",
+  "method": "PUT",
+  "path": "/api/v1/users/{id}",
+  "name": "Updates an User",
+  "category": "users",
+  "mutating": true,
+  "description": "Handles the updating of an User by id",
+  "whenToUse": "Modify an existing user by id; use to change an established user's profile or settings (mutating).",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The User Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "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": "User"
+}

package/dist/catalog/endpoints/update_vendor.json

@@ -0,0 +1,140 @@
+{
+  "slug": "update_vendor",
+  "operationId": "updateVendor",
+  "method": "PUT",
+  "path": "/api/v1/vendors/{id}",
+  "name": "Update vendor",
+  "category": "vendors",
+  "mutating": true,
+  "description": "Handles the updating of a vendor by id",
+  "whenToUse": "Modify an existing vendor by id with new field values; use to change a vendor you already have, not to create one (mutating).",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Vendor Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "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": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "name",
+        "type": "string",
+        "required": true,
+        "description": "Vendor name"
+      },
+      {
+        "name": "address1",
+        "type": "string",
+        "required": false,
+        "description": "Primary address line"
+      },
+      {
+        "name": "address2",
+        "type": "string",
+        "required": false,
+        "description": "Secondary address line"
+      },
+      {
+        "name": "city",
+        "type": "string",
+        "required": false,
+        "description": "City"
+      },
+      {
+        "name": "state",
+        "type": "string",
+        "required": false,
+        "description": "State or province"
+      },
+      {
+        "name": "postal_code",
+        "type": "string",
+        "required": false,
+        "description": "Postal code"
+      },
+      {
+        "name": "country_id",
+        "type": "string",
+        "required": false,
+        "description": "Country ID"
+      },
+      {
+        "name": "phone",
+        "type": "string",
+        "required": false,
+        "description": "Phone number"
+      },
+      {
+        "name": "email",
+        "type": "string",
+        "required": false,
+        "description": "Email address"
+      },
+      {
+        "name": "website",
+        "type": "string",
+        "required": false,
+        "description": "Website URL"
+      },
+      {
+        "name": "custom_value1",
+        "type": "string",
+        "required": false,
+        "description": "Custom field value 1"
+      },
+      {
+        "name": "custom_value2",
+        "type": "string",
+        "required": false,
+        "description": "Custom field value 2"
+      },
+      {
+        "name": "custom_value3",
+        "type": "string",
+        "required": false,
+        "description": "Custom field value 3"
+      },
+      {
+        "name": "custom_value4",
+        "type": "string",
+        "required": false,
+        "description": "Custom field value 4"
+      },
+      {
+        "name": "is_deleted",
+        "type": "boolean",
+        "required": false,
+        "description": "Whether the vendor is deleted"
+      },
+      {
+        "name": "archived_at",
+        "type": "integer",
+        "required": false,
+        "description": "Timestamp when vendor was archived"
+      },
+      {
+        "name": "contacts",
+        "type": "array",
+        "required": false,
+        "description": "Array of vendor contacts"
+      }
+    ],
+    "schemaRef": "VendorRequest"
+  },
+  "responseSchema": "Vendor"
+}

package/dist/catalog/endpoints/update_webhook.json

@@ -0,0 +1,33 @@
+{
+  "slug": "update_webhook",
+  "operationId": "updateWebhook",
+  "method": "PUT",
+  "path": "/api/v1/webhooks/{id}",
+  "name": "Updates a Webhook",
+  "category": "webhooks",
+  "mutating": true,
+  "description": "Handles the updating of a Webhook by id",
+  "whenToUse": "Modify an existing webhook by its hashed id to change its target URL or event triggers (mutating).",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Webhook Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "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": "Webhook"
+}

package/dist/catalog/endpoints/upload_client.json

@@ -0,0 +1,54 @@
+{
+  "slug": "upload_client",
+  "operationId": "uploadClient",
+  "method": "POST",
+  "path": "/api/v1/clients/{id}/upload",
+  "name": "Add client document",
+  "category": "clients",
+  "mutating": true,
+  "description": "##  POST /api/v1/clients/{id}/upload\n\nHandles the uploading of a document to a client, please note due to a quirk in REST you will need to use a _method parameter with value of POST",
+  "whenToUse": "Attach document files to one client via multipart upload; use to add files to a client, not update_client for field edits (mutating).",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Client Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "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": "include",
+      "type": "string",
+      "required": false,
+      "description": "Include child relationships of the Client Object. ie ?include=documents,system_logs\n\n```html\nAvailable includes:\n\ncontacts [All contacts related to the client]\ndocuments [All documents related to the client]\ngateway_tokens [All payment tokens related to the client]\nactivities [All activities related to the client]\nledger [The client ledger]\nsystem_logs [System logs related to the client]\ngroup_settings [The group settings object the client is assigned to]\n\n```\n\nUsage:\n\n```html\n/api/v1/clients?include=contacts,documents,activities\n```"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "multipart/form-data",
+    "fields": [
+      {
+        "name": "_method",
+        "type": "string",
+        "required": false
+      },
+      {
+        "name": "documents[]",
+        "type": "array",
+        "required": false,
+        "description": "Array of files to upload. The files should be sent with the key name 'documents[]'.\n\nSupported file types:\n- PDF (.pdf)\n- Word (.doc, .docx)\n- Excel (.xls, .xlsx)\n- Images (.jpg, .jpeg, .png)\n- Text (.txt)\n\nMaximum file size: 20MB per file"
+      }
+    ]
+  },
+  "responseSchema": "Client"
+}

package/dist/catalog/endpoints/upload_companies.json

@@ -0,0 +1,47 @@
+{
+  "slug": "upload_companies",
+  "operationId": "uploadCompanies",
+  "method": "POST",
+  "path": "/api/v1/companies/{id}/upload",
+  "name": "Uploads a document to a company",
+  "category": "companies",
+  "mutating": true,
+  "description": "Handles the uploading of a document to a company",
+  "whenToUse": "Attach a document/file to an existing company by id via multipart upload; use to add attachments, not to edit company fields (mutating).",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Company Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "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": {
+    "contentType": "multipart/form-data",
+    "fields": [
+      {
+        "name": "_method",
+        "type": "string",
+        "required": false
+      },
+      {
+        "name": "documents",
+        "type": "array",
+        "required": false
+      }
+    ]
+  },
+  "responseSchema": "Company"
+}

package/dist/catalog/endpoints/upload_credits.json

@@ -0,0 +1,47 @@
+{
+  "slug": "upload_credits",
+  "operationId": "uploadCredits",
+  "method": "POST",
+  "path": "/api/v1/credits/{id}/upload",
+  "name": "Upload a credit document",
+  "category": "credits",
+  "mutating": true,
+  "description": "Handles the uploading of a document to a credit",
+  "whenToUse": "Attach a document/file to one credit by id via multipart upload; reach for it to add supporting attachments (mutating).",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Credit Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "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": {
+    "contentType": "multipart/form-data",
+    "fields": [
+      {
+        "name": "_method",
+        "type": "string",
+        "required": false
+      },
+      {
+        "name": "documents",
+        "type": "array",
+        "required": false
+      }
+    ]
+  },
+  "responseSchema": "Credit"
+}

package/dist/catalog/endpoints/upload_expense.json

@@ -0,0 +1,47 @@
+{
+  "slug": "upload_expense",
+  "operationId": "uploadExpense",
+  "method": "POST",
+  "path": "/api/v1/expenses/{id}/upload",
+  "name": "Uploads a document to a expense",
+  "category": "expenses",
+  "mutating": true,
+  "description": "Handles the uploading of a document to a expense",
+  "whenToUse": "Attach one or more document files to an existing expense by its hashed id; use to add receipts to an expense record (mutating).",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Expense Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "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": {
+    "contentType": "multipart/form-data",
+    "fields": [
+      {
+        "name": "_method",
+        "type": "string",
+        "required": false
+      },
+      {
+        "name": "documents",
+        "type": "array",
+        "required": false
+      }
+    ]
+  },
+  "responseSchema": "Expense"
+}

package/dist/catalog/endpoints/upload_group_setting.json

@@ -0,0 +1,47 @@
+{
+  "slug": "upload_group_setting",
+  "operationId": "uploadGroupSetting",
+  "method": "POST",
+  "path": "/api/v1/group_settings/{id}/upload",
+  "name": "Uploads a document to a group setting",
+  "category": "group_settings",
+  "mutating": true,
+  "description": "Handles the uploading of a document to a group setting",
+  "whenToUse": "Attach a document or file to one group setting by hashed id; use to add supporting documents to a group (mutating).",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Group Setting Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "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": {
+    "contentType": "multipart/form-data",
+    "fields": [
+      {
+        "name": "_method",
+        "type": "string",
+        "required": false
+      },
+      {
+        "name": "documents",
+        "type": "array",
+        "required": false
+      }
+    ]
+  },
+  "responseSchema": "Invoice"
+}

package/dist/catalog/endpoints/upload_invoice_document.json

@@ -0,0 +1,47 @@
+{
+  "slug": "upload_invoice_document",
+  "operationId": "uploadInvoiceDocument",
+  "method": "POST",
+  "path": "/api/v1/invoices/{id}/upload",
+  "name": "Add invoice document",
+  "category": "invoices",
+  "mutating": true,
+  "description": "## POST /api/v1/invoices/{id}/upload\n\nHandles the uploading of a document to a invoice",
+  "whenToUse": "Attach document files to one invoice via multipart upload; use to add files, not update_invoice for field edits (mutating).",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Invoice Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "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": {
+    "contentType": "multipart/form-data",
+    "fields": [
+      {
+        "name": "_method",
+        "type": "string",
+        "required": false
+      },
+      {
+        "name": "documents",
+        "type": "array",
+        "required": false
+      }
+    ]
+  },
+  "responseSchema": "Invoice"
+}

package/dist/catalog/endpoints/upload_payment.json

@@ -0,0 +1,47 @@
+{
+  "slug": "upload_payment",
+  "operationId": "uploadPayment",
+  "method": "POST",
+  "path": "/api/v1/payments/{id}/upload",
+  "name": "Upload a payment document",
+  "category": "payments",
+  "mutating": true,
+  "description": "Handles the uploading of a document to a payment",
+  "whenToUse": "Attach a document/file to an existing payment by its hashed id via multipart upload (mutating).",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Payment Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "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": {
+    "contentType": "multipart/form-data",
+    "fields": [
+      {
+        "name": "_method",
+        "type": "string",
+        "required": false
+      },
+      {
+        "name": "documents",
+        "type": "array",
+        "required": false
+      }
+    ]
+  },
+  "responseSchema": "Payment"
+}

package/dist/catalog/endpoints/upload_product.json

@@ -0,0 +1,46 @@
+{
+  "slug": "upload_product",
+  "operationId": "uploadProduct",
+  "method": "POST",
+  "path": "/api/v1/products/{id}/upload",
+  "name": "Add product document",
+  "category": "products",
+  "mutating": true,
+  "description": "##  POST /api/v1/products/{id}/upload\nHandles the uploading of a document to a product\"",
+  "whenToUse": "Attach a document or file to an existing product by id; use to add supporting attachments to one product (mutating).",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Product Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "queryParameters": [
+    {
+      "name": "include",
+      "type": "string",
+      "required": false,
+      "description": "Include child relationships of the Client Object. ie ?include=documents,system_logs\n\n```html\nAvailable includes:\n\ncontacts [All contacts related to the client]\ndocuments [All documents related to the client]\ngateway_tokens [All payment tokens related to the client]\nactivities [All activities related to the client]\nledger [The client ledger]\nsystem_logs [System logs related to the client]\ngroup_settings [The group settings object the client is assigned to]\n\n```\n\nUsage:\n\n```html\n/api/v1/clients?include=contacts,documents,activities\n```"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "multipart/form-data",
+    "fields": [
+      {
+        "name": "_method",
+        "type": "string",
+        "required": false
+      },
+      {
+        "name": "documents",
+        "type": "array",
+        "required": false
+      }
+    ]
+  },
+  "responseSchema": "Product"
+}

package/dist/catalog/endpoints/upload_project.json

@@ -0,0 +1,47 @@
+{
+  "slug": "upload_project",
+  "operationId": "uploadProject",
+  "method": "POST",
+  "path": "/api/v1/projects/{id}/upload",
+  "name": "Uploads a project document",
+  "category": "projects",
+  "mutating": true,
+  "description": "Handles the uploading of a document to a project",
+  "whenToUse": "Attach a document or file to an existing project by id; use to add supporting attachments to one project (mutating).",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Project Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "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": {
+    "contentType": "multipart/form-data",
+    "fields": [
+      {
+        "name": "_method",
+        "type": "string",
+        "required": false
+      },
+      {
+        "name": "documents",
+        "type": "array",
+        "required": false
+      }
+    ]
+  },
+  "responseSchema": "Project"
+}