@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/store_client.json

@@ -0,0 +1,237 @@
+{
+  "slug": "store_client",
+  "operationId": "storeClient",
+  "method": "POST",
+  "path": "/api/v1/clients",
+  "name": "Create client",
+  "category": "clients",
+  "mutating": true,
+  "description": "##  POST /api/v1/clients\nAdds a client to a company\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": "Create a new client record (contacts array required); use to add a client that does not yet exist, not to edit one (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```"
+    }
+  ],
+  "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/store_client_gateway_token.json

@@ -0,0 +1,24 @@
+{
+  "slug": "store_client_gateway_token",
+  "operationId": "storeClientGatewayToken",
+  "method": "POST",
+  "path": "/api/v1/client_gateway_tokens",
+  "name": "Adds a client payment token",
+  "category": "client_gateway_tokens",
+  "mutating": true,
+  "description": "Adds a client payment token to a company",
+  "whenToUse": "Create a new client payment gateway token for the company; reach for it to add a saved payment method (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": "ClientGatewayToken"
+}

package/dist/catalog/endpoints/store_company.json

@@ -0,0 +1,24 @@
+{
+  "slug": "store_company",
+  "operationId": "storeCompany",
+  "method": "POST",
+  "path": "/api/v1/companies",
+  "name": "Adds a company",
+  "category": "companies",
+  "mutating": true,
+  "description": "Adds an company to the system",
+  "whenToUse": "Create a brand-new company record in the system; use when adding a company 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": "Company"
+}

package/dist/catalog/endpoints/store_company_gateway.json

@@ -0,0 +1,24 @@
+{
+  "slug": "store_company_gateway",
+  "operationId": "storeCompanyGateway",
+  "method": "POST",
+  "path": "/api/v1/company_gateways",
+  "name": "Adds a CompanyGateway",
+  "category": "company_gateways",
+  "mutating": true,
+  "description": "Adds an CompanyGateway to the system",
+  "whenToUse": "Create a new company payment gateway; reach for it when connecting a fresh payment provider to the company (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": "CompanyGateway"
+}

package/dist/catalog/endpoints/store_credit.json

@@ -0,0 +1,251 @@
+{
+  "slug": "store_credit",
+  "operationId": "storeCredit",
+  "method": "POST",
+  "path": "/api/v1/credits",
+  "name": "Create credit",
+  "category": "credits",
+  "mutating": true,
+  "description": "Adds an credit to the system",
+  "whenToUse": "Create a new credit with client and line items; reach for it when issuing a fresh credit to a client (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": "number",
+        "type": "string",
+        "required": false,
+        "description": "The credit number - is a unique alpha numeric number per credit per company"
+      },
+      {
+        "name": "po_number",
+        "type": "string",
+        "required": false,
+        "description": "The purchase order associated with this credit"
+      },
+      {
+        "name": "terms",
+        "type": "string",
+        "required": false,
+        "description": "The credit terms"
+      },
+      {
+        "name": "public_notes",
+        "type": "string",
+        "required": false,
+        "description": "The public notes of the credit"
+      },
+      {
+        "name": "private_notes",
+        "type": "string",
+        "required": false,
+        "description": "The private notes of the credit"
+      },
+      {
+        "name": "footer",
+        "type": "string",
+        "required": false,
+        "description": "The credit 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 credit"
+      },
+      {
+        "name": "invitations",
+        "type": "array",
+        "required": false,
+        "description": "An array of objects which define the invitations of the credit"
+      },
+      {
+        "name": "discount",
+        "type": "number",
+        "required": false,
+        "description": "The credit 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 credit 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 credit"
+      },
+      {
+        "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 credit"
+      }
+    ],
+    "schemaRef": "CreditRequest"
+  },
+  "responseSchema": "Credit"
+}

package/dist/catalog/endpoints/store_design.json

@@ -0,0 +1,24 @@
+{
+  "slug": "store_design",
+  "operationId": "storeDesign",
+  "method": "POST",
+  "path": "/api/v1/designs",
+  "name": "Adds a design",
+  "category": "designs",
+  "mutating": true,
+  "description": "Adds an design to a company",
+  "whenToUse": "Create a brand-new design template from scratch when adding a custom layout to the company (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": "Design"
+}

package/dist/catalog/endpoints/store_expense.json

@@ -0,0 +1,24 @@
+{
+  "slug": "store_expense",
+  "operationId": "storeExpense",
+  "method": "POST",
+  "path": "/api/v1/expenses",
+  "name": "Adds an expense",
+  "category": "expenses",
+  "mutating": true,
+  "description": "Adds a expense to a company",
+  "whenToUse": "Create a new expense record when logging a company purchase or cost (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": "Expense"
+}

package/dist/catalog/endpoints/store_expense_category.json

@@ -0,0 +1,24 @@
+{
+  "slug": "store_expense_category",
+  "operationId": "storeExpenseCategory",
+  "method": "POST",
+  "path": "/api/v1/expense_categories",
+  "name": "Adds a expense category",
+  "category": "expense_categories",
+  "mutating": true,
+  "description": "Adds an expense category to the system",
+  "whenToUse": "Create a new expense category when adding a classification bucket for expenses (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": "ExpenseCategory"
+}

package/dist/catalog/endpoints/store_group_setting.json

@@ -0,0 +1,24 @@
+{
+  "slug": "store_group_setting",
+  "operationId": "storeGroupSetting",
+  "method": "POST",
+  "path": "/api/v1/group_settings",
+  "name": "Adds a GroupSetting",
+  "category": "group_settings",
+  "mutating": true,
+  "description": "Adds an GroupSetting to the system",
+  "whenToUse": "Create a new group setting record in the system; use when adding a fresh client group, not editing 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": null,
+  "responseSchema": "GroupSetting"
+}