@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/get_payment_terms.json

@@ -0,0 +1,54 @@
+{
+  "slug": "get_payment_terms",
+  "operationId": "getPaymentTerms",
+  "method": "GET",
+  "path": "/api/v1/payment_terms",
+  "name": "Gets a list of payment terms",
+  "category": "payment_terms",
+  "mutating": false,
+  "description": "Lists payment terms",
+  "whenToUse": "List or filter many payment terms with sorting and pagination; use to browse or find available net-day terms.",
+  "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=number_of_days|asc`.\n\n*Multiple sorts** — for example\n`sort[]=name|asc&sort[]=number_of_days|asc`.\n\nSorting follows the payment term table schema. Unsupported keys are ignored.",
+      "example": [
+        "number_of_days|asc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "PaymentTerm[]"
+}

package/dist/catalog/endpoints/get_payment_terms_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_payment_terms_create",
+  "operationId": "getPaymentTermsCreate",
+  "method": "GET",
+  "path": "/api/v1/payment_terms/create",
+  "name": "Gets a new blank PaymentTerm object",
+  "category": "payment_terms",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank payment-term object with default values to prefill a new term before calling store_payment_term.",
+  "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": "Payment"
+}

package/dist/catalog/endpoints/get_payments.json

@@ -0,0 +1,118 @@
+{
+  "slug": "get_payments",
+  "operationId": "getPayments",
+  "method": "GET",
+  "path": "/api/v1/payments",
+  "name": "List payments",
+  "category": "payments",
+  "mutating": false,
+  "description": "Lists payments, 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 payments, these are handled by the PaymentFilters class which defines the methods available",
+  "whenToUse": "List and filter many payments by client, status, number, or date range when you need a set of records, 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": "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[]=id|desc&sort[]=amount|asc`.\n\nPayments accept `payments` columns plus client, contact, and document-related sorts defined in the payment filters. Unsupported keys are ignored.",
+      "example": [
+        "date|desc",
+        "amount|asc"
+      ]
+    },
+    {
+      "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": "filter",
+      "type": "string",
+      "required": false,
+      "description": "Searches across a range of columns including:\n- amount\n- date\n- custom_value1\n- custom_value2\n- custom_value3\n- custom_value4",
+      "example": "?filter=10"
+    },
+    {
+      "name": "number",
+      "type": "string",
+      "required": false,
+      "description": "Search payments by payment number",
+      "example": "?number=0001"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Payment[]"
+}

package/dist/catalog/endpoints/get_payments_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_payments_create",
+  "operationId": "getPaymentsCreate",
+  "method": "GET",
+  "path": "/api/v1/payments/create",
+  "name": "Blank payment",
+  "category": "payments",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank payment object with default values to seed a new-payment form; read-only, does not create anything.",
+  "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": "Payment"
+}

package/dist/catalog/endpoints/get_ping.json

@@ -0,0 +1,15 @@
+{
+  "slug": "get_ping",
+  "operationId": "getPing",
+  "method": "GET",
+  "path": "/api/v1/ping",
+  "name": "Attempts to ping the API",
+  "category": "ping",
+  "mutating": false,
+  "description": "Attempts to ping the API",
+  "whenToUse": "Ping the API to verify connectivity and credentials with a lightweight health check, not to read error details.",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/get_preview.json

@@ -0,0 +1,15 @@
+{
+  "slug": "get_preview",
+  "operationId": "getPreview",
+  "method": "POST",
+  "path": "/api/v1/preview",
+  "name": "Returns a pdf preview",
+  "category": "preview",
+  "mutating": false,
+  "description": "Returns a pdf preview.",
+  "whenToUse": "Generate an on-the-fly PDF preview of an invoice/quote/credit from posted entity data without saving it; use for general entities, not purchase orders",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/get_preview_purchase_order.json

@@ -0,0 +1,15 @@
+{
+  "slug": "get_preview_purchase_order",
+  "operationId": "getPreviewPurchaseOrder",
+  "method": "POST",
+  "path": "/api/v1/preview/purchase_order",
+  "name": "Returns a pdf preview for purchase order",
+  "category": "preview",
+  "mutating": false,
+  "description": "Returns a pdf preview for purchase order.",
+  "whenToUse": "Generate an on-the-fly PDF preview specifically for a purchase order from posted data; use this instead of get_preview when the entity is a purchase order",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/get_product_report.json

@@ -0,0 +1,64 @@
+{
+  "slug": "get_product_report",
+  "operationId": "getProductReport",
+  "method": "POST",
+  "path": "/api/v1/reports/products",
+  "name": "Product reports",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export product reports",
+  "whenToUse": "Export a paginated report of product catalog records and attributes over a date range; use for the product list, not their sales performance",
+  "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_product_sales_report.json

@@ -0,0 +1,64 @@
+{
+  "slug": "get_product_sales_report",
+  "operationId": "getProductSalesReport",
+  "method": "POST",
+  "path": "/api/v1/reports/product_sales",
+  "name": "Product Salesreports",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export product sales reports",
+  "whenToUse": "Export a paginated report of sales volume and revenue per product over a date range; use to see which products sold, not the product catalog",
+  "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_products.json

@@ -0,0 +1,118 @@
+{
+  "slug": "get_products",
+  "operationId": "getProducts",
+  "method": "GET",
+  "path": "/api/v1/products",
+  "name": "List products",
+  "category": "products",
+  "mutating": false,
+  "description": "##  GET /api/v1/products\nLists products within your company.\n\nYou can search and filter the result set using query parameters. These can be chained together allowing fine grained lists to be generated.",
+  "whenToUse": "List and filter many products in your company, with search, sorting, and pagination; reach for it to browse or find products by criteria.",
+  "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=product_key|asc`.\n\n*Multiple sorts** — for example\n`sort[]=id|desc&sort[]=product_key|asc`.\n\nOnly real columns on the `products` table are recognized (for example `id`, `product_key`, `cost`, `price`). Relationship sorts are not available here. Unsupported keys are ignored.",
+      "example": [
+        "product_key|asc",
+        "id|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": "filter",
+      "type": "string",
+      "required": false,
+      "description": "Filter by product name",
+      "example": "bob"
+    },
+    {
+      "name": "product_key",
+      "type": "string",
+      "required": false,
+      "description": "Filter by product key",
+      "example": "bob"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Product[]"
+}

package/dist/catalog/endpoints/get_products_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_products_create",
+  "operationId": "getProductsCreate",
+  "method": "GET",
+  "path": "/api/v1/products/create",
+  "name": "Blank product",
+  "category": "products",
+  "mutating": false,
+  "description": "##  GET /api/v1/products/create\nReturns a blank product object with default values",
+  "whenToUse": "Fetch a blank product template with default values (read-only); use to prefill a new-product form before calling store_product.",
+  "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": "Product"
+}

package/dist/catalog/endpoints/get_profit_loss_report.json

@@ -0,0 +1,64 @@
+{
+  "slug": "get_profit_loss_report",
+  "operationId": "getProfitLossReport",
+  "method": "POST",
+  "path": "/api/v1/reports/profitloss",
+  "name": "Profit loss reports",
+  "category": "reports",
+  "mutating": false,
+  "description": "Profit loss report",
+  "whenToUse": "Export a paginated profit-and-loss report netting revenue against expenses over a date range; use for overall P&L, not single-entity reports",
+  "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_project_report.json

@@ -0,0 +1,49 @@
+{
+  "slug": "get_project_report",
+  "operationId": "getProjectReport",
+  "method": "POST",
+  "path": "/api/v1/reports/projects",
+  "name": "Project reports",
+  "category": "reports",
+  "mutating": false,
+  "description": "Export project reports",
+  "whenToUse": "Export a report of project records over a date range; use for projects and their attributes, not the tasks logged within them",
+  "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"
+  }
+}