@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/get_activities.json

@@ -0,0 +1,44 @@
+{
+  "slug": "get_activities",
+  "operationId": "getActivities",
+  "method": "GET",
+  "path": "/api/v1/activities",
+  "name": "Returns a list of activities",
+  "category": "activities",
+  "mutating": false,
+  "description": "Lists all activities related to this company",
+  "whenToUse": "List and paginate the company's activity/audit log records when you need many activity entries, not a single one's PDF.",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "include",
+      "type": "string",
+      "required": false,
+      "description": "Include child relations of the Activity object, format is comma separated. **Note** it is possible to chain multiple includes together, ie. include=account,token"
+    },
+    {
+      "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": "per_page",
+      "type": "integer",
+      "required": false,
+      "description": "The number of records to return for each request, default is 20",
+      "example": 20
+    },
+    {
+      "name": "page",
+      "type": "integer",
+      "required": false,
+      "description": "The page number to return for this request (when performing pagination), default is 1",
+      "example": 1
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Activity[]"
+}

package/dist/catalog/endpoints/get_activity_historical_entity_pdf.json

@@ -0,0 +1,31 @@
+{
+  "slug": "get_activity_historical_entity_pdf",
+  "operationId": "getActivityHistoricalEntityPdf",
+  "method": "GET",
+  "path": "/api/v1/activities/download_entity/{activity_id}",
+  "name": "Returns a PDF for the given activity",
+  "category": "activities",
+  "mutating": false,
+  "description": "Returns a PDF for the given activity",
+  "whenToUse": "Download the historical PDF snapshot of the entity tied to one activity, identified by activity_id, when you need that point-in-time document.",
+  "pathParameters": [
+    {
+      "name": "activity_id",
+      "type": "string",
+      "required": true,
+      "description": "The Activity Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "queryParameters": [
+    {
+      "name": "include",
+      "type": "string",
+      "required": false,
+      "description": "Include child relations of the Activity object, format is comma separated. **Note** it is possible to chain multiple includes together, ie. include=account,token"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/get_activity_report.json

@@ -0,0 +1,49 @@
+{
+  "slug": "get_activity_report",
+  "operationId": "getActivityReport",
+  "method": "POST",
+  "path": "/api/v1/reports/activities",
+  "name": "Activity reports",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export activity reports",
+  "whenToUse": "Export an audit-style activity log report of user/entity actions over a date range; use for tracking who did what, not financials",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "date_range",
+        "type": "string",
+        "required": false,
+        "description": "The string representation of the date range of data to be returned"
+      },
+      {
+        "name": "date_key",
+        "type": "string",
+        "required": false,
+        "description": "The date column to search between."
+      },
+      {
+        "name": "start_date",
+        "type": "string",
+        "required": false,
+        "description": "The start date to search between"
+      },
+      {
+        "name": "end_date",
+        "type": "string",
+        "required": false,
+        "description": "The end date to search between"
+      },
+      {
+        "name": "report_keys",
+        "type": "array",
+        "required": false
+      }
+    ],
+    "schemaRef": "GenericReportSchema"
+  }
+}

package/dist/catalog/endpoints/get_ardetail_report.json

@@ -0,0 +1,49 @@
+{
+  "slug": "get_ardetail_report",
+  "operationId": "getARDetailReport",
+  "method": "POST",
+  "path": "/api/v1/reports/ar_detail_report",
+  "name": "AR detail report",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export AR detail report",
+  "whenToUse": "Export a line-by-line accounts-receivable detail report of outstanding invoices per client over a date range; use for granular AR aging",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "date_range",
+        "type": "string",
+        "required": false,
+        "description": "The string representation of the date range of data to be returned"
+      },
+      {
+        "name": "date_key",
+        "type": "string",
+        "required": false,
+        "description": "The date column to search between."
+      },
+      {
+        "name": "start_date",
+        "type": "string",
+        "required": false,
+        "description": "The start date to search between"
+      },
+      {
+        "name": "end_date",
+        "type": "string",
+        "required": false,
+        "description": "The end date to search between"
+      },
+      {
+        "name": "report_keys",
+        "type": "array",
+        "required": false
+      }
+    ],
+    "schemaRef": "GenericReportSchema"
+  }
+}

package/dist/catalog/endpoints/get_arsummary_report.json

@@ -0,0 +1,49 @@
+{
+  "slug": "get_arsummary_report",
+  "operationId": "getARSummaryReport",
+  "method": "POST",
+  "path": "/api/v1/reports/ar_summary_report",
+  "name": "AR summary report",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export AR summary report",
+  "whenToUse": "Export a summarized accounts-receivable report of total balances owed per client over a date range; use for high-level AR totals, not line detail",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "date_range",
+        "type": "string",
+        "required": false,
+        "description": "The string representation of the date range of data to be returned"
+      },
+      {
+        "name": "date_key",
+        "type": "string",
+        "required": false,
+        "description": "The date column to search between."
+      },
+      {
+        "name": "start_date",
+        "type": "string",
+        "required": false,
+        "description": "The start date to search between"
+      },
+      {
+        "name": "end_date",
+        "type": "string",
+        "required": false,
+        "description": "The end date to search between"
+      },
+      {
+        "name": "report_keys",
+        "type": "array",
+        "required": false
+      }
+    ],
+    "schemaRef": "GenericReportSchema"
+  }
+}

package/dist/catalog/endpoints/get_bank_integrations.json

@@ -0,0 +1,61 @@
+{
+  "slug": "get_bank_integrations",
+  "operationId": "getBankIntegrations",
+  "method": "GET",
+  "path": "/api/v1/bank_integrations",
+  "name": "Returns a list of Bank Integrations",
+  "category": "bank_integrations",
+  "mutating": false,
+  "description": "Lists all bank integrations",
+  "whenToUse": "List or paginate all bank integrations; use to browse or find connected bank integrations, not to fetch one by id.",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "include",
+      "type": "string",
+      "required": false,
+      "description": "Include child relations of the BankIntegration object. Format is comma separated."
+    },
+    {
+      "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": "rows",
+      "type": "number",
+      "required": false,
+      "description": "The number of bank integrations to return",
+      "format": "integer",
+      "example": 50
+    },
+    {
+      "name": "per_page",
+      "type": "integer",
+      "required": false,
+      "description": "The number of records to return for each request, default is 20",
+      "example": 20
+    },
+    {
+      "name": "page",
+      "type": "integer",
+      "required": false,
+      "description": "The page number to return for this request (when performing pagination), default is 1",
+      "example": 1
+    },
+    {
+      "name": "sort",
+      "type": "array",
+      "required": false,
+      "description": "Order the list by choosing a column and direction. Each value uses the form `column|asc` or `column|desc`.\n\n*Single sort** — for example `sort=id|desc`.\n\n*Multiple sorts** — for example\n`sort[]=id|desc&sort[]=created_at|asc`.\n\nOnly columns on `bank_integrations` are recognized. Unsupported keys are ignored.",
+      "example": [
+        "id|desc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "BankIntegration[]"
+}

package/dist/catalog/endpoints/get_bank_integrations_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_bank_integrations_create",
+  "operationId": "getBankIntegrationsCreate",
+  "method": "GET",
+  "path": "/api/v1/bank_integrations/create",
+  "name": "Gets a new blank bank_integration object",
+  "category": "bank_integrations",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank bank integration object with default values (read-only); use to seed a new form before calling store_bank_integration.",
+  "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": "BankIntegration"
+}

package/dist/catalog/endpoints/get_bank_transaction_rules.json

@@ -0,0 +1,62 @@
+{
+  "slug": "get_bank_transaction_rules",
+  "operationId": "getBankTransactionRules",
+  "method": "GET",
+  "path": "/api/v1/bank_transaction_rules",
+  "name": "Gets a list of bank_transaction_rules",
+  "category": "bank_transaction_rules",
+  "mutating": false,
+  "description": "Lists all bank transaction rules",
+  "whenToUse": "List or filter many bank transaction rules with pagination and sorting; reach for it to browse all rules, not one by id.",
+  "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": "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": "rows",
+      "type": "number",
+      "required": false,
+      "description": "The number of bank integrations to return",
+      "format": "integer",
+      "example": 50
+    },
+    {
+      "name": "per_page",
+      "type": "integer",
+      "required": false,
+      "description": "The number of records to return for each request, default is 20",
+      "example": 20
+    },
+    {
+      "name": "page",
+      "type": "integer",
+      "required": false,
+      "description": "The page number to return for this request (when performing pagination), default is 1",
+      "example": 1
+    },
+    {
+      "name": "sort",
+      "type": "array",
+      "required": false,
+      "description": "Order the list by choosing a column and direction. Each value uses the form `column|asc` or `column|desc`.\n\n*Single sort** — for example `sort=id|desc`.\n\n*Multiple sorts** — for example\n`sort[]=id|desc&sort[]=name|asc`.\n\nOnly columns defined for the bank transaction rules model are honored. Unsupported keys are ignored.",
+      "example": [
+        "id|desc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "BankTransactionRule[]"
+}

package/dist/catalog/endpoints/get_bank_transaction_rules_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_bank_transaction_rules_create",
+  "operationId": "getBankTransactionRulesCreate",
+  "method": "GET",
+  "path": "/api/v1/bank_transaction_rules/create",
+  "name": "Gets a new blank bank_transaction rule object",
+  "category": "bank_transaction_rules",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank bank transaction rule template with default values (read-only); reach for it to seed a new-rule form before storing.",
+  "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": "BankTransactionRule"
+}

package/dist/catalog/endpoints/get_bank_transactions.json

@@ -0,0 +1,63 @@
+{
+  "slug": "get_bank_transactions",
+  "operationId": "getBankTransactions",
+  "method": "GET",
+  "path": "/api/v1/bank_transactions",
+  "name": "Gets a list of bank_transactions",
+  "category": "bank_transactions",
+  "mutating": false,
+  "description": "Lists all bank integrations",
+  "whenToUse": "List or filter many bank transactions with paging and sorting; use to browse, search, or find transactions when you lack a specific id.",
+  "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": "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": "rows",
+      "type": "number",
+      "required": false,
+      "description": "The number of bank integrations to return",
+      "format": "integer",
+      "example": 50
+    },
+    {
+      "name": "per_page",
+      "type": "integer",
+      "required": false,
+      "description": "The number of records to return for each request, default is 20",
+      "example": 20
+    },
+    {
+      "name": "page",
+      "type": "integer",
+      "required": false,
+      "description": "The page number to return for this request (when performing pagination), default is 1",
+      "example": 1
+    },
+    {
+      "name": "sort",
+      "type": "array",
+      "required": false,
+      "description": "Order the list by choosing a column and direction. Each value uses the form `column|asc` or `column|desc`.\n\n*Single sort** — for example `sort=date|desc`.\n\n*Multiple sorts** — for example\n`sort[]=amount|asc&sort[]=date|desc`.\n\nBank transactions accept columns and relationship sorts exposed by `BankTransactionFilters`. Unsupported keys are ignored.",
+      "example": [
+        "date|desc",
+        "amount|asc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "BankTransaction[]"
+}

package/dist/catalog/endpoints/get_bank_transactions_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_bank_transactions_create",
+  "operationId": "getBankTransactionsCreate",
+  "method": "GET",
+  "path": "/api/v1/bank_transactions/create",
+  "name": "Gets a new blank bank_transaction object",
+  "category": "bank_transactions",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank bank transaction template with default values; read-only, use to prefill before storing a new transaction.",
+  "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": "BankTransaction"
+}

package/dist/catalog/endpoints/get_chart_calculated_fields.json

@@ -0,0 +1,18 @@
+{
+  "slug": "get_chart_calculated_fields",
+  "operationId": "getChartCalculatedFields",
+  "method": "POST",
+  "path": "/api/v1/charts/calculated_fields",
+  "name": "Get calculated fields",
+  "category": "charts",
+  "mutating": false,
+  "description": "Get chart calculated fields",
+  "whenToUse": "Retrieve dashboard chart calculated fields via POST when you need derived/computed chart metrics rather than raw totals or summaries",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": []
+  }
+}

package/dist/catalog/endpoints/get_chart_summary_v2.json

@@ -0,0 +1,18 @@
+{
+  "slug": "get_chart_summary_v2",
+  "operationId": "getChartSummaryV2",
+  "method": "POST",
+  "path": "/api/v1/charts/chart_summary_v2",
+  "name": "Get chart summary v2",
+  "category": "charts",
+  "mutating": false,
+  "description": "Get chart summary (v2)",
+  "whenToUse": "Retrieve the v2 dashboard summary aggregates via POST when you want high-level summary figures rather than detailed totals rows",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": []
+  }
+}

package/dist/catalog/endpoints/get_chart_totals.json

@@ -0,0 +1,38 @@
+{
+  "slug": "get_chart_totals",
+  "operationId": "getChartTotals",
+  "method": "POST",
+  "path": "/api/v1/charts/totals",
+  "name": "Get chart data",
+  "category": "charts",
+  "mutating": false,
+  "description": "Get chart data",
+  "whenToUse": "Retrieve the v1 dashboard chart totals via POST for legacy total figures; prefer totals_v2 for newer reporting",
+  "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": "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": "rows",
+      "type": "number",
+      "required": false,
+      "description": "The chart",
+      "format": "integer",
+      "example": 50
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/get_chart_totals_v2.json

@@ -0,0 +1,18 @@
+{
+  "slug": "get_chart_totals_v2",
+  "operationId": "getChartTotalsV2",
+  "method": "POST",
+  "path": "/api/v1/charts/totals_v2",
+  "name": "Get chart data v2",
+  "category": "charts",
+  "mutating": false,
+  "description": "Get chart data (v2)",
+  "whenToUse": "Retrieve the v2 dashboard chart totals via POST for current total figures; use over the v1 totals endpoint",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": []
+  }
+}

package/dist/catalog/endpoints/get_claim_license.json

@@ -0,0 +1,32 @@
+{
+  "slug": "get_claim_license",
+  "operationId": "getClaimLicense",
+  "method": "GET",
+  "path": "/api/v1/claim_license",
+  "name": "Attempts to claim a white label license",
+  "category": "claim_license",
+  "mutating": false,
+  "description": "Attempts to claim a white label license",
+  "whenToUse": "Claim a white-label license by passing a license_key and product_id; use to activate white labeling, not for general data retrieval.",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "license_key",
+      "type": "string",
+      "required": true,
+      "description": "The license hash",
+      "format": "string",
+      "example": "d87sh-s755s-s7d76-sdsd8"
+    },
+    {
+      "name": "product_id",
+      "type": "string",
+      "required": true,
+      "description": "The ID of the product purchased.",
+      "format": "string",
+      "example": "1"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null
+}