@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/store_webhook.json

@@ -0,0 +1,24 @@
+{
+  "slug": "store_webhook",
+  "operationId": "storeWebhook",
+  "method": "POST",
+  "path": "/api/v1/webhooks",
+  "name": "Adds a Webhook",
+  "category": "webhooks",
+  "mutating": true,
+  "description": "Adds an Webhook to a company",
+  "whenToUse": "Create a new webhook subscription for the company when registering an endpoint to receive event callbacks (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": "Webhook"
+}

package/dist/catalog/endpoints/support_message.json

@@ -0,0 +1,25 @@
+{
+  "slug": "support_message",
+  "operationId": "supportMessage",
+  "method": "POST",
+  "path": "/api/v1/support/messages/send",
+  "name": "Sends a support message to Invoice Ninja team",
+  "category": "support",
+  "mutating": true,
+  "description": "Allows a user to send a support message to the Invoice Ninja Team",
+  "whenToUse": "Call to send a free-text support message to the Invoice Ninja team on the user's behalf (mutating).",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "message",
+        "type": "string",
+        "required": false,
+        "description": "The support message"
+      }
+    ]
+  }
+}

package/dist/catalog/endpoints/update_bank_integration.json

@@ -0,0 +1,33 @@
+{
+  "slug": "update_bank_integration",
+  "operationId": "updateBankIntegration",
+  "method": "PUT",
+  "path": "/api/v1/bank_integrations/{id}",
+  "name": "Updates a bank_integration",
+  "category": "bank_integrations",
+  "mutating": true,
+  "description": "Handles the updating of a bank_integration by id",
+  "whenToUse": "Modify an existing bank integration by its hashed id; use to save changes to a known bank integration (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,
+  "responseSchema": "BankIntegration"
+}

package/dist/catalog/endpoints/update_bank_transaction.json

@@ -0,0 +1,33 @@
+{
+  "slug": "update_bank_transaction",
+  "operationId": "updateBankTransaction",
+  "method": "PUT",
+  "path": "/api/v1/bank_transactions/{id}",
+  "name": "Updates a bank_transaction",
+  "category": "bank_transactions",
+  "mutating": true,
+  "description": "Handles the updating of a bank_transaction by id",
+  "whenToUse": "Modify an existing bank transaction by its hashed id; use to change fields on one known transaction (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,
+  "responseSchema": "BankTransaction"
+}

package/dist/catalog/endpoints/update_bank_transaction_rule.json

@@ -0,0 +1,33 @@
+{
+  "slug": "update_bank_transaction_rule",
+  "operationId": "updateBankTransactionRule",
+  "method": "PUT",
+  "path": "/api/v1/bank_transaction_rules/{id}",
+  "name": "Updates a bank_transaction Rule",
+  "category": "bank_transaction_rules",
+  "mutating": true,
+  "description": "Handles the updating of a bank_transaction rule by id",
+  "whenToUse": "Modify an existing bank transaction rule by id; reach for it to change a rule's fields after creation (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,
+  "responseSchema": "BankTransactionRule"
+}

package/dist/catalog/endpoints/update_client.json

@@ -0,0 +1,246 @@
+{
+  "slug": "update_client",
+  "operationId": "updateClient",
+  "method": "PUT",
+  "path": "/api/v1/clients/{id}",
+  "name": "Update client",
+  "category": "clients",
+  "mutating": true,
+  "description": "##  PUT /api/v1/clients/{id}\n\nHandles the updating of a client by id\n\n> 🚨 Important\nWhen creating (or updating) a client you must include the child contacts with all mutating requests. Client contacts cannot be modified in isolation.",
+  "whenToUse": "Modify an existing client by id, sending full contacts array; use to change fields, not store_client which creates new (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": "application/json",
+    "fields": [
+      {
+        "name": "id",
+        "type": "string",
+        "required": false,
+        "description": "The unique identifier of the client"
+      },
+      {
+        "name": "contacts",
+        "type": "array",
+        "required": true,
+        "description": "A list of contacts associated with the client"
+      },
+      {
+        "name": "name",
+        "type": "string",
+        "required": false,
+        "description": "The name of the client company or organization"
+      },
+      {
+        "name": "website",
+        "type": "string",
+        "required": false,
+        "description": "The website URL of the client company or organization"
+      },
+      {
+        "name": "private_notes",
+        "type": "string",
+        "required": false,
+        "description": "Notes that are only visible to the user who created the client"
+      },
+      {
+        "name": "industry_id",
+        "type": "number",
+        "required": false,
+        "description": "The unique identifier of the industry the client operates in"
+      },
+      {
+        "name": "size_id",
+        "type": "number",
+        "required": false,
+        "description": "The unique identifier for the size category of the client company or organization"
+      },
+      {
+        "name": "address1",
+        "type": "string",
+        "required": false,
+        "description": "First line of the client's address"
+      },
+      {
+        "name": "address2",
+        "type": "string",
+        "required": false,
+        "description": "Second line of the client's address, if needed"
+      },
+      {
+        "name": "city",
+        "type": "string",
+        "required": false,
+        "description": "The city the client is located in"
+      },
+      {
+        "name": "state",
+        "type": "string",
+        "required": false,
+        "description": "The state, province, or locality the client is located in"
+      },
+      {
+        "name": "postal_code",
+        "type": "string",
+        "required": false,
+        "description": "The postal code or ZIP code of the client"
+      },
+      {
+        "name": "phone",
+        "type": "string",
+        "required": false,
+        "description": "The client's phone number"
+      },
+      {
+        "name": "country_id",
+        "type": "string",
+        "required": true
+      },
+      {
+        "name": "custom_value1",
+        "type": "string",
+        "required": false,
+        "description": "A custom field for storing additional information"
+      },
+      {
+        "name": "custom_value2",
+        "type": "string",
+        "required": false,
+        "description": "A custom field for storing additional information"
+      },
+      {
+        "name": "custom_value3",
+        "type": "string",
+        "required": false,
+        "description": "A custom field for storing additional information"
+      },
+      {
+        "name": "custom_value4",
+        "type": "string",
+        "required": false,
+        "description": "A custom field for storing additional information"
+      },
+      {
+        "name": "vat_number",
+        "type": "string",
+        "required": false,
+        "description": "The client's VAT (Value Added Tax) number, if applicable"
+      },
+      {
+        "name": "id_number",
+        "type": "string",
+        "required": false,
+        "description": "A unique identification number for the client, such as a tax ID or business registration number"
+      },
+      {
+        "name": "number",
+        "type": "string",
+        "required": false,
+        "description": "A system-assigned unique number for the client, typically used for invoicing purposes"
+      },
+      {
+        "name": "shipping_address1",
+        "type": "string",
+        "required": false,
+        "description": "First line of the client's shipping address"
+      },
+      {
+        "name": "shipping_address2",
+        "type": "string",
+        "required": false,
+        "description": "Second line of the client's shipping address, if needed"
+      },
+      {
+        "name": "shipping_city",
+        "type": "string",
+        "required": false,
+        "description": "The city of the client's shipping address"
+      },
+      {
+        "name": "shipping_state",
+        "type": "string",
+        "required": false,
+        "description": "The state, province, or locality of the client's shipping address"
+      },
+      {
+        "name": "shipping_postal_code",
+        "type": "string",
+        "required": false,
+        "description": "The postal code or ZIP code of the client's shipping address"
+      },
+      {
+        "name": "shipping_country_id",
+        "type": "number",
+        "required": false,
+        "description": "The unique identifier of the client's shipping country expressed by the countries ISO number.\n\nOptionally, instead of the shipping_country_id you can pass either the iso_3166_2 or iso_3166_3 country code into the shipping_country_code prope"
+      },
+      {
+        "name": "is_deleted",
+        "type": "boolean",
+        "required": false,
+        "description": "A boolean value indicating whether the client has been deleted or not"
+      },
+      {
+        "name": "group_settings_id",
+        "type": "string",
+        "required": false,
+        "description": "The group settings assigned to the client"
+      },
+      {
+        "name": "routing_id",
+        "type": "string",
+        "required": false,
+        "description": "The routing address id for e-invoicing for this client"
+      },
+      {
+        "name": "is_tax_exempt",
+        "type": "boolean",
+        "required": false,
+        "description": "Flag which defines if the client is exempt from taxes"
+      },
+      {
+        "name": "has_valid_vat_number",
+        "type": "boolean",
+        "required": false,
+        "description": "Flag which defines if the client has a valid VAT number"
+      },
+      {
+        "name": "classification",
+        "type": "string",
+        "required": false,
+        "description": "The classification of the client"
+      },
+      {
+        "name": "settings",
+        "type": "object",
+        "required": false
+      }
+    ],
+    "schemaRef": "ClientRequest"
+  },
+  "responseSchema": "Client"
+}

package/dist/catalog/endpoints/update_client_gateway_token.json

@@ -0,0 +1,33 @@
+{
+  "slug": "update_client_gateway_token",
+  "operationId": "updateClientGatewayToken",
+  "method": "PUT",
+  "path": "/api/v1/client_gateway_tokens/{id}",
+  "name": "Updates a client payment token",
+  "category": "client_gateway_tokens",
+  "mutating": true,
+  "description": "Handles the updating of a client payment token by id",
+  "whenToUse": "Modify an existing client payment gateway token by its hashed id to change its settings (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,
+  "responseSchema": "ClientGatewayToken"
+}

package/dist/catalog/endpoints/update_client_tax_data.json

@@ -0,0 +1,38 @@
+{
+  "slug": "update_client_tax_data",
+  "operationId": "updateClientTaxData",
+  "method": "POST",
+  "path": "/api/v1/clients/{client}/updateTaxData",
+  "name": "Update tax data",
+  "category": "clients",
+  "mutating": true,
+  "description": "##  POST /api/v1/clients/{client}/updateTaxData\n\nUpdates the clients tax data - if their address has changed",
+  "whenToUse": "Recalculate and refresh one client's tax data after their address changed; narrower than update_client which edits arbitrary fields (mutating).",
+  "pathParameters": [
+    {
+      "name": "client",
+      "type": "string",
+      "required": true,
+      "description": "The Client Hashed ID reference",
+      "format": "string",
+      "example": "V2J234DFA"
+    }
+  ],
+  "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/update_company.json

@@ -0,0 +1,33 @@
+{
+  "slug": "update_company",
+  "operationId": "updateCompany",
+  "method": "PUT",
+  "path": "/api/v1/companies/{id}",
+  "name": "Updates an company",
+  "category": "companies",
+  "mutating": true,
+  "description": "Handles the updating of an company by id",
+  "whenToUse": "Modify fields on an existing company identified by id; use to change an already-created company (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,
+  "responseSchema": "Company"
+}

package/dist/catalog/endpoints/update_company_gateway.json

@@ -0,0 +1,33 @@
+{
+  "slug": "update_company_gateway",
+  "operationId": "updateCompanyGateway",
+  "method": "PUT",
+  "path": "/api/v1/company_gateways/{id}",
+  "name": "Updates an CompanyGateway",
+  "category": "company_gateways",
+  "mutating": true,
+  "description": "Handles the updating of an CompanyGateway by id",
+  "whenToUse": "Modify an existing company gateway by id; reach for it to change a gateway's settings after creation (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,
+  "responseSchema": "CompanyGateway"
+}

package/dist/catalog/endpoints/update_company_user.json

@@ -0,0 +1,16 @@
+{
+  "slug": "update_company_user",
+  "operationId": "updateCompanyUser",
+  "method": "POST",
+  "path": "/api/v1/company_users",
+  "name": "Update a company user record",
+  "category": "company_user",
+  "mutating": true,
+  "description": "Attempts to update a company user record. A company user can modify only their settings fields. Full access for Admin users",
+  "whenToUse": "Modify a company-user record's settings (full access for admins, own settings otherwise); use to change user/company preferences (mutating).",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "CompanyUser"
+}

package/dist/catalog/endpoints/update_credit.json

@@ -0,0 +1,33 @@
+{
+  "slug": "update_credit",
+  "operationId": "updateCredit",
+  "method": "PUT",
+  "path": "/api/v1/credits/{id}",
+  "name": "Update credit",
+  "category": "credits",
+  "mutating": true,
+  "description": "Handles the updating of an Credit by id",
+  "whenToUse": "Modify an existing credit by its hashed id; use to edit a specific credit record's fields rather than create or list credits (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,
+  "responseSchema": "Credit"
+}

package/dist/catalog/endpoints/update_design.json

@@ -0,0 +1,33 @@
+{
+  "slug": "update_design",
+  "operationId": "updateDesign",
+  "method": "PUT",
+  "path": "/api/v1/designs/{id}",
+  "name": "Updates a design",
+  "category": "designs",
+  "mutating": true,
+  "description": "Handles the updating of a design by id",
+  "whenToUse": "Modify an existing design by id to change its layout or settings after you have its id (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,
+  "responseSchema": "Design"
+}

package/dist/catalog/endpoints/update_expense.json

@@ -0,0 +1,33 @@
+{
+  "slug": "update_expense",
+  "operationId": "updateExpense",
+  "method": "PUT",
+  "path": "/api/v1/expenses/{id}",
+  "name": "Updates a expense",
+  "category": "expenses",
+  "mutating": true,
+  "description": "Handles the updating of a expense by id",
+  "whenToUse": "Modify an existing expense by id to correct its amount, date, or details after you have its id (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,
+  "responseSchema": "Expense"
+}