@nightsquawktech/invoiceninja-mcp-server 0.0.1

package/dist/catalog/endpoints/get_users_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_users_create",
+  "operationId": "getUsersCreate",
+  "method": "GET",
+  "path": "/api/v1/users/create",
+  "name": "Gets a new blank User object",
+  "category": "users",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank user with default values; use to pre-populate a new-user form before calling store.",
+  "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": "User"
+}

package/dist/catalog/endpoints/get_vendors.json

@@ -0,0 +1,55 @@
+{
+  "slug": "get_vendors",
+  "operationId": "getVendors",
+  "method": "GET",
+  "path": "/api/v1/vendors",
+  "name": "List vendors",
+  "category": "vendors",
+  "mutating": false,
+  "description": "Lists vendors, 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 vendors, these are handled by the VendorFilters class which defines the methods available",
+  "whenToUse": "List or filter many vendors with search, sort, and pagination; use when browsing or finding vendors rather than fetching 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=name|asc`.\n\n*Multiple sorts** — for example\n`sort[]=id|desc&sort[]=name|asc`.\n\nVendors use vendor table columns and any relationship sorts implemented in `VendorFilters` (such as `client.name` or document counts where applicable). Unsupported keys are ignored.",
+      "example": [
+        "name|asc",
+        "id|desc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Vendor[]"
+}

package/dist/catalog/endpoints/get_vendors_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_vendors_create",
+  "operationId": "getVendorsCreate",
+  "method": "GET",
+  "path": "/api/v1/vendors/create",
+  "name": "Blank vendor",
+  "category": "vendors",
+  "mutating": false,
+  "description": "Returns a blank vendor with default values",
+  "whenToUse": "Fetch a blank vendor with default values; use to prefill a new-record form before calling store_vendor.",
+  "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": "Vendor"
+}

package/dist/catalog/endpoints/get_webcron.json

@@ -0,0 +1,15 @@
+{
+  "slug": "get_webcron",
+  "operationId": "getWebcron",
+  "method": "GET",
+  "path": "/api/v1/webcron",
+  "name": "Executes the task scheduler via a webcron service",
+  "category": "webcron",
+  "mutating": false,
+  "description": "Executes the task scheduler via a webcron service",
+  "whenToUse": "Call to trigger execution of the task scheduler as a webcron tick, running due scheduled jobs now rather than just reading status.",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/get_webhooks.json

@@ -0,0 +1,54 @@
+{
+  "slug": "get_webhooks",
+  "operationId": "getWebhooks",
+  "method": "GET",
+  "path": "/api/v1/webhooks",
+  "name": "Gets a list of Webhooks",
+  "category": "webhooks",
+  "mutating": false,
+  "description": "Lists Webhooks, 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 Webhooks, these are handled by the WebhookFilters class which defines the methods available",
+  "whenToUse": "List or filter many webhooks with pagination, sorting, and includes when browsing or searching configured webhook subscriptions.",
+  "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=created_at|desc`.\n\n*Multiple sorts** — for example\n`sort[]=id|desc&sort[]=created_at|asc`.\n\nOnly `webhooks` table columns apply. Unsupported keys are ignored.",
+      "example": [
+        "created_at|desc"
+      ]
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "Webhook[]"
+}

package/dist/catalog/endpoints/get_webhooks_create.json

@@ -0,0 +1,24 @@
+{
+  "slug": "get_webhooks_create",
+  "operationId": "getWebhooksCreate",
+  "method": "GET",
+  "path": "/api/v1/webhooks/create",
+  "name": "Gets a new blank Webhook object",
+  "category": "webhooks",
+  "mutating": false,
+  "description": "Returns a blank object with default values",
+  "whenToUse": "Fetch a blank webhook template with default values to prefill a new-webhook form (read-only); use store_webhook to create it.",
+  "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": "Webhook"
+}

package/dist/catalog/endpoints/invite_user.json

@@ -0,0 +1,32 @@
+{
+  "slug": "invite_user",
+  "operationId": "inviteUser",
+  "method": "POST",
+  "path": "/api/v1/users/{user}/invite",
+  "name": "Reconfirm an existing user to a company",
+  "category": "users",
+  "mutating": true,
+  "description": "Reconfirm an existing user from a company",
+  "whenToUse": "Send the initial invite to an existing user by id (the /invite endpoint); use for a first-time invitation rather than reconfirm (mutating).",
+  "pathParameters": [
+    {
+      "name": "user",
+      "type": "string",
+      "required": true,
+      "description": "The user hashed_id",
+      "format": "string",
+      "example": "FD767dfd7"
+    }
+  ],
+  "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/invite_user_reconfirm.json

@@ -0,0 +1,32 @@
+{
+  "slug": "invite_user_reconfirm",
+  "operationId": "inviteUserReconfirm",
+  "method": "POST",
+  "path": "/api/v1/users/{user}/reconfirm",
+  "name": "Reconfirm an existing user to a company",
+  "category": "users",
+  "mutating": true,
+  "description": "Reconfirm an existing user from a company",
+  "whenToUse": "Resend a confirmation to an existing user by id (the /reconfirm endpoint); use to re-trigger confirmation rather than a fresh invite (mutating).",
+  "pathParameters": [
+    {
+      "name": "user",
+      "type": "string",
+      "required": true,
+      "description": "The user hashed_id",
+      "format": "string",
+      "example": "FD767dfd7"
+    }
+  ],
+  "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/match_bank_transactions.json

@@ -0,0 +1,26 @@
+{
+  "slug": "match_bank_transactions",
+  "operationId": "matchBankTransactions",
+  "method": "POST",
+  "path": "/api/v1/bank_transactions/match",
+  "name": "Match transactions",
+  "category": "bank_transactions",
+  "mutating": true,
+  "description": "Matching invoices or a payment to a bank transactions.\n\nThe API expects the id of the transaction along with either a comma separated list of invoice ids OR the payment id to associate the transaction to.\n\nExample for matching a transaction to two invoices:\n\n{\"transactions\":[{\"id\":\"olejRl5ejN\",\"invoice_ids\":\"JxboYBLegw,JxboYBLeXX\"}]}\n\nExample for matching a transaction and a paymente:\n\n{\"transactions\":[{\"id\":\"olejRl5ejN\",\"payment_id\":\"JxboYBLeXf\"}]}\n\nMatching expenses.\n\nYou can match an existing expense within Invoice Ninja - or - create a new expense using the following:\n\n{\"transactions\":[{\"id\":\"open5pld7A\",\"vendor_id\":\"gl9avJnaG1\",\"ninja_category_id\":\"\"}]}\n\nTo match to an existing expense:\n\n{\"transactions\":[{\"id\":\"Jxbo2qKagw\",\"expense_id\":\"7N1aMM1aWm\"}]}",
+  "whenToUse": "Link bank transactions to invoices, payments, or expenses by id; use to reconcile imported transactions against records (mutating).",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "index",
+      "type": "string",
+      "required": false,
+      "description": "Replaces the default response index from data to a user specific string\n\nie.\n\n```html\n  ?index=new_index\n```\n\nresponse is wrapped\n\n```json\n  {\n    'new_index' : [\n      .....\n    ]\n  }\n```",
+      "example": "user"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": []
+  }
+}

package/dist/catalog/endpoints/merge_client.json

@@ -0,0 +1,54 @@
+{
+  "slug": "merge_client",
+  "operationId": "mergeClient",
+  "method": "POST",
+  "path": "/api/v1/clients/{id}/{mergeable_client_hashed_id}/merge",
+  "name": "Merge client",
+  "category": "clients",
+  "mutating": true,
+  "description": "##  POST /api/v1/clients/{id}/{mergeable_client_hashed_id}/merge\n\nHandles merging 2 clients\n\nThe id parameter is the client that will be the primary client after the merge has completed.\n\nThe mergeable_client_hashed_id is the client that will be merged into the primary client, this clients records will be updated and associated with the primary client.\n\n> 🚨 **Important**\nThis action requires elevated permissions, please note the X-API-PASSWORD header requirements for this route.",
+  "whenToUse": "Merge a secondary client into a primary by their two ids (needs X-API-PASSWORD); use to consolidate duplicate client records (mutating).",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The Client Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    },
+    {
+      "name": "mergeable_client_hashed_id",
+      "type": "string",
+      "required": true,
+      "description": "The Mergeable Client Hashed ID",
+      "format": "string",
+      "example": "D2J234DFA"
+    }
+  ],
+  "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": [
+    {
+      "name": "X-API-PASSWORD",
+      "type": "string",
+      "required": true,
+      "description": "The login password when challenged on certain protected routes",
+      "example": "supersecretpassword"
+    }
+  ],
+  "requestBody": null
+}

package/dist/catalog/endpoints/post_activities_entity.json

@@ -0,0 +1,18 @@
+{
+  "slug": "post_activities_entity",
+  "operationId": "postActivitiesEntity",
+  "method": "POST",
+  "path": "/api/v1/activities/entity",
+  "name": "Entity activity",
+  "category": "activities",
+  "mutating": true,
+  "description": "Returns activity for a given entity",
+  "whenToUse": "Fetch the activity history scoped to a specific entity via POST body when listing all company activities is too broad (mutating).",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": []
+  }
+}

package/dist/catalog/endpoints/post_activities_notes.json

@@ -0,0 +1,18 @@
+{
+  "slug": "post_activities_notes",
+  "operationId": "postActivitiesNotes",
+  "method": "POST",
+  "path": "/api/v1/activities/notes",
+  "name": "Activity note",
+  "category": "activities",
+  "mutating": true,
+  "description": "Creates or updates an activity note",
+  "whenToUse": "Create or update a note attached to an activity when you need to annotate the activity log (mutating).",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": []
+  }
+}

package/dist/catalog/endpoints/post_connected_account.json

@@ -0,0 +1,38 @@
+{
+  "slug": "post_connected_account",
+  "operationId": "postConnectedAccount",
+  "method": "POST",
+  "path": "/api/v1/connected_account",
+  "name": "Connect an oauth user to an existing user",
+  "category": "connected_account",
+  "mutating": true,
+  "description": "Refreshes the dataset",
+  "whenToUse": "Link an OAuth identity to an existing user account and refresh the dataset; use for connecting Google/Microsoft sign-in, not creating users (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": "include_static",
+      "type": "string",
+      "required": false,
+      "description": "This include will return the full set of static variables used in the application including:\n  - Currencies\n  - Countries\n  - Languages\n  - Payment Types\n  - Email Templatees\n  - Industries",
+      "example": "include_static=true"
+    },
+    {
+      "name": "clear_cache",
+      "type": "string",
+      "required": false,
+      "description": "Clears cache\n\nClears (and rebuilds) the static variable cache.",
+      "example": "clear_cache=true"
+    }
+  ],
+  "headerParameters": [],
+  "requestBody": null,
+  "responseSchema": "User"
+}

package/dist/catalog/endpoints/post_import.json

@@ -0,0 +1,51 @@
+{
+  "slug": "post_import",
+  "operationId": "postImport",
+  "method": "POST",
+  "path": "/api/v1/import",
+  "name": "Import CSV data",
+  "category": "imports",
+  "mutating": true,
+  "description": "The import endpoint executes the actual data import. Call this after `/api/v1/preimport` has returned the file hash, available fields, and column headers.\n\nUsing the data from the preimport response, construct a `column_map` that tells the system how each CSV column maps to a system field. The import runs asynchronously — you will receive an email notification once it completes.\n\n*Request body**\n\n- **hash** — The unique file reference returned by `/api/v1/preimport`.\n- **import_type** — The source format (e.g. `csv`, `freshbooks`, `invoice2go`, `invoicely`).\n- **skip_header** — Set to `true` to skip the first row of the CSV (the header row).\n- **column_map** — An object keyed by entity type (e.g. `invoice`, `client`). Each entity contains:\n  - **mapping** — An object where each key is the CSV column index (as a string) and each value is the target system field from the `available` array, or an empty string `\"\"` to skip that column.\n\n---\n\n### Available mapping fields\n\nEach mapping value uses the format `entity.property`. The tables below list every available field per entity type.\n\n### Data Matching:\n\n#### Client Matching:\n  Matching a record to a client is performed by using the clients email address (first) or the clients (exact) name. If no match is found, a new client is created.\n\n#### Multi line item invoice/quote/credits/recurring invoice Matching:\n  If you need to import multiple line items into an invoice (other other entity) you will want to assign the same (unique) invoice number to each row in the csv file, the system will group together lines where the invoice number is the same and create line items for each row.\n\n#### Invoice fields (`files[invoice]`)\n\n| Field | Description |\n|---|---|\n| `invoice.number` | Invoice number |\n| `invoice.user_id` | Assigned user |\n| `invoice.amount` | Invoice amount |\n| `invoice.balance` | Outstanding balance |\n| `invoice.discount` | Discount value |\n| `invoice.po_number` | Purchase order number |\n| `invoice.date` | Invoice date |\n| `invoice.due_date` | Due date |\n| `invoice.terms` | Invoice terms |\n| `invoice.status` | Invoice status |\n| `invoice.public_notes` | Public notes (visible to client) |\n| `invoice.is_sent` | Whether the invoice has been sent |\n| `invoice.private_notes` | Private notes (internal only) |\n| `invoice.uses_inclusive_taxes` | Whether tax amounts are inclusive |\n| `invoice.tax_name1` | Tax name (tier 1) |\n| `invoice.tax_rate1` | Tax rate (tier 1) |\n| `invoice.tax_name2` | Tax name (tier 2) |\n| `invoice.tax_rate2` | Tax rate (tier 2) |\n| `invoice.tax_name3` | Tax name (tier 3) |\n| `invoice.tax_rate3` | Tax rate (tier 3) |\n| `invoice.is_amount_discount` | Whether discount is a fixed amount |\n| `invoice.footer` | Invoice footer |\n| `invoice.partial` | Partial/deposit amount |\n| `invoice.partial_due_date` | Partial payment due date |\n| `invoice.custom_value1` | Custom field 1 |\n| `invoice.custom_value2` | Custom field 2 |\n| `invoice.custom_value3` | Custom field 3 |\n| `invoice.custom_value4` | Custom field 4 |\n| `invoice.custom_surcharge1` | Custom surcharge 1 |\n| `invoice.custom_surcharge2` | Custom surcharge 2 |\n| `invoice.custom_surcharge3` | Custom surcharge 3 |\n| `invoice.custom_surcharge4` | Custom surcharge 4 |\n| `invoice.exchange_rate` | Currency exchange rate |\n| `client.name` | Client name |\n| `client.email` | Client email |\n| `payment.date` | Payment date |\n| `payment.amount` | Payment amount |\n| `payment.transaction_reference` | Payment transaction reference |\n| `item.quantity` | Line item quantity |\n| `item.cost` | Line item unit cost |\n| `item.product_key` | Line item product key |\n| `item.notes` | Line item description |\n| `item.discount` | Line item discount |\n| `item.is_amount_discount` | Whether line item discount is a fixed amount |\n| `item.tax_name1` | Line item tax name (tier 1) |\n| `item.tax_rate1` | Line item tax rate (tier 1) |\n| `item.tax_name2` | Line item tax name (tier 2) |\n| `item.tax_rate2` | Line item tax rate (tier 2) |\n| `item.tax_name3` | Line item tax name (tier 3) |\n| `item.tax_rate3` | Line item tax rate (tier 3) |\n| `item.custom_value1` | Line item custom field 1 |\n| `item.custom_value2` | Line item custom field 2 |\n| `item.custom_value3` | Line item custom field 3 |\n| `item.custom_value4` | Line item custom field 4 |\n| `item.type_id` | Line item type |\n\n#### Client fields (`files[client]`)\n\n| Field | Description |\n|---|---|\n| `client.name` | Client name |\n| `client.user_id` | Assigned user |\n| `client.balance` | Account balance |\n| `client.paid_to_date` | Total paid to date |\n| `client.currency_id` | Currency |\n| `client.website` | Website URL |\n| `client.private_notes` | Private notes |\n| `client.industry_id` | Industry |\n| `client.size_id` | Company size |\n| `client.address1` | Address line 1 |\n| `client.address2` | Address line 2 |\n| `client.city` | City |\n| `client.state` | State/province |\n| `client.postal_code` | Postal code |\n| `client.country_id` | Country |\n| `client.custom_value1` | Custom field 1 |\n| `client.custom_value2` | Custom field 2 |\n| `client.custom_value3` | Custom field 3 |\n| `client.custom_value4` | Custom field 4 |\n| `client.shipping_address1` | Shipping address line 1 |\n| `client.shipping_address2` | Shipping address line 2 |\n| `client.shipping_city` | Shipping city |\n| `client.shipping_state` | Shipping state/province |\n| `client.shipping_postal_code` | Shipping postal code |\n| `client.shipping_country_id` | Shipping country |\n| `client.payment_terms` | Default payment terms |\n| `client.vat_number` | VAT/tax number |\n| `client.id_number` | ID number |\n| `client.public_notes` | Public notes |\n| `client.phone` | Phone number |\n| `contact.first_name` | Contact first name |\n| `contact.last_name` | Contact last name |\n| `contact.email` | Contact email |\n| `contact.phone` | Contact phone |\n| `contact.custom_value1` | Contact custom field 1 |\n| `contact.custom_value2` | Contact custom field 2 |\n| `contact.custom_value3` | Contact custom field 3 |\n| `contact.custom_value4` | Contact custom field 4 |\n\n#### Product fields (`files[product]`)\n\n| Field | Description |\n|---|---|\n| `product.product_key` | Product key/name |\n| `product.notes` | Product description |\n| `product.cost` | Product cost |\n| `product.price` | Product price |\n| `product.quantity` | Default quantity |\n| `product.tax_name1` | Tax name (tier 1) |\n| `product.tax_rate1` | Tax rate (tier 1) |\n| `product.tax_name2` | Tax name (tier 2) |\n| `product.tax_rate2` | Tax rate (tier 2) |\n| `product.tax_name3` | Tax name (tier 3) |\n| `product.tax_rate3` | Tax rate (tier 3) |\n| `product.custom_value1` | Custom field 1 |\n| `product.custom_value2` | Custom field 2 |\n| `product.custom_value3` | Custom field 3 |\n| `product.custom_value4` | Custom field 4 |\n| `product.image_url` | Product image URL |\n| `product.in_stock_quantity` | In-stock quantity |\n| `product.tax_category` | Tax category |\n| `product.max_quantity` | Maximum quantity |\n\n#### Payment fields (`files[payment]`)\n\n| Field | Description |\n|---|---|\n| `payment.number` | Payment number |\n| `payment.user_id` | Assigned user |\n| `payment.amount` | Payment amount |\n| `payment.refunded` | Refunded amount |\n| `payment.applied` | Applied amount |\n| `payment.transaction_reference` | Transaction reference |\n| `payment.private_notes` | Private notes |\n| `payment.custom_value1` | Custom field 1 |\n| `payment.custom_value2` | Custom field 2 |\n| `payment.custom_value3` | Custom field 3 |\n| `payment.custom_value4` | Custom field 4 |\n| `payment.client_id` | Client |\n| `payment.invoice_number` | Invoice number |\n| `payment.date` | Payment date |\n| `payment.method` | Payment method |\n\n#### Vendor fields (`files[vendor]`)\n\n| Field | Description |\n|---|---|\n| `vendor.name` | Vendor name |\n| `vendor.phone` | Phone number |\n| `vendor.id_number` | ID number |\n| `vendor.vat_number` | VAT/tax number |\n| `vendor.website` | Website URL |\n| `vendor.first_name` | First name |\n| `vendor.last_name` | Last name |\n| `vendor.email` | Email address |\n| `vendor.currency_id` | Currency |\n| `vendor.public_notes` | Public notes |\n| `vendor.private_notes` | Private notes |\n| `vendor.address1` | Address line 1 |\n| `vendor.address2` | Address line 2 |\n| `vendor.city` | City |\n| `vendor.state` | State/province |\n| `vendor.postal_code` | Postal code |\n| `vendor.country_id` | Country |\n| `vendor.custom_value1` | Custom field 1 |\n| `vendor.custom_value2` | Custom field 2 |\n| `vendor.custom_value3` | Custom field 3 |\n| `vendor.custom_value4` | Custom field 4 |\n| `contact.first_name` | Contact first name |\n| `contact.last_name` | Contact last name |\n| `contact.email` | Contact email |\n| `contact.phone` | Contact phone |\n| `contact.custom_value1` | Contact custom field 1 |\n| `contact.custom_value2` | Contact custom field 2 |\n| `contact.custom_value3` | Contact custom field 3 |\n| `contact.custom_value4` | Contact custom field 4 |\n\n#### Expense fields (`files[expense]`)\n\n| Field | Description |\n|---|---|\n| `expense.vendor` | Vendor name |\n| `expense.client` | Client name |\n| `expense.project` | Project name |\n| `expense.category` | Expense category |\n| `expense.amount` | Expense amount |\n| `expense.currency` | Currency |\n| `expense.date` | Expense date |\n| `expense.payment_type` | Payment type |\n| `expense.payment_date` | Payment date |\n| `expense.transaction_reference` | Transaction reference |\n| `expense.public_notes` | Public notes |\n| `expense.private_notes` | Private notes |\n| `expense.tax_name1` | Tax name (tier 1) |\n| `expense.tax_rate1` | Tax rate (tier 1) |\n| `expense.tax_name2` | Tax name (tier 2) |\n| `expense.tax_rate2` | Tax rate (tier 2) |\n| `expense.tax_name3` | Tax name (tier 3) |\n| `expense.tax_rate3` | Tax rate (tier 3) |\n| `expense.uses_inclusive_taxes` | Whether tax amounts are inclusive |\n| `expense.custom_value1` | Custom field 1 |\n| `expense.custom_value2` | Custom field 2 |\n| `expense.custom_value3` | Custom field 3 |\n| `expense.custom_value4` | Custom field 4 |\n\n#### Quote fields (`files[quote]`)\n\n| Field | Description |\n|---|---|\n| `quote.number` | Quote number |\n| `quote.user_id` | Assigned user |\n| `quote.amount` | Quote amount |\n| `quote.balance` | Outstanding balance |\n| `quote.discount` | Discount value |\n| `quote.po_number` | Purchase order number |\n| `quote.date` | Quote date |\n| `quote.due_date` | Valid until date |\n| `quote.terms` | Quote terms |\n| `quote.status` | Quote status |\n| `quote.public_notes` | Public notes |\n| `quote.is_sent` | Whether the quote has been sent |\n| `quote.private_notes` | Private notes |\n| `quote.uses_inclusive_taxes` | Whether tax amounts are inclusive |\n| `quote.tax_name1` | Tax name (tier 1) |\n| `quote.tax_rate1` | Tax rate (tier 1) |\n| `quote.tax_name2` | Tax name (tier 2) |\n| `quote.tax_rate2` | Tax rate (tier 2) |\n| `quote.tax_name3` | Tax name (tier 3) |\n| `quote.tax_rate3` | Tax rate (tier 3) |\n| `quote.is_amount_discount` | Whether discount is a fixed amount |\n| `quote.footer` | Quote footer |\n| `quote.partial` | Partial/deposit amount |\n| `quote.partial_due_date` | Partial payment due date |\n| `quote.custom_value1` | Custom field 1 |\n| `quote.custom_value2` | Custom field 2 |\n| `quote.custom_value3` | Custom field 3 |\n| `quote.custom_value4` | Custom field 4 |\n| `quote.custom_surcharge1` | Custom surcharge 1 |\n| `quote.custom_surcharge2` | Custom surcharge 2 |\n| `quote.custom_surcharge3` | Custom surcharge 3 |\n| `quote.custom_surcharge4` | Custom surcharge 4 |\n| `quote.exchange_rate` | Currency exchange rate |\n| `client.name` | Client name |\n| `client.email` | Client email |\n| `payment.date` | Payment date |\n| `payment.amount` | Payment amount |\n| `payment.transaction_reference` | Transaction reference |\n| `item.*` | Same line item fields as invoices |\n\n#### Recurring invoice fields (`files[recurring_invoice]`)\n\nSupports all invoice fields above, plus:\n\n| Field | Description |\n|---|---|\n| `invoice.frequency_id` | Recurrence frequency |\n| `invoice.remaining_cycles` | Remaining billing cycles |\n| `invoice.auto_bill` | Auto-bill setting |\n| `invoice.next_send_date` | Next send date (replaces `invoice.date`) |\n\n#### Task fields (`files[task]`)\n\n| Field | Description |\n|---|---|\n| `task.number` | Task number |\n| `task.user_id` | Assigned user |\n| `task.rate` | Hourly rate |\n| `task.description` | Task description |\n| `task.billable` | Whether the task is billable |\n| `task.status` | Task status |\n| `task.start_date` | Start date |\n| `task.end_date` | End date |\n| `task.start_time` | Start time |\n| `task.end_time` | End time |\n| `task.duration` | Duration |\n| `task.custom_value1` | Custom field 1 |\n| `task.custom_value2` | Custom field 2 |\n| `task.custom_value3` | Custom field 3 |\n| `task.custom_value4` | Custom field 4 |\n| `task.notes` | Task notes |\n| `project.name` | Project name |\n| `client.name` | Client name |\n| `client.email` | Client email |\n\n#### Bank transaction fields (`files[bank_transaction]`)\n\n| Field | Description |\n|---|---|\n| `transaction.transaction_id` | Transaction ID |\n| `transaction.amount` | Transaction amount |\n| `transaction.currency` | Currency |\n| `transaction.account_type` | Account type |\n| `transaction.category` | Category |\n| `transaction.category_type` | Category type |\n| `transaction.date` | Transaction date |\n| `transaction.bank_account` | Bank account |\n| `transaction.description` | Description |\n| `transaction.base_type` | Base type |\n| `transaction.payment_type_Credit` | Credit amount |\n| `transaction.payment_type_Debit` | Debit amount |\n| `transaction.participant` | Participant reference |\n| `transaction.participant_name` | Participant name |\n\n---\n\n*Example**\n\n```bash\ncurl -X POST 'https://invoiceninja.com/api/v1/import' \\\n  -H 'X-API-TOKEN: YOUR_API_TOKEN_HERE' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\n    \"hash\": \"MvKeSwMnhAfgkzdYKgxM5ummxGbLIdNm\",\n    \"import_type\": \"csv\",\n    \"skip_header\": true,\n    \"column_map\": {\n      \"invoice\": {\n        \"mapping\": {\n          \"0\": \"client.name\",\n          \"1\": \"client.email\",\n          \"2\": \"\",\n          \"3\": \"invoice.number\",\n          \"4\": \"invoice.amount\"\n        }\n      }\n    }\n  }'\n```",
+  "whenToUse": "Execute the actual CSV import using the hash and column_map from preimport; call only after preimport returns headers (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": "hash",
+        "type": "string",
+        "required": true,
+        "description": "The unique file reference returned by the preimport endpoint."
+      },
+      {
+        "name": "import_type",
+        "type": "string",
+        "required": true,
+        "description": "The source format of the import."
+      },
+      {
+        "name": "skip_header",
+        "type": "boolean",
+        "required": false,
+        "description": "When true, the first row of the CSV is treated as a header row and skipped during import."
+      },
+      {
+        "name": "column_map",
+        "type": "object",
+        "required": true,
+        "description": "An object keyed by entity type. Each entity contains a mapping of CSV column indices to system fields."
+      }
+    ]
+  }
+}

package/dist/catalog/endpoints/post_login.json

@@ -0,0 +1,79 @@
+{
+  "slug": "post_login",
+  "operationId": "postLogin",
+  "method": "POST",
+  "path": "/api/v1/login",
+  "name": "Login",
+  "category": "auth",
+  "mutating": true,
+  "description": "Login",
+  "whenToUse": "Authenticate a user with email plus password, 2FA, or passkey assertion to obtain a CompanyUser session (mutating).",
+  "pathParameters": [],
+  "queryParameters": [
+    {
+      "name": "include",
+      "type": "string",
+      "required": false,
+      "description": "Include child relations of the CompanyUser object, format is comma separated.\n\n<br />\n\n> ### **Note**: it is possible to chain multiple includes together, ie. include=account,token\n\n<br />\n\n```html\n\nAvailable includes:\n\n  user\n  company\n  token\n  account\n```"
+    },
+    {
+      "name": "include_static",
+      "type": "string",
+      "required": false,
+      "description": "This include will return the full set of static variables used in the application including:\n  - Currencies\n  - Countries\n  - Languages\n  - Payment Types\n  - Email Templatees\n  - Industries",
+      "example": "include_static=true"
+    },
+    {
+      "name": "clear_cache",
+      "type": "string",
+      "required": false,
+      "description": "Clears cache\n\nClears (and rebuilds) the static variable cache.",
+      "example": "clear_cache=true"
+    }
+  ],
+  "headerParameters": [
+    {
+      "name": "X-API-SECRET",
+      "type": "string",
+      "required": false,
+      "description": "The API secret as defined by the .env variable API_SECRET. Only needed for self hosted users, and only applicable on the login route.",
+      "example": "password"
+    }
+  ],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "email",
+        "type": "string",
+        "required": true,
+        "description": "The users email address."
+      },
+      {
+        "name": "password",
+        "type": "string",
+        "required": false,
+        "description": "The user password. Optional when performing passkey passwordless login."
+      },
+      {
+        "name": "one_time_password",
+        "type": "string",
+        "required": false,
+        "description": "The one time password if 2FA is enabled"
+      },
+      {
+        "name": "passkey_challenge_token",
+        "type": "string",
+        "required": false,
+        "description": "Challenge token returned by passkey login options or second-factor challenge."
+      },
+      {
+        "name": "passkey_authentication",
+        "type": "object",
+        "required": false,
+        "description": "WebAuthn assertion payload."
+      }
+    ]
+  },
+  "responseSchema": "CompanyUser"
+}

package/dist/catalog/endpoints/post_one_time_token.json

@@ -0,0 +1,15 @@
+{
+  "slug": "post_one_time_token",
+  "operationId": "postOneTimeToken",
+  "method": "POST",
+  "path": "/api/v1/one_time_token",
+  "name": "Attempts to create a one time token",
+  "category": "one_time_token",
+  "mutating": true,
+  "description": "Attempts to create a one time token",
+  "whenToUse": "Call to mint a short-lived one-time token for a single privileged action like a redirect or hosted-page handoff (mutating).",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": null
+}

package/dist/catalog/endpoints/post_passkey_login_options.json

@@ -0,0 +1,24 @@
+{
+  "slug": "post_passkey_login_options",
+  "operationId": "postPasskeyLoginOptions",
+  "method": "POST",
+  "path": "/api/v1/passkeys/login/options",
+  "name": "Passkey login options",
+  "category": "auth",
+  "mutating": true,
+  "description": "Passkey login options",
+  "whenToUse": "Request WebAuthn challenge options for an email to begin passwordless passkey sign-in before calling post_login (mutating).",
+  "pathParameters": [],
+  "queryParameters": [],
+  "headerParameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "fields": [
+      {
+        "name": "email",
+        "type": "string",
+        "required": true
+      }
+    ]
+  }
+}