@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/show_client.json

@@ -0,0 +1,39 @@
+{
+  "slug": "show_client",
+  "operationId": "showClient",
+  "method": "GET",
+  "path": "/api/v1/clients/{id}",
+  "name": "Show client",
+  "category": "clients",
+  "mutating": false,
+  "description": "##  GET /api/v1/clients/{id}\n\nDisplays a client by id",
+  "whenToUse": "Fetch one client by id with optional includes; use when you already have the hashed id, not get_clients for searching.",
+  "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/show_client_gateway_token.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_client_gateway_token",
+  "operationId": "showClientGatewayToken",
+  "method": "GET",
+  "path": "/api/v1/client_gateway_tokens/{id}",
+  "name": "Shows a client payment token",
+  "category": "client_gateway_tokens",
+  "mutating": false,
+  "description": "Displays a client payment token by id",
+  "whenToUse": "Fetch one client payment gateway token by its hashed id to read its details; use when you already know the id.",
+  "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/show_company.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_company",
+  "operationId": "showCompany",
+  "method": "GET",
+  "path": "/api/v1/companies/{id}",
+  "name": "Shows an company",
+  "category": "companies",
+  "mutating": false,
+  "description": "Displays an company by id",
+  "whenToUse": "Fetch one company by its hashed id; use when you already know the id and need that single record's details.",
+  "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/show_company_gateway.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_company_gateway",
+  "operationId": "showCompanyGateway",
+  "method": "GET",
+  "path": "/api/v1/company_gateways/{id}",
+  "name": "Shows an CompanyGateway",
+  "category": "company_gateways",
+  "mutating": false,
+  "description": "Displays an CompanyGateway by id",
+  "whenToUse": "Fetch one company gateway by its id; reach for it when you already know the gateway's id and need its configuration.",
+  "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/show_credit.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_credit",
+  "operationId": "showCredit",
+  "method": "GET",
+  "path": "/api/v1/credits/{id}",
+  "name": "Show credit",
+  "category": "credits",
+  "mutating": false,
+  "description": "Displays an credit by id",
+  "whenToUse": "Fetch one credit by its id; reach for it when you already know the credit's id and need its full details.",
+  "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": null,
+  "responseSchema": "Credit"
+}

package/dist/catalog/endpoints/show_current_company.json

@@ -0,0 +1,24 @@
+{
+  "slug": "show_current_company",
+  "operationId": "showCurrentCompany",
+  "method": "POST",
+  "path": "/api/v1/companies/current",
+  "name": "Returns the current comapny",
+  "category": "companies",
+  "mutating": true,
+  "description": "Returns the current company based on the API token passed in",
+  "whenToUse": "Return the company tied to the current API token; use when you need the authenticated context's company without knowing its 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"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Company"
+}

package/dist/catalog/endpoints/show_design.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_design",
+  "operationId": "showDesign",
+  "method": "GET",
+  "path": "/api/v1/designs/{id}",
+  "name": "Shows a design",
+  "category": "designs",
+  "mutating": false,
+  "description": "Displays a design by id",
+  "whenToUse": "Fetch one design by id to read its full template details when you already know the design's id.",
+  "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/show_expense.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_expense",
+  "operationId": "showExpense",
+  "method": "GET",
+  "path": "/api/v1/expenses/{id}",
+  "name": "Shows a expense",
+  "category": "expenses",
+  "mutating": false,
+  "description": "Displays a expense by id",
+  "whenToUse": "Fetch one expense by id to read its full details when you already know the expense's id.",
+  "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/show_expense_category.json

@@ -0,0 +1,25 @@
+{
+  "slug": "show_expense_category",
+  "operationId": "showExpenseCategory",
+  "method": "GET",
+  "path": "/api/v1/expense_categories/{id}",
+  "name": "Shows a Expens Category",
+  "category": "expense_categories",
+  "mutating": false,
+  "description": "Displays an ExpenseCategory by id",
+  "whenToUse": "Fetch one expense category by id to read its details when you already know the category's id.",
+  "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/show_group_setting.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_group_setting",
+  "operationId": "showGroupSetting",
+  "method": "GET",
+  "path": "/api/v1/group_settings/{id}",
+  "name": "Shows an GroupSetting",
+  "category": "group_settings",
+  "mutating": false,
+  "description": "Displays an GroupSetting by id",
+  "whenToUse": "Fetch one group setting by its hashed id; use to view full details of a single known group, not to list many.",
+  "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"
+}

package/dist/catalog/endpoints/show_invoice.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_invoice",
+  "operationId": "showInvoice",
+  "method": "GET",
+  "path": "/api/v1/invoices/{id}",
+  "name": "Show invoice",
+  "category": "invoices",
+  "mutating": false,
+  "description": "## GET /api/v1/invoices/{id}\n\nDisplays an invoice by id",
+  "whenToUse": "Fetch one invoice by id with optional includes; use when you have the hashed id, not get_invoices for searching.",
+  "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/show_location.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_location",
+  "operationId": "showLocation",
+  "method": "GET",
+  "path": "/api/v1/locations/{id}",
+  "name": "Show location",
+  "category": "locations",
+  "mutating": false,
+  "description": "##  GET /api/v1/locations/{id}\n\nDisplays a location by id",
+  "whenToUse": "Fetch one location's full details by its hashed id; use get_locations to search across many instead.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Location 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"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Location"
+}

package/dist/catalog/endpoints/show_payment.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_payment",
+  "operationId": "showPayment",
+  "method": "GET",
+  "path": "/api/v1/payments/{id}",
+  "name": "Show payment",
+  "category": "payments",
+  "mutating": false,
+  "description": "Displays an Payment by id",
+  "whenToUse": "Fetch one payment's full details by its hashed id when you already know the specific payment you need.",
+  "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": null,
+  "responseSchema": "Payment"
+}

package/dist/catalog/endpoints/show_payment_term.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_payment_term",
+  "operationId": "showPaymentTerm",
+  "method": "GET",
+  "path": "/api/v1/payment_terms/{id}",
+  "name": "Shows a Payment Term",
+  "category": "payment_terms",
+  "mutating": false,
+  "description": "Displays an Payment Term by id",
+  "whenToUse": "Fetch one payment term's details by its hashed id; use get_payment_terms to search across many instead.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Payment Term 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": "PaymentTerm"
+}

package/dist/catalog/endpoints/show_product.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_product",
+  "operationId": "showProduct",
+  "method": "GET",
+  "path": "/api/v1/products/{id}",
+  "name": "Show product",
+  "category": "products",
+  "mutating": false,
+  "description": "##  GET /api/v1/products/{id}\nDisplays a product by id",
+  "whenToUse": "Fetch one specific product by its id when you already know the id and need its full details, not a filtered list.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Product 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": "Product"
+}

package/dist/catalog/endpoints/show_project.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_project",
+  "operationId": "showProject",
+  "method": "GET",
+  "path": "/api/v1/projects/{id}",
+  "name": "Show project",
+  "category": "projects",
+  "mutating": false,
+  "description": "Displays a project by id",
+  "whenToUse": "Fetch one specific project by its id when you already know the id and need its full details, not a filtered list.",
+  "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": null,
+  "responseSchema": "Project"
+}

package/dist/catalog/endpoints/show_purchase_order.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_purchase_order",
+  "operationId": "showPurchaseOrder",
+  "method": "GET",
+  "path": "/api/v1/purchase_orders/{id}",
+  "name": "Show purchase order",
+  "category": "purchase_orders",
+  "mutating": false,
+  "description": "Displays an purchase order by id",
+  "whenToUse": "Fetch one purchase order's full details by its hashed id when you already know the specific PO you need.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Purchase order 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": "PurchaseOrder"
+}

package/dist/catalog/endpoints/show_quote.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_quote",
+  "operationId": "showQuote",
+  "method": "GET",
+  "path": "/api/v1/quotes/{id}",
+  "name": "Show quote",
+  "category": "quotes",
+  "mutating": false,
+  "description": "## GET /api/v1/quotes/{id}\n\nDisplays an Quote by id",
+  "whenToUse": "Fetch one quote's full record by its hashed id; use when you already know the id, not for listing or editing.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Quote 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": "Quote"
+}

package/dist/catalog/endpoints/show_recurring_expense.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_recurring_expense",
+  "operationId": "showRecurringExpense",
+  "method": "GET",
+  "path": "/api/v1/recurring_expenses/{id}",
+  "name": "Shows a recurring expense",
+  "category": "recurring_expenses",
+  "mutating": false,
+  "description": "Displays a recurring expense by id",
+  "whenToUse": "Fetch one recurring expense by its hashed id to read its full details; use when you already know the id.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The RecurringExpense 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": "RecurringExpense"
+}