@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/store_invoice.json

@@ -0,0 +1,257 @@
+{
+  "slug": "store_invoice",
+  "operationId": "storeInvoice",
+  "method": "POST",
+  "path": "/api/v1/invoices",
+  "name": "Create invoice",
+  "category": "invoices",
+  "mutating": true,
+  "description": "## POST /api/v1/invoices\nCreates an invoice for a client.\n\nTriggered actions are available when updating or creating an invoice.\n\nThese are query parameters that can be chained in order to perform additional actions on the entity, these include:\n\n  ```\n  ?send_email=true [Saves and sends the invoice]\n  ?mark_sent=true [Saves and marks the invoice as sent]\n  ?paid=true [Saves and marks the invoice as paid]\n  ?amount_paid=100 [Saves and marks the invoice as paid with the given amount]\n  ?cancel=true [Saves and marks the invoice as cancelled]\n  ?save_default_footer=true [Saves the current footer as the default footer]\n  ?save_default_terms=true [Saves the current terms as the default terms]\n  ?retry_e_send=true [Saves and retries the e-send for the invoice]\n  ?redirect=https://example.com [Saves and redirects to the given url]\n  ```",
+  "whenToUse": "Create a new invoice for a client (client_id required), optionally chaining send/mark actions; use to make a new invoice, not update_invoice (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": "user_id",
+        "type": "string",
+        "required": false,
+        "description": "The user hashed id"
+      },
+      {
+        "name": "assigned_user_id",
+        "type": "string",
+        "required": false,
+        "description": "The assigned user hashed id"
+      },
+      {
+        "name": "client_id",
+        "type": "string",
+        "required": true,
+        "description": "The client hashed id"
+      },
+      {
+        "name": "location_id",
+        "type": "string",
+        "required": false,
+        "description": "The location id of the client this request related to"
+      },
+      {
+        "name": "number",
+        "type": "string",
+        "required": false,
+        "description": "The invoice number - is a unique alpha numeric number per invoice per company"
+      },
+      {
+        "name": "po_number",
+        "type": "string",
+        "required": false,
+        "description": "The purchase order associated with this invoice"
+      },
+      {
+        "name": "terms",
+        "type": "string",
+        "required": false,
+        "description": "The invoice terms"
+      },
+      {
+        "name": "public_notes",
+        "type": "string",
+        "required": false,
+        "description": "The public notes of the invoice"
+      },
+      {
+        "name": "private_notes",
+        "type": "string",
+        "required": false,
+        "description": "The private notes of the invoice"
+      },
+      {
+        "name": "footer",
+        "type": "string",
+        "required": false,
+        "description": "The invoice footer notes"
+      },
+      {
+        "name": "custom_value1",
+        "type": "string",
+        "required": false,
+        "description": "A custom field value"
+      },
+      {
+        "name": "custom_value2",
+        "type": "string",
+        "required": false,
+        "description": "A custom field value"
+      },
+      {
+        "name": "custom_value3",
+        "type": "string",
+        "required": false,
+        "description": "A custom field value"
+      },
+      {
+        "name": "custom_value4",
+        "type": "string",
+        "required": false,
+        "description": "A custom field value"
+      },
+      {
+        "name": "tax_name1",
+        "type": "string",
+        "required": false,
+        "description": "The tax name"
+      },
+      {
+        "name": "tax_name2",
+        "type": "string",
+        "required": false,
+        "description": "The tax name"
+      },
+      {
+        "name": "tax_rate1",
+        "type": "number",
+        "required": false,
+        "description": "The tax rate"
+      },
+      {
+        "name": "tax_rate2",
+        "type": "number",
+        "required": false,
+        "description": "The tax rate"
+      },
+      {
+        "name": "tax_name3",
+        "type": "string",
+        "required": false,
+        "description": "The tax name"
+      },
+      {
+        "name": "tax_rate3",
+        "type": "number",
+        "required": false,
+        "description": "The tax rate"
+      },
+      {
+        "name": "line_items",
+        "type": "array",
+        "required": false,
+        "description": "An array of objects which define the line items of the invoice"
+      },
+      {
+        "name": "invitations",
+        "type": "array",
+        "required": false,
+        "description": "An array of objects which define the invitations of the invoice"
+      },
+      {
+        "name": "discount",
+        "type": "number",
+        "required": false,
+        "description": "The invoice discount, can be an amount or a percentage"
+      },
+      {
+        "name": "partial",
+        "type": "number",
+        "required": false,
+        "description": "The deposit/partial amount"
+      },
+      {
+        "name": "is_amount_discount",
+        "type": "boolean",
+        "required": false,
+        "description": "Flag determining if the discount is an amount or a percentage"
+      },
+      {
+        "name": "uses_inclusive_taxes",
+        "type": "boolean",
+        "required": false,
+        "description": "Defines the type of taxes used as either inclusive or exclusive"
+      },
+      {
+        "name": "date",
+        "type": "string",
+        "required": false,
+        "description": "The Invoice Date"
+      },
+      {
+        "name": "partial_due_date",
+        "type": "string",
+        "required": false,
+        "description": "The due date for the deposit/partial amount"
+      },
+      {
+        "name": "due_date",
+        "type": "string",
+        "required": false,
+        "description": "The due date of the invoice"
+      },
+      {
+        "name": "custom_surcharge1",
+        "type": "number",
+        "required": false,
+        "description": "First Custom Surcharge"
+      },
+      {
+        "name": "custom_surcharge2",
+        "type": "number",
+        "required": false,
+        "description": "Second Custom Surcharge"
+      },
+      {
+        "name": "custom_surcharge3",
+        "type": "number",
+        "required": false,
+        "description": "Third Custom Surcharge"
+      },
+      {
+        "name": "custom_surcharge4",
+        "type": "number",
+        "required": false,
+        "description": "Fourth Custom Surcharge"
+      },
+      {
+        "name": "custom_surcharge_tax1",
+        "type": "boolean",
+        "required": false,
+        "description": "Toggles charging taxes on custom surcharge amounts"
+      },
+      {
+        "name": "custom_surcharge_tax2",
+        "type": "boolean",
+        "required": false,
+        "description": "Toggles charging taxes on custom surcharge amounts"
+      },
+      {
+        "name": "custom_surcharge_tax3",
+        "type": "boolean",
+        "required": false,
+        "description": "Toggles charging taxes on custom surcharge amounts"
+      },
+      {
+        "name": "custom_surcharge_tax4",
+        "type": "boolean",
+        "required": false,
+        "description": "Toggles charging taxes on custom surcharge amounts"
+      },
+      {
+        "name": "project_id",
+        "type": "string",
+        "required": false,
+        "description": "The project associated with this invoice"
+      }
+    ],
+    "schemaRef": "InvoiceRequest"
+  },
+  "responseSchema": "Invoice"
+}

package/dist/catalog/endpoints/store_location.json

@@ -0,0 +1,119 @@
+{
+  "slug": "store_location",
+  "operationId": "storeLocation",
+  "method": "POST",
+  "path": "/api/v1/locations",
+  "name": "Create location",
+  "category": "locations",
+  "mutating": true,
+  "description": "##  POST /api/v1/locations\n\nAdds a location to a company",
+  "whenToUse": "Create a new client or vendor address location with name, address, and country fields (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": [
+      {
+        "name": "name",
+        "type": "string",
+        "required": false,
+        "description": "The location name"
+      },
+      {
+        "name": "address1",
+        "type": "string",
+        "required": false,
+        "description": "The first line of the address"
+      },
+      {
+        "name": "address2",
+        "type": "string",
+        "required": false,
+        "description": "The second line of the address"
+      },
+      {
+        "name": "city",
+        "type": "string",
+        "required": false,
+        "description": "The city name"
+      },
+      {
+        "name": "state",
+        "type": "string",
+        "required": false,
+        "description": "The state or region"
+      },
+      {
+        "name": "postal_code",
+        "type": "string",
+        "required": false,
+        "description": "The postal or zip code"
+      },
+      {
+        "name": "country_id",
+        "type": "string",
+        "required": false,
+        "description": "The ID of the associated country"
+      },
+      {
+        "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_shipping_location",
+        "type": "boolean",
+        "required": false,
+        "description": "Indicates if this is a shipping location"
+      },
+      {
+        "name": "assigned_user_id",
+        "type": "string",
+        "required": false,
+        "description": "The assigned user hashed id"
+      },
+      {
+        "name": "client_id",
+        "type": "string",
+        "required": false,
+        "description": "The client hashed id"
+      },
+      {
+        "name": "vendor_id",
+        "type": "string",
+        "required": false,
+        "description": "The vendor hashed id"
+      }
+    ],
+    "schemaRef": "LocationRequest"
+  },
+  "responseSchema": "Location"
+}

package/dist/catalog/endpoints/store_payment.json

@@ -0,0 +1,140 @@
+{
+  "slug": "store_payment",
+  "operationId": "storePayment",
+  "method": "POST",
+  "path": "/api/v1/payments",
+  "name": "Create payment",
+  "category": "payments",
+  "mutating": true,
+  "description": "Adds an Payment to the system",
+  "whenToUse": "Create a new payment, optionally applying it to invoices/credits and emailing a receipt, when recording a fresh 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"
+    },
+    {
+      "name": "email_receipt",
+      "type": "boolean",
+      "required": false,
+      "description": "If true, the payment will be emailed to the client. If false, no email will be sent. This will override any other email settings for payments."
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "client_id",
+        "type": "string",
+        "required": false,
+        "description": "The client 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": "amount",
+        "type": "number",
+        "required": false,
+        "description": "The amount of this payment"
+      },
+      {
+        "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"
+      }
+    ],
+    "schemaRef": "PaymentRequest"
+  },
+  "responseSchema": "Payment"
+}

package/dist/catalog/endpoints/store_payment_term.json

@@ -0,0 +1,59 @@
+{
+  "slug": "store_payment_term",
+  "operationId": "storePaymentTerm",
+  "method": "POST",
+  "path": "/api/v1/payment_terms",
+  "name": "Adds a Payment",
+  "category": "payment_terms",
+  "mutating": true,
+  "description": "Adds a Payment Term to the system",
+  "whenToUse": "Create a new payment term defining a length in days and a display name (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": "num_days",
+        "type": "integer",
+        "required": false,
+        "description": "The payment term length in days"
+      },
+      {
+        "name": "name",
+        "type": "string",
+        "required": false,
+        "description": "The payment term length in string format"
+      },
+      {
+        "name": "created_at",
+        "type": "number",
+        "required": false,
+        "description": "Timestamp"
+      },
+      {
+        "name": "updated_at",
+        "type": "number",
+        "required": false,
+        "description": "Timestamp"
+      },
+      {
+        "name": "archived_at",
+        "type": "number",
+        "required": false,
+        "description": "Timestamp"
+      }
+    ],
+    "schemaRef": "PaymentTerm"
+  },
+  "responseSchema": "PaymentTerm"
+}