@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/get_group_settings.json

@@ -0,0 +1,47 @@
+{
+  "slug": "get_group_settings",
+  "operationId": "getGroupSettings",
+  "method": "GET",
+  "path": "/api/v1/group_settings",
+  "name": "Gets a list of group_settings",
+  "category": "group_settings",
+  "mutating": false,
+  "description": "Lists group_settings, search and filters allow fine grained lists to be generated.\n\n        Query parameters can be added to performed more fine grained filtering of the group_settings, these are handled by the GroupSettingFilters class which defines the methods available",
+  "whenToUse": "List or filter many group settings with paging and sorting; use to browse or search groups 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": "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[]=updated_at|asc`.\n\nOnly `group_settings` columns are honored. Unsupported keys are ignored.",
+      "example": [
+        "id|desc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "GroupSetting[]"
+}

package/dist/catalog/endpoints/get_group_settings_create.json

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

package/dist/catalog/endpoints/get_health_check.json

@@ -0,0 +1,15 @@
+{
+  "slug": "get_health_check",
+  "operationId": "getHealthCheck",
+  "method": "GET",
+  "path": "/api/v1/health_check",
+  "name": "Attempts to get a health check from the API",
+  "category": "health_check",
+  "mutating": false,
+  "description": "Attempts to get a health check from the API",
+  "whenToUse": "Ping the API health check to verify the instance is up and responding; use for liveness/diagnostics, not for any business data.",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/get_import_json.json

@@ -0,0 +1,15 @@
+{
+  "slug": "get_import_json",
+  "operationId": "getImportJson",
+  "method": "POST",
+  "path": "/api/v1/import_json",
+  "name": "Import data from the system",
+  "category": "imports",
+  "mutating": true,
+  "description": "Import data from the system",
+  "whenToUse": "Call to bulk-import a previously exported Invoice Ninja JSON dataset into the company, restoring or migrating records (mutating).",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/get_invoice_create.json

@@ -0,0 +1,16 @@
+{
+  "slug": "get_invoice_create",
+  "operationId": "getInvoiceCreate",
+  "method": "GET",
+  "path": "/api/v1/invoices/create",
+  "name": "Blank invoice",
+  "category": "invoices",
+  "mutating": false,
+  "description": "## GET /api/v1/invoices/create\n\nReturns a blank object with default values",
+  "whenToUse": "GET a blank invoice object with default values to seed a new-invoice form; read-only, use before store_invoice.",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Invoice"
+}

package/dist/catalog/endpoints/get_invoice_delivery_note.json

@@ -0,0 +1,32 @@
+{
+  "slug": "get_invoice_delivery_note",
+  "operationId": "getInvoiceDeliveryNote",
+  "method": "GET",
+  "path": "/api/v1/invoices/{id}/delivery_note",
+  "name": "Download delivery note",
+  "category": "invoices",
+  "mutating": false,
+  "description": "## GET /api/v1/invoices/{id}/delivery_note\n\nDownloads a specific invoice delivery notes",
+  "whenToUse": "Download one invoice's delivery-note PDF by id; use for the delivery note specifically, not download_invoice_by_invitation for the invoice PDF.",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Invoice Hahsed 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
+}

package/dist/catalog/endpoints/get_invoice_item_report.json

@@ -0,0 +1,64 @@
+{
+  "slug": "get_invoice_item_report",
+  "operationId": "getInvoiceItemReport",
+  "method": "POST",
+  "path": "/api/v1/reports/invoice_items",
+  "name": "Invoice item reports",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export invoice item reports",
+  "whenToUse": "Export a paginated report of individual invoice line items over a date range; use for per-line-item detail, not whole-invoice totals",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "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": {
+    "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_invoice_report.json

@@ -0,0 +1,64 @@
+{
+  "slug": "get_invoice_report",
+  "operationId": "getInvoiceReport",
+  "method": "POST",
+  "path": "/api/v1/reports/invoices",
+  "name": "Invoice reports",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export invoice reports",
+  "whenToUse": "Export a paginated report of invoice records and totals over a date range; use for invoice-level summaries, not their individual line items",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "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": {
+    "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_invoices.json

@@ -0,0 +1,174 @@
+{
+  "slug": "get_invoices",
+  "operationId": "getInvoices",
+  "method": "GET",
+  "path": "/api/v1/invoices",
+  "name": "List invoices",
+  "category": "invoices",
+  "mutating": false,
+  "description": "##  GET /api/v1/invoices\n\nLists invoices with the option to chain multiple query parameters allowing fine grained filtering of the list.",
+  "whenToUse": "Fetch and filter many invoices by client, status, number, date, or overdue with pagination; use to search or list, not to read 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": "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=balance|desc`.\n\n*Multiple sorts** — use `sort[]` for each level in priority order, for example\n`sort[]=id|desc&sort[]=number|asc`.\n\nInvoices accept columns on the `invoices` table, relationship-style keys such as `client.name`, `client_id`, `documents`, `project_id`, and prefixed `client.*` / `contact.*` sorts where the filter supports them. `number` and `status_id` have special handling. Unsupported keys are ignored.",
+      "example": [
+        "number|asc",
+        "balance|desc"
+      ]
+    },
+    {
+      "name": "status",
+      "type": "string",
+      "required": false,
+      "description": "Filter the entity based on their status. ie active / archived / deleted. Format is a comma separated string with any of the following options:\n- active\n- archived\n- deleted\n\n```html\nGET /api/v1/invoices?status=archived,deleted\nReturns only archived and deleted invoices\n```",
+      "example": "?status=archived,deleted"
+    },
+    {
+      "name": "client_id",
+      "type": "string",
+      "required": false,
+      "description": "Filters the entity list by client_id. Suitable when you only want the entities of a specific client.\n\n```html\nGET /api/v1/invoices?client_id=AxB7Hjk9\nReturns only invoices for the specified client\n```",
+      "example": "?client_id={client_id}"
+    },
+    {
+      "name": "created_at",
+      "type": "integer",
+      "required": false,
+      "description": "Filters the entity list by the created at timestamp. Parameter value can be a datetime string or unix timestamp\n\n```html\nGET /api/v1/invoices?created_at=2022-01-10\nReturns entities created on January 10th, 2022\n```",
+      "example": 1641772800
+    },
+    {
+      "name": "updated_at",
+      "type": "integer",
+      "required": false,
+      "description": "Filters the entity list by the updated at timestamp. Parameter value can be a datetime string or unix timestamp\n\n```html\nGET /api/v1/invoices?updated_at=2022-01-10\nReturns entities last updated on January 10th, 2022\n```",
+      "example": 1641772800
+    },
+    {
+      "name": "is_deleted",
+      "type": "boolean",
+      "required": false,
+      "description": "Filters the entity list by entities that have been deleted.\n\n```html\nGET /api/v1/invoices?is_deleted=true\nReturns only soft-deleted entities\n```",
+      "example": true
+    },
+    {
+      "name": "filter_deleted_clients",
+      "type": "string",
+      "required": false,
+      "description": "Filters the entity list and only returns entities for clients that have not been deleted\n\n```html\nGET /api/v1/invoices?filter_deleted_clients=true\nReturns only invoices for active (non-deleted) clients\n```",
+      "example": "?filter_deleted_clients=true"
+    },
+    {
+      "name": "vendor_id",
+      "type": "string",
+      "required": false,
+      "description": "Filters the entity list by an associated vendor\n\n```html\nGET /api/v1/purchases?vendor_id=AxB7Hjk9\nReturns only purchases for the specified vendor\n```",
+      "example": "?vendor_id={vendor_id}"
+    },
+    {
+      "name": "client_status",
+      "type": "string",
+      "required": false,
+      "description": "A comma separated list of invoice status strings. Valid options include:\n- all\n- paid\n- unpaid\n- overdue",
+      "example": "?client_status=paid,unpaid"
+    },
+    {
+      "name": "number",
+      "type": "string",
+      "required": false,
+      "description": "Search invoices by invoice number",
+      "example": "?number=INV-001"
+    },
+    {
+      "name": "filter",
+      "type": "string",
+      "required": false,
+      "description": "Searches across a range of columns including:\n- number\n- po_number\n- date\n- amount\n- balance\n- custom_value1\n- custom_value2\n- custom_value3\n- custom_value4\n- client.name\n- client.contacts.[first_name, last_name, email]\n- line_items.[product_key, notes]",
+      "example": "?filter=bob"
+    },
+    {
+      "name": "without_deleted_clients",
+      "type": "string",
+      "required": false,
+      "description": "Returns the invoice list without the invoices of deleted clients.",
+      "example": "?without_deleted_clients="
+    },
+    {
+      "name": "overdue",
+      "type": "string",
+      "required": false,
+      "description": "Returns the list of invoices that are overdue",
+      "example": "?overdue="
+    },
+    {
+      "name": "payable",
+      "type": "string",
+      "required": false,
+      "description": "Returns the invoice list that are payable for a defined client. Please note, you must pass the client_id as the value for this query parameter",
+      "example": "?payable={client_id}"
+    },
+    {
+      "name": "private_notes",
+      "type": "string",
+      "required": false,
+      "description": "Searches on the private_notes field of the invoices",
+      "example": "?private_notes=super secret"
+    },
+    {
+      "name": "date",
+      "type": "string",
+      "required": false,
+      "description": "Filters the invoices by invoice date returns a list of invoices after (and including) the date",
+      "example": "?date=2022-01-01"
+    },
+    {
+      "name": "date_range",
+      "type": "string",
+      "required": false,
+      "description": "Filters the invoices by invoice date returns a list of invoices between two dates",
+      "example": "?date_range=2022-01-01,2022-01-31"
+    },
+    {
+      "name": "status_id",
+      "type": "integer",
+      "required": false,
+      "description": "Filters the invoices by status id\n\n```html\n  STATUS_DRAFT = 1;\n  STATUS_SENT = 2;\n  STATUS_PARTIAL = 3;\n  STATUS_PAID = 4;\n  STATUS_CANCELLED = 5;\n  STATUS_REVERSED = 6;\n```",
+      "example": 1
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Invoice[]"
+}

package/dist/catalog/endpoints/get_last_error.json

@@ -0,0 +1,15 @@
+{
+  "slug": "get_last_error",
+  "operationId": "getLastError",
+  "method": "GET",
+  "path": "/api/v1/last_error",
+  "name": "Returns the last error",
+  "category": "ping",
+  "mutating": false,
+  "description": "Returns the last error from the API",
+  "whenToUse": "Fetch the API's most recent error message when diagnosing a prior failed request, rather than checking liveness.",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/get_locations.json

@@ -0,0 +1,54 @@
+{
+  "slug": "get_locations",
+  "operationId": "getLocations",
+  "method": "GET",
+  "path": "/api/v1/locations",
+  "name": "List locations",
+  "category": "locations",
+  "mutating": false,
+  "description": "##  GET /api/v1/locations\n\nLocations are additional addresses that are applicable to a client. This is useful when a client has multiple addresses for shipping, billing, etc.\n\nWhen retrieving a list of locations you can chain query parameters to filter the dataset. For example:\n\n```html\n/api/v1/locations?name=warehouse*\n```\n\nSorting uses `column|asc` or `column|desc`. Use a single `sort` parameter for one column, or repeated `sort[]` parameters for multi-level ordering (first is primary):\n\n```html\n/api/v1/locations?sort=id|desc\n/api/v1/locations?sort[]=id|desc&sort[]=name|asc\n```\n\nFor pagination, use per_page and page parameters:\n\n```html\n/api/v1/locations?per_page=15&page=2\n```\n\nThe default per_page value is 20.",
+  "whenToUse": "List or filter many client/vendor address locations by name with sorting and pagination; use to find locations or browse the set.",
+  "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": "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=name|desc`.\n\n*Multiple sorts** — for example\n`sort[]=name|asc&sort[]=id|desc`.\n\nLocation ordering is limited by the filter: `name` is the primary supported case; other column names must exist on the locations schema to take effect.",
+      "example": [
+        "name|desc"
+      ]
+    },
+    {
+      "name": "name",
+      "type": "string",
+      "required": false,
+      "description": "Filter by location name\n\n```html\n?name=warehouse\n```",
+      "example": "warehouse"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Location[]"
+}

package/dist/catalog/endpoints/get_locations_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_locations_create",
+  "operationId": "getLocationsCreate",
+  "method": "GET",
+  "path": "/api/v1/locations/create",
+  "name": "Blank Location",
+  "category": "locations",
+  "mutating": false,
+  "description": "##  GET /api/v1/locations/create\n\nReturns a blank object with default values",
+  "whenToUse": "Fetch a blank location object with default values to prefill a new-location form before calling store_location.",
+  "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": null,
+  "responseSchema": "Location"
+}

package/dist/catalog/endpoints/get_logout.json

@@ -0,0 +1,30 @@
+{
+  "slug": "get_logout",
+  "operationId": "getLogout",
+  "method": "POST",
+  "path": "/api/v1/logout",
+  "name": "Logs the user out of their current session",
+  "category": "logout",
+  "mutating": true,
+  "description": "Logs the user out of their current session",
+  "whenToUse": "Call to log out the current user and invalidate their active session token when ending an authenticated session (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": "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": null
+}

package/dist/catalog/endpoints/get_payment_report.json

@@ -0,0 +1,64 @@
+{
+  "slug": "get_payment_report",
+  "operationId": "getPaymentReport",
+  "method": "POST",
+  "path": "/api/v1/reports/payments",
+  "name": "Payment reports",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export payment reports",
+  "whenToUse": "Export a paginated report of payment records received over a date range; use for cash collected, not invoices billed or balances owed",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "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": {
+    "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"
+  }
+}