@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/delete_webhook.json

@@ -0,0 +1,32 @@
+{
+  "slug": "delete_webhook",
+  "operationId": "deleteWebhook",
+  "method": "DELETE",
+  "path": "/api/v1/webhooks/{id}",
+  "name": "Deletes a Webhook",
+  "category": "webhooks",
+  "mutating": true,
+  "description": "Handles the deletion of a Webhook by id",
+  "whenToUse": "Call to archive/soft-delete one existing webhook subscription by its hashed id; use list/show to inspect webhooks instead (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
+}

package/dist/catalog/endpoints/destroy_task_scheduler.json

@@ -0,0 +1,24 @@
+{
+  "slug": "destroy_task_scheduler",
+  "operationId": "destroyTaskScheduler",
+  "method": "DELETE",
+  "path": "/api/v1/task_schedulers/{id}",
+  "name": "Destroy Task Scheduler",
+  "category": "task_schedulers",
+  "mutating": true,
+  "description": "Destroy task scheduler and its associated job",
+  "whenToUse": "Delete one task scheduler and its associated job by hashed id (mutating); use bulk for many.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Scheduler Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/detach_user.json

@@ -0,0 +1,32 @@
+{
+  "slug": "detach_user",
+  "operationId": "detachUser",
+  "method": "DELETE",
+  "path": "/api/v1/users/{user}/detach_from_company",
+  "name": "Detach an existing user to a company",
+  "category": "users",
+  "mutating": true,
+  "description": "Detach an existing user from a company",
+  "whenToUse": "Remove one user's link to the current company by id without deleting the account; use to revoke company access (mutating).",
+  "pathParameters": [
+    {
+      "name": "user",
+      "type": "string",
+      "required": true,
+      "description": "The user hashed_id",
+      "format": "string",
+      "example": "FD767dfd7"
+    }
+  ],
+  "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/download_credit.json

@@ -0,0 +1,32 @@
+{
+  "slug": "download_credit",
+  "operationId": "downloadCredit",
+  "method": "GET",
+  "path": "/api/v1/credit/{invitation_key}/download",
+  "name": "Download quote PDF",
+  "category": "quotes",
+  "mutating": false,
+  "description": "Downloads a specific quote",
+  "whenToUse": "Download a credit's PDF by its credit invitation key; use for credits, not the quote or invoice download endpoints.",
+  "pathParameters": [
+    {
+      "name": "invitation_key",
+      "type": "string",
+      "required": true,
+      "description": "The Credit Invitation Key",
+      "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
+}

package/dist/catalog/endpoints/download_invoice_by_invitation.json

@@ -0,0 +1,32 @@
+{
+  "slug": "download_invoice_by_invitation",
+  "operationId": "downloadInvoiceByInvitation",
+  "method": "GET",
+  "path": "/api/v1/invoice/{invitation_key}/download",
+  "name": "Download invoice PDF",
+  "category": "invoices",
+  "mutating": false,
+  "description": "## GET /api/v1/invoice/{invitation_key}/download\n\nDownloads a specific invoice",
+  "whenToUse": "Download one invoice's PDF using its invitation_key (recipient link); use this client-facing route, not get_invoice_delivery_note or action download.",
+  "pathParameters": [
+    {
+      "name": "invitation_key",
+      "type": "string",
+      "required": true,
+      "description": "The Invoice Invitation Key",
+      "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
+}

package/dist/catalog/endpoints/download_purchase_order.json

@@ -0,0 +1,32 @@
+{
+  "slug": "download_purchase_order",
+  "operationId": "downloadPurchaseOrder",
+  "method": "GET",
+  "path": "/api/v1/purchase_order/{invitation_key}/download",
+  "name": "Download a purchase order PDF",
+  "category": "purchase_orders",
+  "mutating": false,
+  "description": "Downloads a specific purchase order",
+  "whenToUse": "Download a purchase order's PDF by its invitation key when you need the rendered document file rather than JSON data.",
+  "pathParameters": [
+    {
+      "name": "invitation_key",
+      "type": "string",
+      "required": true,
+      "description": "The Purchase Order Invitation Key",
+      "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
+}

package/dist/catalog/endpoints/download_quote.json

@@ -0,0 +1,32 @@
+{
+  "slug": "download_quote",
+  "operationId": "downloadQuote",
+  "method": "GET",
+  "path": "/api/v1/quote/{invitation_key}/download",
+  "name": "Download quote PDF",
+  "category": "quotes",
+  "mutating": false,
+  "description": "Downloads a specific quote",
+  "whenToUse": "Download a quote's PDF by its quote invitation key; use for quotes specifically, not credits or invoices.",
+  "pathParameters": [
+    {
+      "name": "invitation_key",
+      "type": "string",
+      "required": true,
+      "description": "The Quote Invitation Key",
+      "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
+}

package/dist/catalog/endpoints/download_recurring_invoice.json

@@ -0,0 +1,32 @@
+{
+  "slug": "download_recurring_invoice",
+  "operationId": "downloadRecurringInvoice",
+  "method": "GET",
+  "path": "/api/v1/recurring_invoice/{invitation_key}/download",
+  "name": "Download recurring invoice PDF",
+  "category": "recurring_invoices",
+  "mutating": false,
+  "description": "Downloads a specific invoice",
+  "whenToUse": "Download a recurring invoice's PDF by its invitation_key; use when you need the rendered file, not JSON record data.",
+  "pathParameters": [
+    {
+      "name": "invitation_key",
+      "type": "string",
+      "required": true,
+      "description": "The Recurring Invoice Invitation Key",
+      "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
+}

package/dist/catalog/endpoints/edit_bank_integration.json

@@ -0,0 +1,33 @@
+{
+  "slug": "edit_bank_integration",
+  "operationId": "editBankIntegration",
+  "method": "GET",
+  "path": "/api/v1/bank_integrations/{id}/edit",
+  "name": "Shows a bank_integration for editing",
+  "category": "bank_integrations",
+  "mutating": false,
+  "description": "Displays a bank_integration by id",
+  "whenToUse": "Fetch one bank integration by id prepared for editing (read-only); use to load form data before calling update_bank_integration.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The BankIntegration 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": "BankIntegration"
+}

package/dist/catalog/endpoints/edit_bank_transaction.json

@@ -0,0 +1,33 @@
+{
+  "slug": "edit_bank_transaction",
+  "operationId": "editBankTransaction",
+  "method": "GET",
+  "path": "/api/v1/bank_transactions/{id}/edit",
+  "name": "Shows a bank_transaction for editing",
+  "category": "bank_transactions",
+  "mutating": false,
+  "description": "Displays a bank_transaction by id",
+  "whenToUse": "Fetch one bank transaction prepared for editing by hashed id; read-only retrieval to populate a form, not the update itself.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The BankTransaction 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": "BankTransaction"
+}

package/dist/catalog/endpoints/edit_bank_transaction_rule.json

@@ -0,0 +1,33 @@
+{
+  "slug": "edit_bank_transaction_rule",
+  "operationId": "editBankTransactionRule",
+  "method": "GET",
+  "path": "/api/v1/bank_transaction_rules/{id}/edit",
+  "name": "Shows a bank_transaction for editing",
+  "category": "bank_transaction_rules",
+  "mutating": false,
+  "description": "Displays a bank_transaction by id",
+  "whenToUse": "Fetch one bank transaction rule by id prepared for editing (read-only); reach for it to preload a form, not to save changes.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Bank Transaction Rule 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": "BankTransactionRule"
+}

package/dist/catalog/endpoints/edit_client.json

@@ -0,0 +1,39 @@
+{
+  "slug": "edit_client",
+  "operationId": "editClient",
+  "method": "GET",
+  "path": "/api/v1/clients/{id}/edit",
+  "name": "Edit Client",
+  "category": "clients",
+  "mutating": false,
+  "description": "##  GET /api/v1/clients/{id}/edit\nDisplays a client by id, essentially an alias of the show route",
+  "whenToUse": "GET one client by id prepared for editing (alias of show); read-only, use before update_client, not the update itself.",
+  "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": null,
+  "responseSchema": "Client"
+}

package/dist/catalog/endpoints/edit_client_gateway_token.json

@@ -0,0 +1,33 @@
+{
+  "slug": "edit_client_gateway_token",
+  "operationId": "editClientGatewayToken",
+  "method": "GET",
+  "path": "/api/v1/client_gateway_tokens/{id}/edit",
+  "name": "Shows a client payment token for editting",
+  "category": "client_gateway_tokens",
+  "mutating": false,
+  "description": "Displays a client by id",
+  "whenToUse": "Fetch one client payment gateway token by id prepared for an edit form; read-only, use before update, not to save changes.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The ClientGatewayToken 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": "ClientGatewayToken"
+}

package/dist/catalog/endpoints/edit_company.json

@@ -0,0 +1,33 @@
+{
+  "slug": "edit_company",
+  "operationId": "editCompany",
+  "method": "GET",
+  "path": "/api/v1/companies/{id}/edit",
+  "name": "Shows an company for editting",
+  "category": "companies",
+  "mutating": false,
+  "description": "Displays an company by id",
+  "whenToUse": "GET one company by id prepared for editing (read-only); use to load current values before calling update_company, not to save changes.",
+  "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": null,
+  "responseSchema": "Company"
+}

package/dist/catalog/endpoints/edit_company_gateway.json

@@ -0,0 +1,33 @@
+{
+  "slug": "edit_company_gateway",
+  "operationId": "editCompanyGateway",
+  "method": "GET",
+  "path": "/api/v1/company_gateways/{id}/edit",
+  "name": "Shows an CompanyGateway for editting",
+  "category": "company_gateways",
+  "mutating": false,
+  "description": "Displays an CompanyGateway by id",
+  "whenToUse": "Fetch one company gateway by id prepared for editing (read-only); reach for it to preload a form, not to save changes.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The CompanyGateway 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": "CompanyGateway"
+}

package/dist/catalog/endpoints/edit_credit.json

@@ -0,0 +1,33 @@
+{
+  "slug": "edit_credit",
+  "operationId": "editCredit",
+  "method": "GET",
+  "path": "/api/v1/credits/{id}/edit",
+  "name": "Edit credit",
+  "category": "credits",
+  "mutating": false,
+  "description": "Displays an credit by id",
+  "whenToUse": "Fetch one credit by id prepared for editing (read-only); reach for it to preload a credit form, not to save changes.",
+  "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": null,
+  "responseSchema": "Invoice"
+}

package/dist/catalog/endpoints/edit_design.json

@@ -0,0 +1,33 @@
+{
+  "slug": "edit_design",
+  "operationId": "editDesign",
+  "method": "GET",
+  "path": "/api/v1/designs/{id}/edit",
+  "name": "Shows a design for editting",
+  "category": "designs",
+  "mutating": false,
+  "description": "Displays a design by id",
+  "whenToUse": "Fetch one design by id prepared for editing in a form; read-only, use update_design to actually save changes.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Design 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": "Design"
+}

package/dist/catalog/endpoints/edit_expense.json

@@ -0,0 +1,33 @@
+{
+  "slug": "edit_expense",
+  "operationId": "editExpense",
+  "method": "GET",
+  "path": "/api/v1/expenses/{id}/edit",
+  "name": "Shows a expense for editing",
+  "category": "expenses",
+  "mutating": false,
+  "description": "Displays a client by id",
+  "whenToUse": "Fetch one expense by id prepared for editing in a form; read-only, use update_expense to actually save changes.",
+  "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": null,
+  "responseSchema": "Expense"
+}

package/dist/catalog/endpoints/edit_expense_category.json

@@ -0,0 +1,25 @@
+{
+  "slug": "edit_expense_category",
+  "operationId": "editExpenseCategory",
+  "method": "GET",
+  "path": "/api/v1/expense_categories/{id}/edit",
+  "name": "Shows a Expens Category for editting",
+  "category": "expense_categories",
+  "mutating": false,
+  "description": "Displays a Expens Category by id",
+  "whenToUse": "Fetch one expense category by id prepared for editing in a form; read-only, use update_expense_category to save.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The ExpenseCategory Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "ExpenseCategory"
+}

package/dist/catalog/endpoints/edit_group_setting.json

@@ -0,0 +1,33 @@
+{
+  "slug": "edit_group_setting",
+  "operationId": "editGroupSetting",
+  "method": "GET",
+  "path": "/api/v1/group_settings/{id}/edit",
+  "name": "Shows an GroupSetting for editting",
+  "category": "group_settings",
+  "mutating": false,
+  "description": "Displays an GroupSetting by id",
+  "whenToUse": "Fetch one group setting prepared for editing by hashed id; read-only retrieval to populate a form, not the update itself.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The GroupSetting 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": "GroupSetting"
+}