@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/store_refund.json

@@ -0,0 +1,235 @@
+{
+  "slug": "store_refund",
+  "operationId": "storeRefund",
+  "method": "POST",
+  "path": "/api/v1/payments/refund",
+  "name": "Refund payment",
+  "category": "payments",
+  "mutating": true,
+  "description": "Adds an Refund to the system",
+  "whenToUse": "Refund an existing payment, specifying amount and target invoices, when reversing funds rather than recording a new payment (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": "application/json",
+    "fields": [
+      {
+        "name": "id",
+        "type": "string",
+        "required": false,
+        "description": "The payment hashed id"
+      },
+      {
+        "name": "client_id",
+        "type": "string",
+        "required": false,
+        "description": "The client hashed id"
+      },
+      {
+        "name": "invitation_id",
+        "type": "string",
+        "required": false,
+        "description": "The invitation hashed id"
+      },
+      {
+        "name": "client_contact_id",
+        "type": "string",
+        "required": false,
+        "description": "The client contact hashed id"
+      },
+      {
+        "name": "user_id",
+        "type": "string",
+        "required": false,
+        "description": "The user hashed id"
+      },
+      {
+        "name": "type_id",
+        "type": "string",
+        "required": false,
+        "description": "The payment type used to complete this payment",
+        "enum": [
+          "1",
+          "2",
+          "3",
+          "4",
+          "5",
+          "6",
+          "7",
+          "8",
+          "9",
+          "10",
+          "11",
+          "12",
+          "13",
+          "14",
+          "15",
+          "16",
+          "17",
+          "18",
+          "19",
+          "20",
+          "21",
+          "22",
+          "23",
+          "24",
+          "25",
+          "26",
+          "27",
+          "28",
+          "29",
+          "30",
+          "31",
+          "32",
+          "33"
+        ]
+      },
+      {
+        "name": "date",
+        "type": "string",
+        "required": false,
+        "description": "The Payment date"
+      },
+      {
+        "name": "transaction_reference",
+        "type": "string",
+        "required": false,
+        "description": "The transaction reference as defined by the payment gateway"
+      },
+      {
+        "name": "assigned_user_id",
+        "type": "string",
+        "required": false,
+        "description": "The assigned user hashed id"
+      },
+      {
+        "name": "private_notes",
+        "type": "string",
+        "required": false,
+        "description": "The private notes of the payment"
+      },
+      {
+        "name": "is_manual",
+        "type": "boolean",
+        "required": false,
+        "description": "Flags whether the payment was made manually or processed via a gateway"
+      },
+      {
+        "name": "is_deleted",
+        "type": "boolean",
+        "required": false,
+        "description": "Defines if the payment has been deleted"
+      },
+      {
+        "name": "amount",
+        "type": "number",
+        "required": false,
+        "description": "The amount of this payment"
+      },
+      {
+        "name": "refunded",
+        "type": "number",
+        "required": false,
+        "description": "The refunded amount of this payment"
+      },
+      {
+        "name": "updated_at",
+        "type": "number",
+        "required": false,
+        "description": "Timestamp"
+      },
+      {
+        "name": "archived_at",
+        "type": "number",
+        "required": false,
+        "description": "Timestamp"
+      },
+      {
+        "name": "company_gateway_id",
+        "type": "string",
+        "required": false,
+        "description": "The company gateway id"
+      },
+      {
+        "name": "paymentables",
+        "type": "object",
+        "required": false
+      },
+      {
+        "name": "invoices",
+        "type": "array",
+        "required": false
+      },
+      {
+        "name": "credits",
+        "type": "array",
+        "required": false
+      },
+      {
+        "name": "number",
+        "type": "string",
+        "required": false,
+        "description": "The payment number - is a unique alpha numeric number per payment per company"
+      },
+      {
+        "name": "category_id",
+        "type": "string",
+        "required": false,
+        "description": "The unique identifier of the payment category"
+      },
+      {
+        "name": "custom_value1",
+        "type": "string",
+        "required": false,
+        "description": "Custom field for storing additional information"
+      },
+      {
+        "name": "custom_value2",
+        "type": "string",
+        "required": false,
+        "description": "Custom field for storing additional information"
+      },
+      {
+        "name": "custom_value3",
+        "type": "string",
+        "required": false,
+        "description": "Custom field for storing additional information"
+      },
+      {
+        "name": "custom_value4",
+        "type": "string",
+        "required": false,
+        "description": "Custom field for storing additional information"
+      },
+      {
+        "name": "exchange_currency_id",
+        "type": "string",
+        "required": false,
+        "description": "The unique identifier of the exchange currency"
+      },
+      {
+        "name": "exchange_rate",
+        "type": "number",
+        "required": false,
+        "description": "The exchange rate used for currency conversion"
+      },
+      {
+        "name": "idempotency_key",
+        "type": "string",
+        "required": false,
+        "description": "Unique key to ensure idempotent payment processing"
+      }
+    ],
+    "schemaRef": "Payment"
+  },
+  "responseSchema": "Payment"
+}

package/dist/catalog/endpoints/store_subscription.json

@@ -0,0 +1,24 @@
+{
+  "slug": "store_subscription",
+  "operationId": "storeSubscription",
+  "method": "POST",
+  "path": "/api/v1/subscriptions",
+  "name": "Adds a subscriptions",
+  "category": "subscriptions",
+  "mutating": true,
+  "description": "Adds an subscriptions to the system",
+  "whenToUse": "Create a new subscription product/plan in the system when setting up a recurring offering (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": "Subscription"
+}

package/dist/catalog/endpoints/store_tag.json

@@ -0,0 +1,43 @@
+{
+  "slug": "store_tag",
+  "operationId": "storeTag",
+  "method": "POST",
+  "path": "/api/v1/tags",
+  "name": "Create tag",
+  "category": "tags",
+  "mutating": true,
+  "description": "Creates a tag catalog entry for a supported entity type.",
+  "whenToUse": "Create a new tag catalog entry with name, color, and immutable entity_type for a supported entity (mutating).",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "entity_type",
+        "type": "string",
+        "required": true,
+        "description": "Required on create. Immutable after creation.",
+        "enum": [
+          "App\\Models\\Task",
+          "App\\Models\\Project"
+        ]
+      },
+      {
+        "name": "name",
+        "type": "string",
+        "required": true,
+        "description": "The tag name. Unique per company and entity type, including archived tags."
+      },
+      {
+        "name": "color",
+        "type": "string",
+        "required": false,
+        "description": "The tag color as a 3 or 6 digit hex value, or null to clear it."
+      }
+    ],
+    "schemaRef": "TagRequest"
+  },
+  "responseSchema": "Tag"
+}

package/dist/catalog/endpoints/store_task.json

@@ -0,0 +1,113 @@
+{
+  "slug": "store_task",
+  "operationId": "storeTask",
+  "method": "POST",
+  "path": "/api/v1/tasks",
+  "name": "Create task",
+  "category": "tasks",
+  "mutating": true,
+  "description": "Adds an task to a company",
+  "whenToUse": "Create a new task with a description and optional client/project/time fields; use when adding a task that does not yet exist (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": "application/json",
+    "fields": [
+      {
+        "name": "description",
+        "type": "string",
+        "required": true,
+        "description": "Task description"
+      },
+      {
+        "name": "client_id",
+        "type": "string",
+        "required": false,
+        "description": "The hashed ID of the client"
+      },
+      {
+        "name": "project_id",
+        "type": "string",
+        "required": false,
+        "description": "The hashed ID of the project"
+      },
+      {
+        "name": "time_log",
+        "type": "string",
+        "required": false,
+        "description": "Time logged for the task"
+      },
+      {
+        "name": "status_id",
+        "type": "integer",
+        "required": false,
+        "description": "Status ID of the task"
+      },
+      {
+        "name": "custom_value1",
+        "type": "string",
+        "required": false,
+        "description": "Custom field value 1"
+      },
+      {
+        "name": "custom_value2",
+        "type": "string",
+        "required": false,
+        "description": "Custom field value 2"
+      },
+      {
+        "name": "custom_value3",
+        "type": "string",
+        "required": false,
+        "description": "Custom field value 3"
+      },
+      {
+        "name": "custom_value4",
+        "type": "string",
+        "required": false,
+        "description": "Custom field value 4"
+      },
+      {
+        "name": "is_deleted",
+        "type": "boolean",
+        "required": false,
+        "description": "Whether the task is deleted"
+      },
+      {
+        "name": "archived_at",
+        "type": "integer",
+        "required": false,
+        "description": "Timestamp when task was archived"
+      },
+      {
+        "name": "due_date",
+        "type": "string",
+        "required": false,
+        "description": "Due date for the task"
+      },
+      {
+        "name": "priority",
+        "type": "integer",
+        "required": false,
+        "description": "Priority level of the task"
+      },
+      {
+        "name": "tags",
+        "type": "array",
+        "required": false,
+        "description": "Full sync array of hashed tag IDs. Omit to leave existing tags unchanged; send [] to detach all tags."
+      }
+    ],
+    "schemaRef": "TaskRequest"
+  },
+  "responseSchema": "Task"
+}

package/dist/catalog/endpoints/store_task_status.json

@@ -0,0 +1,77 @@
+{
+  "slug": "store_task_status",
+  "operationId": "storeTaskStatus",
+  "method": "POST",
+  "path": "/api/v1/task_statuses",
+  "name": "Adds a TaskStatus",
+  "category": "task_status",
+  "mutating": true,
+  "description": "Adds a TaskStatusto the system",
+  "whenToUse": "Create a new task status with name, color, and order; reach for it to add a status that does not yet exist (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": "application/json",
+    "fields": [
+      {
+        "name": "id",
+        "type": "string",
+        "required": false,
+        "description": "The task status hashed id"
+      },
+      {
+        "name": "name",
+        "type": "string",
+        "required": false,
+        "description": "The task status name"
+      },
+      {
+        "name": "color",
+        "type": "string",
+        "required": false,
+        "description": "The task status color - hex value"
+      },
+      {
+        "name": "task_status_order",
+        "type": "integer",
+        "required": false,
+        "description": "The order of the task status"
+      },
+      {
+        "name": "created_at",
+        "type": "number",
+        "required": false,
+        "description": "Timestamp"
+      },
+      {
+        "name": "is_deleted",
+        "type": "boolean",
+        "required": false,
+        "description": "A boolean flag determining if the task status has been deleted"
+      },
+      {
+        "name": "updated_at",
+        "type": "number",
+        "required": false,
+        "description": "Timestamp"
+      },
+      {
+        "name": "archived_at",
+        "type": "number",
+        "required": false,
+        "description": "Timestamp"
+      }
+    ],
+    "schemaRef": "TaskStatus"
+  },
+  "responseSchema": "TaskStatus"
+}

package/dist/catalog/endpoints/store_token.json

@@ -0,0 +1,24 @@
+{
+  "slug": "store_token",
+  "operationId": "storeToken",
+  "method": "POST",
+  "path": "/api/v1/tokens",
+  "name": "Adds a token",
+  "category": "tokens",
+  "mutating": true,
+  "description": "Adds an token to a company",
+  "whenToUse": "Create a new company API token for the company; reach for it to issue a token that does not yet exist (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": "CompanyToken"
+}

package/dist/catalog/endpoints/store_user.json

@@ -0,0 +1,24 @@
+{
+  "slug": "store_user",
+  "operationId": "storeUser",
+  "method": "POST",
+  "path": "/api/v1/users",
+  "name": "Adds a User",
+  "category": "users",
+  "mutating": true,
+  "description": "Adds an User to the system",
+  "whenToUse": "Create a new user in the system; use to add a team member account (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": "User"
+}

package/dist/catalog/endpoints/store_vendor.json

@@ -0,0 +1,131 @@
+{
+  "slug": "store_vendor",
+  "operationId": "storeVendor",
+  "method": "POST",
+  "path": "/api/v1/vendors",
+  "name": "Create vendor",
+  "category": "vendors",
+  "mutating": true,
+  "description": "Adds a vendor to a company",
+  "whenToUse": "Create a new vendor (name required) with address and contacts; use when adding a vendor, not when editing an existing one (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": "application/json",
+    "fields": [
+      {
+        "name": "name",
+        "type": "string",
+        "required": true,
+        "description": "Vendor name"
+      },
+      {
+        "name": "address1",
+        "type": "string",
+        "required": false,
+        "description": "Primary address line"
+      },
+      {
+        "name": "address2",
+        "type": "string",
+        "required": false,
+        "description": "Secondary address line"
+      },
+      {
+        "name": "city",
+        "type": "string",
+        "required": false,
+        "description": "City"
+      },
+      {
+        "name": "state",
+        "type": "string",
+        "required": false,
+        "description": "State or province"
+      },
+      {
+        "name": "postal_code",
+        "type": "string",
+        "required": false,
+        "description": "Postal code"
+      },
+      {
+        "name": "country_id",
+        "type": "string",
+        "required": false,
+        "description": "Country ID"
+      },
+      {
+        "name": "phone",
+        "type": "string",
+        "required": false,
+        "description": "Phone number"
+      },
+      {
+        "name": "email",
+        "type": "string",
+        "required": false,
+        "description": "Email address"
+      },
+      {
+        "name": "website",
+        "type": "string",
+        "required": false,
+        "description": "Website URL"
+      },
+      {
+        "name": "custom_value1",
+        "type": "string",
+        "required": false,
+        "description": "Custom field value 1"
+      },
+      {
+        "name": "custom_value2",
+        "type": "string",
+        "required": false,
+        "description": "Custom field value 2"
+      },
+      {
+        "name": "custom_value3",
+        "type": "string",
+        "required": false,
+        "description": "Custom field value 3"
+      },
+      {
+        "name": "custom_value4",
+        "type": "string",
+        "required": false,
+        "description": "Custom field value 4"
+      },
+      {
+        "name": "is_deleted",
+        "type": "boolean",
+        "required": false,
+        "description": "Whether the vendor is deleted"
+      },
+      {
+        "name": "archived_at",
+        "type": "integer",
+        "required": false,
+        "description": "Timestamp when vendor was archived"
+      },
+      {
+        "name": "contacts",
+        "type": "array",
+        "required": false,
+        "description": "Array of vendor contacts"
+      }
+    ],
+    "schemaRef": "VendorRequest"
+  },
+  "responseSchema": "Vendor"
+}