@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/bulk_users.json

@@ -0,0 +1,27 @@
+{
+  "slug": "bulk_users",
+  "operationId": "bulkUsers",
+  "method": "POST",
+  "path": "/api/v1/users/bulk",
+  "name": "Performs bulk actions on an array of users",
+  "category": "users",
+  "mutating": true,
+  "description": "Performs bulk actions on an array of users",
+  "whenToUse": "Apply a batch action across many user ids at once; use for multi-user operations instead of single-user calls (mutating).",
+  "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"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": []
+  },
+  "responseSchema": "User"
+}

package/dist/catalog/endpoints/bulk_vendors.json

@@ -0,0 +1,27 @@
+{
+  "slug": "bulk_vendors",
+  "operationId": "bulkVendors",
+  "method": "POST",
+  "path": "/api/v1/vendors/bulk",
+  "name": "Bulk vendor actions",
+  "category": "vendors",
+  "mutating": true,
+  "description": "Bulk vendor actions",
+  "whenToUse": "Apply a batch action across many vendor ids in one call; use for mass archive/restore/delete instead of acting on one record (mutating).",
+  "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"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": []
+  },
+  "responseSchema": "Vendor"
+}

package/dist/catalog/endpoints/bulk_webhooks.json

@@ -0,0 +1,27 @@
+{
+  "slug": "bulk_webhooks",
+  "operationId": "bulkWebhooks",
+  "method": "POST",
+  "path": "/api/v1/webhooks/bulk",
+  "name": "Performs bulk actions on an array of Webhooks",
+  "category": "webhooks",
+  "mutating": true,
+  "description": "Performs bulk actions on an array of Webhooks",
+  "whenToUse": "Run a batch action over an array of webhook ids at once when archiving or restoring many subscriptions together (mutating).",
+  "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"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": []
+  },
+  "responseSchema": "Webhook"
+}

package/dist/catalog/endpoints/client_statement.json

@@ -0,0 +1,77 @@
+{
+  "slug": "client_statement",
+  "operationId": "clientStatement",
+  "method": "POST",
+  "path": "/api/v1/client_statement",
+  "name": "Client statement PDF",
+  "category": "clients",
+  "mutating": true,
+  "description": "##  POST /api/v1/client_statement\n\nReturn a PDF of the client statement\n\nYou may also pass the query parameter `?send_email=true` to send the statement via email to the client.",
+  "whenToUse": "Generate a client's statement PDF for a date range, optionally emailing it; use over reports when you need one client's statement (mutating).",
+  "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": "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```"
+    },
+    {
+      "name": "send_email",
+      "type": "boolean",
+      "required": false,
+      "description": "When set to true, the statement will also be sent via email to the client.",
+      "default": false
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "start_date",
+        "type": "string",
+        "required": false,
+        "description": "The start date of the statement period - format Y-m-d"
+      },
+      {
+        "name": "end_date",
+        "type": "string",
+        "required": false,
+        "description": "The start date of the statement period - format Y-m-d"
+      },
+      {
+        "name": "client_id",
+        "type": "string",
+        "required": false,
+        "description": "The hashed ID of the client"
+      },
+      {
+        "name": "show_payments_table",
+        "type": "boolean",
+        "required": false,
+        "description": "Flag which determines if the payments table is shown"
+      },
+      {
+        "name": "show_credits_table",
+        "type": "boolean",
+        "required": false,
+        "description": "Flag which determines if the credits table is shown"
+      },
+      {
+        "name": "show_aging_table",
+        "type": "boolean",
+        "required": false,
+        "description": "Flag which determines if the aging table is shown"
+      }
+    ]
+  },
+  "responseSchema": "Client"
+}

package/dist/catalog/endpoints/confirm_apple_purchase.json

@@ -0,0 +1,23 @@
+{
+  "slug": "confirm_apple_purchase",
+  "operationId": "confirmApplePurchase",
+  "method": "POST",
+  "path": "/api/v1/apple/confirm_purchase",
+  "name": "Processing webhooks from Apple for in app purchases",
+  "category": "postmark",
+  "mutating": true,
+  "description": "Adds an credit to the system",
+  "whenToUse": "Confirm an Apple in-app purchase and credit the account when handling a one-time Apple purchase confirmation, not a subscription event (mutating).",
+  "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
+}

package/dist/catalog/endpoints/create_task_scheduler.json

@@ -0,0 +1,81 @@
+{
+  "slug": "create_task_scheduler",
+  "operationId": "createTaskScheduler",
+  "method": "POST",
+  "path": "/api/v1/task_schedulers",
+  "name": "Create task scheduler with job",
+  "category": "task_schedulers",
+  "mutating": true,
+  "description": "Create task scheduler with a job (action(job) request should be sent via request also. Example: We want client report to be job which will be run\nmultiple times, we should send the same parameters in the request as we would send if we wanted to get report, see example",
+  "whenToUse": "Create a new scheduler that runs a recurring job (e.g. report) on a repeat interval and start date (mutating).",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [
+    {
+      "name": "X-API-SECRET",
+      "type": "string",
+      "required": false,
+      "description": "The API secret as defined by the .env variable API_SECRET. Only needed for self hosted users, and only applicable on the login route.",
+      "example": "password"
+    }
+  ],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "paused",
+        "type": "boolean",
+        "required": false,
+        "description": "The scheduler paused state"
+      },
+      {
+        "name": "repeat_every",
+        "type": "string",
+        "required": false,
+        "description": "Accepted values (DAY,WEEK,MONTH,3MONTHS,YEAR)"
+      },
+      {
+        "name": "start_from",
+        "type": "integer",
+        "required": false,
+        "description": "Timestamp when we should start the scheduler, default is today"
+      },
+      {
+        "name": "job",
+        "type": "string",
+        "required": false,
+        "description": "Job, we can find list of available jobs in Scheduler model"
+      },
+      {
+        "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": "TaskSchedulerSchema"
+  }
+}

package/dist/catalog/endpoints/delete_bank_integration.json

@@ -0,0 +1,32 @@
+{
+  "slug": "delete_bank_integration",
+  "operationId": "deleteBankIntegration",
+  "method": "DELETE",
+  "path": "/api/v1/bank_integrations/{id}",
+  "name": "Deletes a bank_integration",
+  "category": "bank_integrations",
+  "mutating": true,
+  "description": "Handles the deletion of a bank_integration by id",
+  "whenToUse": "Archive/soft-delete one bank integration by its hashed id; use to remove a bank integration, not to update it (mutating).",
+  "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
+}

package/dist/catalog/endpoints/delete_bank_transaction.json

@@ -0,0 +1,32 @@
+{
+  "slug": "delete_bank_transaction",
+  "operationId": "deleteBankTransaction",
+  "method": "DELETE",
+  "path": "/api/v1/bank_transactions/{id}",
+  "name": "Deletes a bank_transaction",
+  "category": "bank_transactions",
+  "mutating": true,
+  "description": "Handles the deletion of a bank_transaction by id",
+  "whenToUse": "Archive or soft-delete one bank transaction by its hashed id; use to remove a single transaction you already identified (mutating).",
+  "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
+}

package/dist/catalog/endpoints/delete_bank_transaction_rule.json

@@ -0,0 +1,32 @@
+{
+  "slug": "delete_bank_transaction_rule",
+  "operationId": "deleteBankTransactionRule",
+  "method": "DELETE",
+  "path": "/api/v1/bank_transaction_rules/{id}",
+  "name": "Deletes a bank_transaction rule",
+  "category": "bank_transaction_rules",
+  "mutating": true,
+  "description": "Handles the deletion of a bank_transaction rule by id",
+  "whenToUse": "Archive/soft-delete one bank transaction rule by id; reach for it to remove an existing rule (mutating).",
+  "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
+}

package/dist/catalog/endpoints/delete_client.json

@@ -0,0 +1,38 @@
+{
+  "slug": "delete_client",
+  "operationId": "deleteClient",
+  "method": "DELETE",
+  "path": "/api/v1/clients/{id}",
+  "name": "Delete client",
+  "category": "clients",
+  "mutating": true,
+  "description": "##  DELETE /api/v1/clients/{id}\n\nHandles the deletion of a client by id\n\n> ❗ Note\nDeleting a client does not purge the client from the system. The delete action will remove the clients data from all\nviews in the application but keep it on file in case it needs to be restored.\n\nA Client can be later restored reversing this action.\n\nTo permanently wipe a client and all of their records from the system, use the [/purge route](/#tag/clients/POST/api/v1/clients/{id}/purge)",
+  "whenToUse": "Archive/soft-delete one client by id, keeping data restorable; use this over purge_client when removal need not be permanent (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": null
+}

package/dist/catalog/endpoints/delete_client_gateway_token.json

@@ -0,0 +1,32 @@
+{
+  "slug": "delete_client_gateway_token",
+  "operationId": "deleteClientGatewayToken",
+  "method": "DELETE",
+  "path": "/api/v1/client_gateway_tokens/{id}",
+  "name": "Deletes a client",
+  "category": "client_gateway_tokens",
+  "mutating": true,
+  "description": "Handles the deletion of a client payment token by id",
+  "whenToUse": "Archive or soft-delete one existing client payment gateway token by its hashed id to remove a saved card (mutating).",
+  "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
+}

package/dist/catalog/endpoints/delete_company.json

@@ -0,0 +1,32 @@
+{
+  "slug": "delete_company",
+  "operationId": "deleteCompany",
+  "method": "DELETE",
+  "path": "/api/v1/companies/{id}",
+  "name": "Deletes a company",
+  "category": "companies",
+  "mutating": true,
+  "description": "Handles the deletion of an company by id",
+  "whenToUse": "Archive/soft-delete one company by id; use to remove a company while keeping its record recoverable (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": null
+}

package/dist/catalog/endpoints/delete_company_gateway.json

@@ -0,0 +1,32 @@
+{
+  "slug": "delete_company_gateway",
+  "operationId": "deleteCompanyGateway",
+  "method": "DELETE",
+  "path": "/api/v1/company_gateways/{id}",
+  "name": "Deletes a CompanyGateway",
+  "category": "company_gateways",
+  "mutating": true,
+  "description": "Handles the deletion of an CompanyGateway by id",
+  "whenToUse": "Archive/soft-delete one company gateway by id; reach for it to remove an existing payment gateway (mutating).",
+  "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
+}

package/dist/catalog/endpoints/delete_credit.json

@@ -0,0 +1,32 @@
+{
+  "slug": "delete_credit",
+  "operationId": "deleteCredit",
+  "method": "DELETE",
+  "path": "/api/v1/credits/{id}",
+  "name": "Delete credit",
+  "category": "credits",
+  "mutating": true,
+  "description": "Handles the deletion of an credit by id",
+  "whenToUse": "Archive/soft-delete one credit by id; reach for it to remove an existing credit (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": null
+}

package/dist/catalog/endpoints/delete_design.json

@@ -0,0 +1,32 @@
+{
+  "slug": "delete_design",
+  "operationId": "deleteDesign",
+  "method": "DELETE",
+  "path": "/api/v1/designs/{id}",
+  "name": "Deletes a design",
+  "category": "designs",
+  "mutating": true,
+  "description": "Handles the deletion of a design by id",
+  "whenToUse": "Archive/soft-delete one design by id when retiring a template you no longer want available (mutating).",
+  "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
+}

package/dist/catalog/endpoints/delete_expense.json

@@ -0,0 +1,32 @@
+{
+  "slug": "delete_expense",
+  "operationId": "deleteExpense",
+  "method": "DELETE",
+  "path": "/api/v1/expenses/{id}",
+  "name": "Deletes a expense",
+  "category": "expenses",
+  "mutating": true,
+  "description": "Handles the deletion of a expense by id",
+  "whenToUse": "Archive/soft-delete one expense by id when removing a logged cost (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": null
+}

package/dist/catalog/endpoints/delete_expense_category.json

@@ -0,0 +1,24 @@
+{
+  "slug": "delete_expense_category",
+  "operationId": "deleteExpenseCategory",
+  "method": "DELETE",
+  "path": "/api/v1/expense_categories/{id}",
+  "name": "Deletes a ExpenseCategory",
+  "category": "expense_categories",
+  "mutating": true,
+  "description": "Handles the deletion of an ExpenseCategory by id",
+  "whenToUse": "Archive/soft-delete one expense category by id when retiring a classification you no longer use (mutating).",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The ExpenseCategory Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/delete_group_setting.json

@@ -0,0 +1,32 @@
+{
+  "slug": "delete_group_setting",
+  "operationId": "deleteGroupSetting",
+  "method": "DELETE",
+  "path": "/api/v1/group_settings/{id}",
+  "name": "Deletes a GroupSetting",
+  "category": "group_settings",
+  "mutating": true,
+  "description": "Handles the deletion of an GroupSetting by id",
+  "whenToUse": "Archive or soft-delete one group setting by its hashed id; use to remove a single known group (mutating).",
+  "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
+}