KashFlow MCP by usefulapi is an MCP server published by io.usefulapi, hosted at kashflow.usefulapi.io. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 38 tools, including kashflow_get_company_details, kashflow_list_customers, kashflow_get_customer, kashflow_get_customer_by_id, kashflow_find_customer_by_email.
Read KashFlow invoices, customers, suppliers, banking and reports; add customers, notes.
4,206 connections through 5 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
The KashFlow company: name, address, contact, VAT registration, currency, payment terms and business type. SOAP GetCompanyDetails.
No parameters.
{
"name": "kashflow_get_company_details",
"title": "Get company details",
"description": "The KashFlow company: name, address, contact, VAT registration, currency, payment terms and business type. SOAP GetCompanyDetails.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "Get company details",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}All customers (name, code, contact, email, phone, address, VAT number, payment terms, notes), paged here: the reply says total and next_offset. SOAP GetCustomers.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | How many records to return (default 100, max 500). |
| offset | integer | How many records to skip (default 0), to get the next page. |
{
"name": "kashflow_list_customers",
"title": "List customers",
"description": "All customers (name, code, contact, email, phone, address, VAT number, payment terms, notes), paged here: the reply says total and next_offset. SOAP GetCustomers.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many records to return (default 100, max 500)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "How many records to skip (default 0), to get the next page."
}
}
},
"annotations": {
"title": "List customers",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One customer by its KashFlow customer code (the short code shown in the customer list, e.g. ACME01). SOAP GetCustomer.
| Parameter | Type | Description |
|---|---|---|
| customer_code * | string | The customer code, e.g. ACME01. |
{
"name": "kashflow_get_customer",
"title": "Get customer by code",
"description": "One customer by its KashFlow customer code (the short code shown in the customer list, e.g. ACME01). SOAP GetCustomer.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_code"
],
"properties": {
"customer_code": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "The customer code, e.g. ACME01."
}
}
},
"annotations": {
"title": "Get customer by code",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One customer by its numeric CustomerID (as returned in other replies). SOAP GetCustomerByID.
| Parameter | Type | Description |
|---|---|---|
| customer_id * | integer | The numeric CustomerID. |
{
"name": "kashflow_get_customer_by_id",
"title": "Get customer by id",
"description": "One customer by its numeric CustomerID (as returned in other replies). SOAP GetCustomerByID.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"customer_id": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"description": "The numeric CustomerID."
}
}
},
"annotations": {
"title": "Get customer by id",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The customer whose e-mail address matches. SOAP GetCustomerByEmail.
| Parameter | Type | Description |
|---|---|---|
| email * | string | The customer's e-mail address. |
{
"name": "kashflow_find_customer_by_email",
"title": "Find customer by email",
"description": "The customer whose e-mail address matches. SOAP GetCustomerByEmail.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"maxLength": 254,
"minLength": 3,
"description": "The customer's e-mail address."
}
}
},
"annotations": {
"title": "Find customer by email",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}What one customer owes: the total invoiced value and the outstanding balance. SOAP GetCustomerBalance.
| Parameter | Type | Description |
|---|---|---|
| customer_code * | string | The customer code, e.g. ACME01. |
{
"name": "kashflow_get_customer_balance",
"title": "Get customer balance",
"description": "What one customer owes: the total invoiced value and the outstanding balance. SOAP GetCustomerBalance.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_code"
],
"properties": {
"customer_code": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "The customer code, e.g. ACME01."
}
}
},
"annotations": {
"title": "Get customer balance",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: create a new customer. The code must be unique (KashFlow refuses a code that exists) and nothing existing is changed. Returns the new CustomerID. SOAP InsertCustomer.
| Parameter | Type | Description |
|---|---|---|
| code * | string | A unique customer code, e.g. ACME01. |
| name * | string | The customer / company name. |
| string | ||
| notes | string | |
| mobile | string | |
| contact | string | Contact person. |
| website | string | |
| address1 | string | |
| address2 | string | |
| address3 | string | |
| address4 | string | |
| postcode | string |
All suppliers (name, code, contact, email, phone, address, VAT number, payment terms), paged here: the reply says total and next_offset. SOAP GetSuppliers.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | How many records to return (default 100, max 500). |
| offset | integer | How many records to skip (default 0), to get the next page. |
{
"name": "kashflow_list_suppliers",
"title": "List suppliers",
"description": "All suppliers (name, code, contact, email, phone, address, VAT number, payment terms), paged here: the reply says total and next_offset. SOAP GetSuppliers.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many records to return (default 100, max 500)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "How many records to skip (default 0), to get the next page."
}
}
},
"annotations": {
"title": "List suppliers",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One supplier by its KashFlow supplier code. SOAP GetSupplier.
| Parameter | Type | Description |
|---|---|---|
| supplier_code * | string | The supplier code. |
{
"name": "kashflow_get_supplier",
"title": "Get supplier by code",
"description": "One supplier by its KashFlow supplier code. SOAP GetSupplier.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"supplier_code"
],
"properties": {
"supplier_code": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "The supplier code."
}
}
},
"annotations": {
"title": "Get supplier by code",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: create a new supplier. The code must be unique (KashFlow refuses a code that exists) and nothing existing is changed. Returns the new SupplierID. SOAP InsertSupplier.
| Parameter | Type | Description |
|---|---|---|
| code * | string | A unique supplier code, e.g. OFFICE01. |
| name * | string | The supplier / company name. |
| string | ||
| notes | string | |
| mobile | string | |
| contact | string | Contact person. |
| website | string | |
| address1 | string | |
| address2 | string | |
| address3 | string | |
| address4 | string | |
| postcode | string |
One sales invoice by its invoice number: customer, dates, lines (description, quantity, rate, VAT), net, VAT, amount paid and a link. SOAP GetInvoice.
| Parameter | Type | Description |
|---|---|---|
| invoice_number * | integer | The invoice number, e.g. 1042. |
{
"name": "kashflow_get_invoice",
"title": "Get invoice by number",
"description": "One sales invoice by its invoice number: customer, dates, lines (description, quantity, rate, VAT), net, VAT, amount paid and a link. SOAP GetInvoice.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"invoice_number"
],
"properties": {
"invoice_number": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"description": "The invoice number, e.g. 1042."
}
}
},
"annotations": {
"title": "Get invoice by number",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Sales invoices dated within a range (inclusive; a bare end date means the end of that day), paged here. Dates are yyyy-mm-dd. SOAP GetInvoicesByDateRange.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | How many records to return (default 100, max 500). |
| offset | integer | How many records to skip (default 0), to get the next page. |
| end_date * | string | Last invoice date, yyyy-mm-dd. |
| start_date * | string | First invoice date, yyyy-mm-dd. |
{
"name": "kashflow_list_invoices",
"title": "List invoices by date range",
"description": "Sales invoices dated within a range (inclusive; a bare end date means the end of that day), paged here. Dates are yyyy-mm-dd. SOAP GetInvoicesByDateRange.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"start_date",
"end_date"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many records to return (default 100, max 500)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "How many records to skip (default 0), to get the next page."
},
"end_date": {
"type": "string",
"description": "Last invoice date, yyyy-mm-dd."
},
"start_date": {
"type": "string",
"description": "First invoice date, yyyy-mm-dd."
}
}
},
"annotations": {
"title": "List invoices by date range",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}All sales invoices of one customer, by numeric CustomerID (see kashflow_get_customer for the id), paged here. SOAP GetInvoicesForCustomer.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | How many records to return (default 100, max 500). |
| offset | integer | How many records to skip (default 0), to get the next page. |
| customer_id * | integer | The numeric CustomerID. |
{
"name": "kashflow_list_customer_invoices",
"title": "List a customer's invoices",
"description": "All sales invoices of one customer, by numeric CustomerID (see kashflow_get_customer for the id), paged here. SOAP GetInvoicesForCustomer.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many records to return (default 100, max 500)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "How many records to skip (default 0), to get the next page."
},
"customer_id": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"description": "The numeric CustomerID."
}
}
},
"annotations": {
"title": "List a customer's invoices",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}All sales invoices not yet paid in full, paged here. SOAP GetInvoices_Unpaid.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | How many records to return (default 100, max 500). |
| offset | integer | How many records to skip (default 0), to get the next page. |
{
"name": "kashflow_list_unpaid_invoices",
"title": "List unpaid invoices",
"description": "All sales invoices not yet paid in full, paged here. SOAP GetInvoices_Unpaid.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many records to return (default 100, max 500)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "How many records to skip (default 0), to get the next page."
}
}
},
"annotations": {
"title": "List unpaid invoices",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}All sales invoices past their due date and not paid in full, paged here. SOAP GetInvoices_Overdue.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | How many records to return (default 100, max 500). |
| offset | integer | How many records to skip (default 0), to get the next page. |
{
"name": "kashflow_list_overdue_invoices",
"title": "List overdue invoices",
"description": "All sales invoices past their due date and not paid in full, paged here. SOAP GetInvoices_Overdue.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many records to return (default 100, max 500)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "How many records to skip (default 0), to get the next page."
}
}
},
"annotations": {
"title": "List overdue invoices",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The most recently created sales invoices. SOAP GetInvoices_Recent.
| Parameter | Type | Description |
|---|---|---|
| count | integer | How many invoices (default 20, max 500). |
{
"name": "kashflow_list_recent_invoices",
"title": "List recent invoices",
"description": "The most recently created sales invoices. SOAP GetInvoices_Recent.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"count": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many invoices (default 20, max 500)."
}
}
},
"annotations": {
"title": "List recent invoices",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The payments recorded against one sales invoice (date, amount, method, bank account, note), by invoice number. SOAP GetInvoicePayment.
| Parameter | Type | Description |
|---|---|---|
| invoice_number * | integer | The invoice number. |
{
"name": "kashflow_list_invoice_payments",
"title": "List payments of an invoice",
"description": "The payments recorded against one sales invoice (date, amount, method, bank account, note), by invoice number. SOAP GetInvoicePayment.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"invoice_number"
],
"properties": {
"invoice_number": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"description": "The invoice number."
}
}
},
"annotations": {
"title": "List payments of an invoice",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Customer payments received within a date range (date, amount, invoice, method, bank account). KashFlow returns them a page at a time: set page_number 1, 2, ... until a page comes back empty. Dates are yyyy-mm-dd. SOAP GetInvoicePaymentsByDateRange.
| Parameter | Type | Description |
|---|---|---|
| end_date * | string | Last payment date, yyyy-mm-dd. |
| start_date * | string | First payment date, yyyy-mm-dd. |
| page_number | integer | Page number, starting at 1 (default 1). |
{
"name": "kashflow_list_payments_by_date",
"title": "List invoice payments by date range",
"description": "Customer payments received within a date range (date, amount, invoice, method, bank account). KashFlow returns them a page at a time: set page_number 1, 2, ... until a page comes back empty. Dates are yyyy-mm-dd. SOAP GetInvoicePaymentsByDateRange.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"start_date",
"end_date"
],
"properties": {
"end_date": {
"type": "string",
"description": "Last payment date, yyyy-mm-dd."
},
"start_date": {
"type": "string",
"description": "First payment date, yyyy-mm-dd."
},
"page_number": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number, starting at 1 (default 1)."
}
}
},
"annotations": {
"title": "List invoice payments by date range",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The notes attached to one sales invoice, by its InvoiceDBID (the numeric id in invoice replies, not the invoice number). SOAP GetInvoiceNotes.
| Parameter | Type | Description |
|---|---|---|
| invoice_id * | integer | The invoice's InvoiceDBID. |
{
"name": "kashflow_get_invoice_notes",
"title": "Get invoice notes",
"description": "The notes attached to one sales invoice, by its InvoiceDBID (the numeric id in invoice replies, not the invoice number). SOAP GetInvoiceNotes.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"invoice_id"
],
"properties": {
"invoice_id": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"description": "The invoice's InvoiceDBID."
}
}
},
"annotations": {
"title": "Get invoice notes",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: add a note to a sales invoice, by its InvoiceDBID (the numeric id in invoice replies). Existing notes and the invoice are not changed. SOAP InsertInvoiceNote.
| Parameter | Type | Description |
|---|---|---|
| note * | string | The note text. |
| note_date | string | Note date, yyyy-mm-dd or yyyy-mm-ddThh:mm:ss (default: now, UTC). |
| invoice_id * | integer | The invoice's InvoiceDBID. |
{
"name": "kashflow_add_invoice_note",
"title": "Add invoice note",
"description": "WRITE: add a note to a sales invoice, by its InvoiceDBID (the numeric id in invoice replies). Existing notes and the invoice are not changed. SOAP InsertInvoiceNote.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"invoice_id",
"note"
],
"properties": {
"note": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "The note text."
},
"note_date": {
"type": "string",
"description": "Note date, yyyy-mm-dd or yyyy-mm-ddThh:mm:ss (default: now, UTC)."
},
"invoice_id": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"description": "The invoice's InvoiceDBID."
}
}
},
"annotations": {
"title": "Add invoice note",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}All sales quotes (same shape as invoices), paged here. SOAP GetQuotes.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | How many records to return (default 100, max 500). |
| offset | integer | How many records to skip (default 0), to get the next page. |
{
"name": "kashflow_list_quotes",
"title": "List quotes",
"description": "All sales quotes (same shape as invoices), paged here. SOAP GetQuotes.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many records to return (default 100, max 500)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "How many records to skip (default 0), to get the next page."
}
}
},
"annotations": {
"title": "List quotes",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One purchase (supplier invoice / receipt) by its receipt number: supplier, dates, lines, net, VAT, amount paid. SOAP GetReceipt.
| Parameter | Type | Description |
|---|---|---|
| receipt_number * | integer | The purchase (receipt) number. |
{
"name": "kashflow_get_receipt",
"title": "Get purchase by number",
"description": "One purchase (supplier invoice / receipt) by its receipt number: supplier, dates, lines, net, VAT, amount paid. SOAP GetReceipt.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"receipt_number"
],
"properties": {
"receipt_number": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"description": "The purchase (receipt) number."
}
}
},
"annotations": {
"title": "Get purchase by number",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The most recently created purchases (supplier invoices / receipts). SOAP GetReceipts_Recent.
| Parameter | Type | Description |
|---|---|---|
| count | integer | How many purchases (default 20, max 500). |
{
"name": "kashflow_list_recent_receipts",
"title": "List recent purchases",
"description": "The most recently created purchases (supplier invoices / receipts). SOAP GetReceipts_Recent.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"count": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many purchases (default 20, max 500)."
}
}
},
"annotations": {
"title": "List recent purchases",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}All purchases (supplier invoices / receipts) of one supplier, by numeric SupplierID (see kashflow_get_supplier), paged here. SOAP GetReceiptsForSupplier.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | How many records to return (default 100, max 500). |
| offset | integer | How many records to skip (default 0), to get the next page. |
| supplier_id * | integer | The numeric SupplierID. |
{
"name": "kashflow_list_supplier_receipts",
"title": "List a supplier's purchases",
"description": "All purchases (supplier invoices / receipts) of one supplier, by numeric SupplierID (see kashflow_get_supplier), paged here. SOAP GetReceiptsForSupplier.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"supplier_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many records to return (default 100, max 500)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "How many records to skip (default 0), to get the next page."
},
"supplier_id": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"description": "The numeric SupplierID."
}
}
},
"annotations": {
"title": "List a supplier's purchases",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The product catalogue (name, code, description, price, stock level), paged here. SOAP GetProducts.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | How many records to return (default 100, max 500). |
| offset | integer | How many records to skip (default 0), to get the next page. |
{
"name": "kashflow_list_products",
"title": "List products",
"description": "The product catalogue (name, code, description, price, stock level), paged here. SOAP GetProducts.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many records to return (default 100, max 500)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "How many records to skip (default 0), to get the next page."
}
}
},
"annotations": {
"title": "List products",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The bank accounts (AccountID, name, nominal code). SOAP GetBankAccounts.
No parameters.
{
"name": "kashflow_list_bank_accounts",
"title": "List bank accounts",
"description": "The bank accounts (AccountID, name, nominal code). SOAP GetBankAccounts.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "List bank accounts",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The transactions of one bank account (date, money in/out, VAT, type, comment, customer/supplier), by AccountID from kashflow_list_bank_accounts, paged here. SOAP GetBankTransactions.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | How many records to return (default 100, max 500). |
| offset | integer | How many records to skip (default 0), to get the next page. |
| account_id * | integer | The bank account's AccountID. |
{
"name": "kashflow_list_bank_transactions",
"title": "List bank transactions",
"description": "The transactions of one bank account (date, money in/out, VAT, type, comment, customer/supplier), by AccountID from kashflow_list_bank_accounts, paged here. SOAP GetBankTransactions.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"account_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many records to return (default 100, max 500)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "How many records to skip (default 0), to get the next page."
},
"account_id": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"description": "The bank account's AccountID."
}
}
},
"annotations": {
"title": "List bank transactions",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The balance of one bank account on a date (default today). SOAP GetBankBalance.
| Parameter | Type | Description |
|---|---|---|
| date | string | Balance date, yyyy-mm-dd (default today, UTC). |
| account_id * | integer | The bank account's AccountID. |
{
"name": "kashflow_get_bank_balance",
"title": "Get bank balance",
"description": "The balance of one bank account on a date (default today). SOAP GetBankBalance.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"account_id"
],
"properties": {
"date": {
"type": "string",
"description": "Balance date, yyyy-mm-dd (default today, UTC)."
},
"account_id": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"description": "The bank account's AccountID."
}
}
},
"annotations": {
"title": "Get bank balance",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The chart of accounts: nominal codes with their names. SOAP GetNominalCodes.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | How many records to return (default 100, max 500). |
| offset | integer | How many records to skip (default 0), to get the next page. |
{
"name": "kashflow_list_nominal_codes",
"title": "List nominal codes",
"description": "The chart of accounts: nominal codes with their names. SOAP GetNominalCodes.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many records to return (default 100, max 500)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "How many records to skip (default 0), to get the next page."
}
}
},
"annotations": {
"title": "List nominal codes",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The VAT rates set up in the account. SOAP GetVATRates.
No parameters.
{
"name": "kashflow_list_vat_rates",
"title": "List VAT rates",
"description": "The VAT rates set up in the account. SOAP GetVATRates.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "List VAT rates",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The projects defined in the account (id, name). SOAP GetProjects.
No parameters.
{
"name": "kashflow_list_projects",
"title": "List projects",
"description": "The projects defined in the account (id, name). SOAP GetProjects.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "List projects",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The profit and loss report for a date range: turnover, cost of sales, gross profit, expenses and net profit, with the lines of each section. SOAP GetProfitAndLoss.
| Parameter | Type | Description |
|---|---|---|
| end_date * | string | End of the period, yyyy-mm-dd. |
| start_date * | string | Start of the period, yyyy-mm-dd. |
{
"name": "kashflow_get_profit_and_loss",
"title": "Get profit and loss",
"description": "The profit and loss report for a date range: turnover, cost of sales, gross profit, expenses and net profit, with the lines of each section. SOAP GetProfitAndLoss.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"start_date",
"end_date"
],
"properties": {
"end_date": {
"type": "string",
"description": "End of the period, yyyy-mm-dd."
},
"start_date": {
"type": "string",
"description": "Start of the period, yyyy-mm-dd."
}
}
},
"annotations": {
"title": "Get profit and loss",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The balance sheet at a date (default today): fixed assets, current assets, current liabilities, capital and reserves with the lines of each. SOAP GetBalanceSheet.
| Parameter | Type | Description |
|---|---|---|
| date | string | Balance sheet date, yyyy-mm-dd (default today, UTC). |
{
"name": "kashflow_get_balance_sheet",
"title": "Get balance sheet",
"description": "The balance sheet at a date (default today): fixed assets, current assets, current liabilities, capital and reserves with the lines of each. SOAP GetBalanceSheet.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"date": {
"type": "string",
"description": "Balance sheet date, yyyy-mm-dd (default today, UTC)."
}
}
},
"annotations": {
"title": "Get balance sheet",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The trial balance for a date range: every nominal code with debit, credit and balance. SOAP GetTrialBalance.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | How many records to return (default 100, max 500). |
| offset | integer | How many records to skip (default 0), to get the next page. |
| end_date * | string | End of the period, yyyy-mm-dd. |
| start_date * | string | Start of the period, yyyy-mm-dd. |
{
"name": "kashflow_get_trial_balance",
"title": "Get trial balance",
"description": "The trial balance for a date range: every nominal code with debit, credit and balance. SOAP GetTrialBalance.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"start_date",
"end_date"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many records to return (default 100, max 500)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "How many records to skip (default 0), to get the next page."
},
"end_date": {
"type": "string",
"description": "End of the period, yyyy-mm-dd."
},
"start_date": {
"type": "string",
"description": "Start of the period, yyyy-mm-dd."
}
}
},
"annotations": {
"title": "Get trial balance",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Who owes you money at a date (default today), aged into current, three periods and older, per customer. SOAP GetAgedDebtors.
| Parameter | Type | Description |
|---|---|---|
| date | string | Report date, yyyy-mm-dd (default today, UTC). |
| limit | integer | How many records to return (default 100, max 500). |
| offset | integer | How many records to skip (default 0), to get the next page. |
{
"name": "kashflow_get_aged_debtors",
"title": "Get aged debtors",
"description": "Who owes you money at a date (default today), aged into current, three periods and older, per customer. SOAP GetAgedDebtors.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"date": {
"type": "string",
"description": "Report date, yyyy-mm-dd (default today, UTC)."
},
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many records to return (default 100, max 500)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "How many records to skip (default 0), to get the next page."
}
}
},
"annotations": {
"title": "Get aged debtors",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Who you owe money to at a date (default today), aged into current, three periods and older, per supplier. SOAP GetAgedCreditors.
| Parameter | Type | Description |
|---|---|---|
| date | string | Report date, yyyy-mm-dd (default today, UTC). |
| limit | integer | How many records to return (default 100, max 500). |
| offset | integer | How many records to skip (default 0), to get the next page. |
{
"name": "kashflow_get_aged_creditors",
"title": "Get aged creditors",
"description": "Who you owe money to at a date (default today), aged into current, three periods and older, per supplier. SOAP GetAgedCreditors.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"date": {
"type": "string",
"description": "Report date, yyyy-mm-dd (default today, UTC)."
},
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many records to return (default 100, max 500)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "How many records to skip (default 0), to get the next page."
}
}
},
"annotations": {
"title": "Get aged creditors",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The VAT return figures (boxes 1 to 9) for a period, and whether it was submitted to HMRC. SOAP GetVATReport.
| Parameter | Type | Description |
|---|---|---|
| end_date * | string | End of the VAT period, yyyy-mm-dd. |
| start_date * | string | Start of the VAT period, yyyy-mm-dd. |
{
"name": "kashflow_get_vat_report",
"title": "Get VAT report",
"description": "The VAT return figures (boxes 1 to 9) for a period, and whether it was submitted to HMRC. SOAP GetVATReport.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"start_date",
"end_date"
],
"properties": {
"end_date": {
"type": "string",
"description": "End of the VAT period, yyyy-mm-dd."
},
"start_date": {
"type": "string",
"description": "Start of the VAT period, yyyy-mm-dd."
}
}
},
"annotations": {
"title": "Get VAT report",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Key figures for a date range (income, expenses, profit and similar, as name/value pairs). SOAP GetKPIs.
| Parameter | Type | Description |
|---|---|---|
| end_date * | string | End of the period, yyyy-mm-dd. |
| start_date * | string | Start of the period, yyyy-mm-dd. |
| exclude_vat | boolean | Leave VAT out of the figures (default false). |
| exclude_same_day_payments | boolean | Leave out invoices paid the day they were issued (default false). |
{
"name": "kashflow_get_kpis",
"title": "Get KPIs",
"description": "Key figures for a date range (income, expenses, profit and similar, as name/value pairs). SOAP GetKPIs.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"start_date",
"end_date"
],
"properties": {
"end_date": {
"type": "string",
"description": "End of the period, yyyy-mm-dd."
},
"start_date": {
"type": "string",
"description": "Start of the period, yyyy-mm-dd."
},
"exclude_vat": {
"type": "boolean",
"description": "Leave VAT out of the figures (default false)."
},
"exclude_same_day_payments": {
"type": "boolean",
"description": "Leave out invoices paid the day they were issued (default false)."
}
}
},
"annotations": {
"title": "Get KPIs",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Tools for KashFlow, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Which sales invoices are overdue, and how much is outstanding in total?"; "Show my profit and loss for the last tax year."; "What does Acme Ltd owe me, and which invoices are still unpaid?". Read-only tools never change data; ask the user before a tool that creates, changes or deletes KashFlow data. Free plan: 50 tool calls per month. Run kashflow_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run kashflow_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run kashflow_upgrade without a plan: it returns both plans, each with a payment link for the user to open. kashflow_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
| telephone | string |
| tax_region | string | VAT classification of the customer: uk (default, domestic), eu (EC customer) or outside_eu. Set it for customers outside the UK. |
| vat_number | string |
| country_code | string | Two-letter ISO country code, e.g. GB. |
| country_name | string | Country name, e.g. United Kingdom. |
| payment_terms_days | integer | Payment terms in days. |
{
"name": "kashflow_create_customer",
"title": "Create customer",
"description": "WRITE: create a new customer. The code must be unique (KashFlow refuses a code that exists) and nothing existing is changed. Returns the new CustomerID. SOAP InsertCustomer.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"code",
"name"
],
"properties": {
"code": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "A unique customer code, e.g. ACME01."
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The customer / company name."
},
"email": {
"type": "string",
"maxLength": 254
},
"notes": {
"type": "string",
"maxLength": 5000
},
"mobile": {
"type": "string",
"maxLength": 50
},
"contact": {
"type": "string",
"maxLength": 200,
"description": "Contact person."
},
"website": {
"type": "string",
"maxLength": 200
},
"address1": {
"type": "string",
"maxLength": 200
},
"address2": {
"type": "string",
"maxLength": 200
},
"address3": {
"type": "string",
"maxLength": 200
},
"address4": {
"type": "string",
"maxLength": 200
},
"postcode": {
"type": "string",
"maxLength": 20
},
"telephone": {
"type": "string",
"maxLength": 50
},
"tax_region": {
"enum": [
"uk",
"eu",
"outside_eu"
],
"type": "string",
"description": "VAT classification of the customer: uk (default, domestic), eu (EC customer) or outside_eu. Set it for customers outside the UK."
},
"vat_number": {
"type": "string",
"maxLength": 50
},
"country_code": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "Two-letter ISO country code, e.g. GB."
},
"country_name": {
"type": "string",
"maxLength": 100,
"description": "Country name, e.g. United Kingdom."
},
"payment_terms_days": {
"type": "integer",
"maximum": 3650,
"minimum": 0,
"description": "Payment terms in days."
}
}
},
"annotations": {
"title": "Create customer",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}| telephone | string |
| vat_number | string |
| eu_supplier | boolean | True for a supplier in another EU country (EC supplier). Default false (UK). |
| payment_terms_days | integer | Payment terms in days. |
{
"name": "kashflow_create_supplier",
"title": "Create supplier",
"description": "WRITE: create a new supplier. The code must be unique (KashFlow refuses a code that exists) and nothing existing is changed. Returns the new SupplierID. SOAP InsertSupplier.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"code",
"name"
],
"properties": {
"code": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "A unique supplier code, e.g. OFFICE01."
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The supplier / company name."
},
"email": {
"type": "string",
"maxLength": 254
},
"notes": {
"type": "string",
"maxLength": 5000
},
"mobile": {
"type": "string",
"maxLength": 50
},
"contact": {
"type": "string",
"maxLength": 200,
"description": "Contact person."
},
"website": {
"type": "string",
"maxLength": 200
},
"address1": {
"type": "string",
"maxLength": 200
},
"address2": {
"type": "string",
"maxLength": 200
},
"address3": {
"type": "string",
"maxLength": 200
},
"address4": {
"type": "string",
"maxLength": 200
},
"postcode": {
"type": "string",
"maxLength": 20
},
"telephone": {
"type": "string",
"maxLength": 50
},
"vat_number": {
"type": "string",
"maxLength": 50
},
"eu_supplier": {
"type": "boolean",
"description": "True for a supplier in another EU country (EC supplier). Default false (UK)."
},
"payment_terms_days": {
"type": "integer",
"maximum": 3650,
"minimum": 0,
"description": "Payment terms in days."
}
}
},
"annotations": {
"title": "Create supplier",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}