@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/post_purge_company.json

@@ -0,0 +1,24 @@
+{
+  "slug": "post_purge_company",
+  "operationId": "postPurgeCompany",
+  "method": "POST",
+  "path": "/api/v1/migration/purge/{company}",
+  "name": "Attempts to purge a company record and all its child records",
+  "category": "migration",
+  "mutating": true,
+  "description": "Attempts to purge a company record and all its child records",
+  "whenToUse": "Permanently purge a company and ALL its child records by company id; use only for full deletion, not the settings-preserving purge (mutating).",
+  "pathParameters": [
+    {
+      "name": "company",
+      "type": "string",
+      "required": true,
+      "description": "The Company Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/post_purge_company_save_settings.json

@@ -0,0 +1,24 @@
+{
+  "slug": "post_purge_company_save_settings",
+  "operationId": "postPurgeCompanySaveSettings",
+  "method": "POST",
+  "path": "/api/v1/migration/purge_save_settings/{company}",
+  "name": "Attempts to purge a companies child records but save the company record and its settings",
+  "category": "migration",
+  "mutating": true,
+  "description": "Attempts to purge a companies child records but save the company record and its settings",
+  "whenToUse": "Purge a company's child records by company id while preserving the company and its settings, when wiping data but keeping the account (mutating).",
+  "pathParameters": [
+    {
+      "name": "company",
+      "type": "string",
+      "required": true,
+      "description": "The Company Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/post_refresh.json

@@ -0,0 +1,46 @@
+{
+  "slug": "post_refresh",
+  "operationId": "postRefresh",
+  "method": "POST",
+  "path": "/api/v1/refresh",
+  "name": "Refresh data by timestamp",
+  "category": "refresh",
+  "mutating": true,
+  "description": "Refreshes the dataset.\n\nThis endpoint can be used if you only need to access the most recent data from a certain point in time. For example, if you only want to retrieve The\nmost recent data from the last time you accessed the system, you would pass the query parameter ?updated_at=1676173763. (unix timestamp)",
+  "whenToUse": "Call to fetch only records changed since a given updated_at unix timestamp for incremental sync rather than re-pulling all data (mutating).",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "updated_at",
+      "type": "number",
+      "required": true,
+      "description": "The unix timestamp from which the refreshed data should be sent from, if no value is passed the system will assume you require all data.",
+      "format": "integer",
+      "example": 1676173763
+    },
+    {
+      "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": "include_static",
+      "type": "string",
+      "required": false,
+      "description": "This include will return the full set of static variables used in the application including:\n  - Currencies\n  - Countries\n  - Languages\n  - Payment Types\n  - Email Templatees\n  - Industries",
+      "example": "include_static=true"
+    },
+    {
+      "name": "clear_cache",
+      "type": "string",
+      "required": false,
+      "description": "Clears cache\n\nClears (and rebuilds) the static variable cache.",
+      "example": "clear_cache=true"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "CompanyUser"
+}

package/dist/catalog/endpoints/post_search.json

@@ -0,0 +1,18 @@
+{
+  "slug": "post_search",
+  "operationId": "postSearch",
+  "method": "POST",
+  "path": "/api/v1/search",
+  "name": "Search",
+  "category": "search",
+  "mutating": false,
+  "description": "Performs a search across entities",
+  "whenToUse": "Call to run a global keyword search spanning multiple entity types when you need cross-resource matches, not single-resource list filters",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": []
+  }
+}

package/dist/catalog/endpoints/post_settings_passkeys.json

@@ -0,0 +1,34 @@
+{
+  "slug": "post_settings_passkeys",
+  "operationId": "postSettingsPasskeys",
+  "method": "POST",
+  "path": "/api/v1/settings/passkeys",
+  "name": "Create passkey",
+  "category": "auth",
+  "mutating": true,
+  "description": "Create passkey",
+  "whenToUse": "Register a new passkey for the signed-in user by submitting the challenge token and WebAuthn credential (mutating).",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "challenge_token",
+        "type": "string",
+        "required": true
+      },
+      {
+        "name": "credential",
+        "type": "object",
+        "required": true
+      },
+      {
+        "name": "name",
+        "type": "string",
+        "required": false
+      }
+    ]
+  }
+}

package/dist/catalog/endpoints/post_settings_passkeys_options.json

@@ -0,0 +1,15 @@
+{
+  "slug": "post_settings_passkeys_options",
+  "operationId": "postSettingsPasskeysOptions",
+  "method": "POST",
+  "path": "/api/v1/settings/passkeys/options",
+  "name": "Passkey registration options",
+  "category": "auth",
+  "mutating": true,
+  "description": "Passkey registration options",
+  "whenToUse": "Request WebAuthn registration challenge options to begin enrolling a new passkey before calling post_settings_passkeys (mutating).",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/post_start_migration.json

@@ -0,0 +1,31 @@
+{
+  "slug": "post_start_migration",
+  "operationId": "postStartMigration",
+  "method": "POST",
+  "path": "/api/v1/migration/start",
+  "name": "Starts the migration from previous version of Invoice Ninja",
+  "category": "migration",
+  "mutating": true,
+  "description": "Starts the migration from previous version of Invoice Ninja",
+  "whenToUse": "Start importing a v4 Invoice Ninja migration file (requires X-API-PASSWORD) when migrating a whole prior install, not mapping a CSV (mutating).",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "migration",
+      "type": "object",
+      "required": true,
+      "description": "The migraton file",
+      "format": "file"
+    }
+  ],
+  "headerParameters": [
+    {
+      "name": "X-API-PASSWORD",
+      "type": "string",
+      "required": true,
+      "description": "The login password when challenged on certain protected routes",
+      "example": "supersecretpassword"
+    }
+  ],
+  "requestBody": null
+}

package/dist/catalog/endpoints/postmark_webhook.json

@@ -0,0 +1,24 @@
+{
+  "slug": "postmark_webhook",
+  "operationId": "postmarkWebhook",
+  "method": "POST",
+  "path": "/api/v1/postmark_webhook",
+  "name": "Processing webhooks from PostMark",
+  "category": "postmark",
+  "mutating": true,
+  "description": "Adds an credit to the system",
+  "whenToUse": "Receive Postmark email event webhooks (delivery/bounce) for inbound email processing, not Apple purchase events (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,
+  "responseSchema": "Credit"
+}

package/dist/catalog/endpoints/preimport.json

@@ -0,0 +1,69 @@
+{
+  "slug": "preimport",
+  "operationId": "preimport",
+  "method": "POST",
+  "path": "/api/v1/preimport",
+  "name": "Pre Import CSV data",
+  "category": "imports",
+  "mutating": true,
+  "description": "The preimport endpoint is the first step when importing CSV data into Invoice Ninja. It validates your file(s) and returns the column headers found in each CSV, allowing you to map them to system fields before performing the actual import.\n\n*How it works**\n\n1. Set `import_type` to indicate the entity type (e.g. `invoice`, `quote`, `client`, `product`, `payment`, `vendor`, `expense`).\n2. Attach one or more CSV files using the `files[]` parameter, keyed by entity type:\n   - `files[invoice]` — invoice records\n   - `files[client]` — client records\n   - `files[product]` — product records\n   - `files[payment]` — payment records\n   - `files[vendor]` — vendor records\n   - `files[expense]` — expense records\n3. The response returns the detected column headers for each uploaded file so you can build a field mapping for the subsequent `/api/v1/import` call.\n\nYou may upload multiple entity files in a single request. Only include the entity types relevant to your import.\n\n*Example**\n\n```bash\ncurl -X POST 'https://invoiceninja.com/api/v1/preimport' \\\n  -H 'X-API-TOKEN: YOUR_API_TOKEN_HERE' \\\n  -H 'Accept: application/json' \\\n  -F 'import_type=invoice' \\\n  -F 'files[invoice]=@invoices.csv' \\\n  -F 'files[client]=@clients.csv'\n```",
+  "whenToUse": "Upload CSV file(s) first to validate them and get column headers for mapping, before calling the import endpoint that runs the import (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": {
+    "contentType": "multipart/form-data",
+    "fields": [
+      {
+        "name": "import_type",
+        "type": "string",
+        "required": true,
+        "description": "The type of import being performed"
+      },
+      {
+        "name": "files[invoice]",
+        "type": "string",
+        "required": false,
+        "description": "CSV file for invoices"
+      },
+      {
+        "name": "files[client]",
+        "type": "string",
+        "required": false,
+        "description": "CSV file for clients"
+      },
+      {
+        "name": "files[product]",
+        "type": "string",
+        "required": false,
+        "description": "CSV file for products"
+      },
+      {
+        "name": "files[payment]",
+        "type": "string",
+        "required": false,
+        "description": "CSV file for payments"
+      },
+      {
+        "name": "files[vendor]",
+        "type": "string",
+        "required": false,
+        "description": "CSV file for vendors"
+      },
+      {
+        "name": "files[expense]",
+        "type": "string",
+        "required": false,
+        "description": "CSV file for expenses"
+      }
+    ]
+  }
+}

package/dist/catalog/endpoints/process_apple_webhook.json

@@ -0,0 +1,23 @@
+{
+  "slug": "process_apple_webhook",
+  "operationId": "processAppleWebhook",
+  "method": "POST",
+  "path": "/api/v1/apple/process_webhook",
+  "name": "Processing event webhooks from Apple for in purchase / subscription status update",
+  "category": "postmark",
+  "mutating": true,
+  "description": "Adds an credit to the system",
+  "whenToUse": "Process Apple subscription/purchase-status event webhooks for ongoing updates, distinct from confirming a single purchase (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/purge_client.json

@@ -0,0 +1,32 @@
+{
+  "slug": "purge_client",
+  "operationId": "purgeClient",
+  "method": "POST",
+  "path": "/api/v1/clients/{id}/purge",
+  "name": "Purge client",
+  "category": "clients",
+  "mutating": true,
+  "description": "##  POST /api/v1/clients/{id}/purge\n\nHandles purging a client.\n\n> ❗ Note\nThis is a destructive action.\nThis action will remove all data associated with the client and cannot be undone.",
+  "whenToUse": "Permanently and irreversibly wipe one client and all their records (needs X-API-PASSWORD); use over delete_client only when destruction is intended (mutating).",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Client Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "queryParameters": [],
+  "headerParameters": [
+    {
+      "name": "X-API-PASSWORD",
+      "type": "string",
+      "required": true,
+      "description": "The login password when challenged on certain protected routes",
+      "example": "supersecretpassword"
+    }
+  ],
+  "requestBody": null
+}

package/dist/catalog/endpoints/reactivate_email.json

@@ -0,0 +1,38 @@
+{
+  "slug": "reactivate_email",
+  "operationId": "reactivateEmail",
+  "method": "POST",
+  "path": "/api/v1/reactivate_email/{bounce_id}",
+  "name": "Removes email suppression of a user in the system",
+  "category": "clients",
+  "mutating": true,
+  "description": "##  POST /api/v1/reactivate_email/{bounce_id}\n\nEmails are suppressed by PostMark, when they receive a Hard bounce / Spam Complaint. This endpoint allows you to remove the suppression and send emails to the user again.",
+  "whenToUse": "Remove a Postmark email suppression by bounce_id so a hard-bounced or complained address can receive mail again (mutating).",
+  "pathParameters": [
+    {
+      "name": "bounce_id",
+      "type": "string",
+      "required": true,
+      "description": "The postmark Bounce ID reference",
+      "format": "string",
+      "example": "123243"
+    }
+  ],
+  "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/self_update.json

@@ -0,0 +1,31 @@
+{
+  "slug": "self_update",
+  "operationId": "selfUpdate",
+  "method": "POST",
+  "path": "/api/v1/self-update",
+  "name": "Performs a system update",
+  "category": "update",
+  "mutating": true,
+  "description": "Performs a system update",
+  "whenToUse": "Trigger the self-hosted Invoice Ninja system to install an available update; requires the X-API-PASSWORD header (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": [
+    {
+      "name": "X-API-PASSWORD",
+      "type": "string",
+      "required": true,
+      "description": "The login password when challenged on certain protected routes",
+      "example": "supersecretpassword"
+    }
+  ],
+  "requestBody": null
+}

package/dist/catalog/endpoints/self_update_check_version.json

@@ -0,0 +1,15 @@
+{
+  "slug": "self_update_check_version",
+  "operationId": "selfUpdateCheckVersion",
+  "method": "POST",
+  "path": "/api/v1/self-update/check_version",
+  "name": "Check for available update",
+  "category": "update",
+  "mutating": true,
+  "description": "Checks for an available system update",
+  "whenToUse": "Check whether a newer Invoice Ninja version is available before deciding to run self_update; does not install anything (mutating).",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/send_email_template.json

@@ -0,0 +1,73 @@
+{
+  "slug": "send_email_template",
+  "operationId": "sendEmailTemplate",
+  "method": "POST",
+  "path": "/api/v1/emails",
+  "name": "Sends an email for an entity",
+  "category": "emails",
+  "mutating": true,
+  "description": "Sends an email for an entity",
+  "whenToUse": "Email an entity (invoice, quote, credit, payment, reminder, PO) using a named template by entity and entity_id; use to dispatch templated client emails (mutating).",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "subject",
+        "type": "string",
+        "required": false,
+        "description": "The email subject"
+      },
+      {
+        "name": "body",
+        "type": "string",
+        "required": false,
+        "description": "The email body"
+      },
+      {
+        "name": "entity",
+        "type": "string",
+        "required": true,
+        "description": "The entity name"
+      },
+      {
+        "name": "entity_id",
+        "type": "string",
+        "required": true,
+        "description": "The entity_id"
+      },
+      {
+        "name": "cc_email",
+        "type": "string",
+        "required": false,
+        "description": "The email address of a user to be CC'd on the email"
+      },
+      {
+        "name": "template",
+        "type": "string",
+        "required": true,
+        "description": "The template required",
+        "enum": [
+          "email_template_invoice",
+          "email_template_quote",
+          "email_template_credit",
+          "email_template_payment",
+          "email_template_payment_partial",
+          "email_template_statement",
+          "email_template_reminder1",
+          "email_template_reminder2",
+          "email_template_reminder3",
+          "email_template_reminder_endless",
+          "email_template_custom1",
+          "email_template_custom2",
+          "email_template_custom3",
+          "email_template_purchase_order",
+          "email_quote_template_reminder1"
+        ]
+      }
+    ]
+  },
+  "responseSchema": "Template"
+}

package/dist/catalog/endpoints/set_default_company.json

@@ -0,0 +1,33 @@
+{
+  "slug": "set_default_company",
+  "operationId": "setDefaultCompany",
+  "method": "POST",
+  "path": "/api/v1/companies/{company}/default",
+  "name": "Sets the company as the default company.",
+  "category": "companies",
+  "mutating": true,
+  "description": "Sets the company as the default company.",
+  "whenToUse": "Mark an existing company (by hashed id) as the account's default company; use to switch the default, not to edit fields (mutating).",
+  "pathParameters": [
+    {
+      "name": "company",
+      "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_bank_integration.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_bank_integration",
+  "operationId": "showBankIntegration",
+  "method": "GET",
+  "path": "/api/v1/bank_integrations/{id}",
+  "name": "Shows a bank_integration",
+  "category": "bank_integrations",
+  "mutating": false,
+  "description": "Displays a bank_integration by id",
+  "whenToUse": "Fetch one bank integration's 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 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/show_bank_transaction.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_bank_transaction",
+  "operationId": "showBankTransaction",
+  "method": "GET",
+  "path": "/api/v1/bank_transactions/{id}",
+  "name": "Shows a bank_transaction",
+  "category": "bank_transactions",
+  "mutating": false,
+  "description": "Displays a bank_transaction by id",
+  "whenToUse": "Fetch one bank transaction by its hashed id; use to view full details of a single known transaction, not to list many.",
+  "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/show_bank_transaction_rule.json

@@ -0,0 +1,33 @@
+{
+  "slug": "show_bank_transaction_rule",
+  "operationId": "showBankTransactionRule",
+  "method": "GET",
+  "path": "/api/v1/bank_transaction_rules/{id}",
+  "name": "Shows a bank_transaction",
+  "category": "bank_transaction_rules",
+  "mutating": false,
+  "description": "Displays a bank_transaction by id",
+  "whenToUse": "Fetch one bank transaction rule by its id; reach for it when you already know the rule's id and need its details.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Bank Transaction RuleHashed 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"
+}