cashctrl_create_journal_entry

WRITE: changes the accounting records. Makes one request that is never repeated; check the result before trying again. Creates a manual book entry in the journal. Either a simple entry (debit_account_id, credit_account_id, amount) or a collective entry (items, whose debit and credit sums must match). POST /journal/create.json.

destructive

Argument	Type	Description
date	string	Booking date, yyyy-mm-dd (CashCtrl uses today when omitted).
items	array	Lines of a collective entry. Use it instead of debit_account_id, credit_account_id and amount.
title*	string	Description of the entry (max 250 characters).
amount	number	Amount of a simple entry, for example 125.50.
tax_id	integer	Tax code id of a simple entry (cashctrl_list_tax_codes).
reference	string	Receipt or reference text (max 100).
associate_id	integer	The person this entry belongs to (cashctrl_list_persons).
debit_account_id	integer	Debit account id (cashctrl_list_accounts). For a simple entry.
credit_account_id	integer	Credit account id (cashctrl_list_accounts). For a simple entry.
sequence_number_id	integer	Sequence number that generates the reference (cashctrl_list_sequence_numbers).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "title"
  ],
  "properties": {
    "date": {
      "type": "string",
      "description": "Booking date, yyyy-mm-dd (CashCtrl uses today when omitted)."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "account_id"
        ],
        "properties": {
          "debit": {
            "type": "number",
            "maximum": 1000000000000,
            "description": "Amount on the debit side; give debit or credit.",
            "exclusiveMinimum": 0
          },
          "credit": {
            "type": "number",
            "maximum": 1000000000000,
            "description": "Amount on the credit side; give debit or credit.",
            "exclusiveMinimum": 0
          },
          "tax_id": {
            "type": "integer",
            "maximum": 9007199254740991,
            "description": "Tax code id (cashctrl_list_tax_codes).",
            "exclusiveMinimum": 0
          },
          "account_id": {
            "type": "integer",
            "maximum": 9007199254740991,
            "description": "Account id.",
            "exclusiveMinimum": 0
          },
          "description": {
            "type": "string",
            "maxLength": 250,
            "description": "Description of this line."
          }
        }
      },
      "maxItems": 100,
      "minItems": 2,
      "description": "Lines of a collective entry. Use it instead of debit_account_id, credit_account_id and amount."
    },
    "title": {
      "type": "string",
      "maxLength": 250,
      "minLength": 1,
      "description": "Description of the entry (max 250 characters)."
    },
    "amount": {
      "type": "number",
      "maximum": 1000000000000,
      "description": "Amount of a simple entry, for example 125.50.",
      "exclusiveMinimum": 0
    },
    "tax_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Tax code id of a simple entry (cashctrl_list_tax_codes).",
      "exclusiveMinimum": 0
    },
    "reference": {
      "type": "string",
      "maxLength": 100,
      "description": "Receipt or reference text (max 100)."
    },
    "associate_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The person this entry belongs to (cashctrl_list_persons).",
      "exclusiveMinimum": 0
    },
    "debit_account_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Debit account id (cashctrl_list_accounts). For a simple entry.",
      "exclusiveMinimum": 0
    },
    "credit_account_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Credit account id (cashctrl_list_accounts). For a simple entry.",
      "exclusiveMinimum": 0
    },
    "sequence_number_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Sequence number that generates the reference (cashctrl_list_sequence_numbers).",
      "exclusiveMinimum": 0
    }
  }
}

cashctrl_create_order

WRITE: changes the accounting records. Makes one request that is never repeated; check the result before trying again. Creates ONE order document for ONE customer or vendor: a quote, invoice, credit note, purchase bill and so on, depending on category_id. Without status_id the first status of the category is used; a booking status (for example Open) also creates journal entries, so use a draft status unless the user asks otherwise. No e-mail is sent. POST /order/create.json.

destructive

Argument	Type	Description
nr	string	Order number. Leave empty to use the sequence number of the category.
date*	string	Document date, yyyy-mm-dd.
items*	array	1-200 order items.
due_days	integer	Days until payment is due.
language	string	Language of the document.
status_id	integer	Status id (cashctrl_list_order_categories). Default: the first status of the category.
account_id	integer	Debtors or creditors account id; default from the category.
category_id

cashctrl_create_person

WRITE: changes the accounting records. Makes one request that is never repeated; check the result before trying again. Creates a customer, vendor or other contact. Give company, first_name or last_name (at least one). Search first with cashctrl_list_persons so no duplicate is created. POST /person/create.json.

destructive

Argument	Type	Description
nr	string	Person number, for example the customer number.
company	string	Company name.
vat_uid	string	VAT number (UID), for example CHE-123.456.789 MWST.
contacts	array	E-mail addresses, phone numbers and websites.
language	string	Language of documents for this person.
addresses	array	Addresses.
is_vendor	boolean	Mark as vendor.
last_name	string	Last name.
first_name	string	First name.

cashctrl_delete_journal_entries

WRITE: changes the accounting records. Makes one request that is never repeated; check the result before trying again. DELETES manual journal entries by id (entries created by orders or salary statements cannot be deleted this way). Deleted entries are gone from the books; confirm the ids with the user first. POST /journal/delete.json.

destructive

Argument	Type	Description
ids*	array	1-20 journal entry ids.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ids"
  ],
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "description": "A journal entry id (cashctrl_list_journal).",
        "exclusiveMinimum": 0
      },
      "maxItems": 20,
      "minItems": 1,
      "description": "1-20 journal entry ids."
    }
  }
}

cashctrl_delete_orders

WRITE: changes the accounting records. Makes one request that is never repeated; check the result before trying again. DELETES orders (invoices, quotes, purchase documents) by id, with the journal entries they created. Deleted documents are gone; confirm the ids with the user first. POST /order/delete.json.

destructive

Argument	Type	Description
ids*	array	1-20 order ids.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ids"
  ],
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "description": "An order id (cashctrl_list_orders).",
        "exclusiveMinimum": 0
      },
      "maxItems": 20,
      "minItems": 1,
      "description": "1-20 order ids."
    }
  }
}

cashctrl_get_account

One account of the chart of accounts by id. GET /account/read.json.

read-only

Argument	Type	Description
id*	integer	The account id (from cashctrl_list_accounts; not the account number).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The account id (from cashctrl_list_accounts; not the account number).",
      "exclusiveMinimum": 0
    }
  }
}

cashctrl_get_account_balance

The balance of one account at the end of a day (default: the last day of the current fiscal period). GET /account/balance.

read-only

Argument	Type	Description
id*	integer	The account id (from cashctrl_list_accounts).
date	string	Balance at the end of this day, yyyy-mm-dd.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The account id (from cashctrl_list_accounts).",
      "exclusiveMinimum": 0
    },
    "date": {
      "type": "string",
      "description": "Balance at the end of this day, yyyy-mm-dd."
    }
  }
}

cashctrl_get_article

One inventory article by id. GET /inventory/article/read.json.

read-only

Argument	Type	Description
id*	integer	The article id (from cashctrl_list_articles).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The article id (from cashctrl_list_articles).",
      "exclusiveMinimum": 0
    }
  }
}

cashctrl_get_journal_entry

One book entry by id, with its items for a collective entry. GET /journal/read.json.

read-only

Argument	Type	Description
id*	integer	The journal entry id (from cashctrl_list_journal).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The journal entry id (from cashctrl_list_journal).",
      "exclusiveMinimum": 0
    }
  }
}

cashctrl_get_order

One order (invoice, quote, purchase document) by id, with its items, totals and status. GET /order/read.json.

read-only

Argument	Type	Description
id*	integer	The order id (from cashctrl_list_orders).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The order id (from cashctrl_list_orders).",
      "exclusiveMinimum": 0
    }
  }
}

cashctrl_get_person

One person or company by id, with addresses, contact data and bank accounts. GET /person/read.json.

read-only

Argument	Type	Description
id*	integer	The person id (from cashctrl_list_persons).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The person id (from cashctrl_list_persons).",
      "exclusiveMinimum": 0
    }
  }
}

cashctrl_get_report_data

The data of one report element (for example the balance sheet or the income statement) for a fiscal period or a date range. GET /report/element/data.json.

read-only

Argument	Type	Description
end_date	string	End of the period, yyyy-mm-dd.
element_id*	integer	The report element id (from cashctrl_get_report_tree).
start_date	string	Start of the period, yyyy-mm-dd.
fiscal_period_id	integer	Fiscal period id (cashctrl_list_fiscal_periods). It replaces start_date and end_date.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "element_id"
  ],
  "properties": {
    "end_date": {
      "type": "string",
      "description": "End of the period, yyyy-mm-dd."
    },
    "element_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The report element id (from cashctrl_get_report_tree).",
      "exclusiveMinimum": 0
    },
    "start_date": {
      "type": "string",
      "description": "Start of the period, yyyy-mm-dd."
    },
    "fiscal_period_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Fiscal period id (cashctrl_list_fiscal_periods). It replaces start_date and end_date.",
      "exclusiveMinimum": 0
    }
  }
}

cashctrl_get_report_tree

The reports set up in CashCtrl (balance sheet, income statement, and so on) as a tree of collections and elements. The element id is the input of cashctrl_get_report_data. GET /report/tree.json.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

cashctrl_get_salary_statement

One payroll statement by id, with its salary items. Sensitive personal data. GET /salary/statement/read.json.

read-only

Argument	Type	Description
id*	integer	The statement id (from cashctrl_list_salary_statements).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The statement id (from cashctrl_list_salary_statements).",
      "exclusiveMinimum": 0
    }
  }
}

cashctrl_list_account_categories

The categories of the chart of accounts (assets, liabilities, expenses, revenue and their sub-categories). GET /account/category/list.json.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

cashctrl_list_accounts

The chart of accounts: number, name, category and the balance for the fiscal period. Not paged. GET /account/list.json.

read-only

Argument	Type	Description
dir	string	Sort direction (each list has its own default).
sort	string	Column to sort by (a column name of the list reply; each list has its own default).
query	string	Full-text search.
filter	array	Column filters, all must match (AND).
category_id	integer	Only accounts of this category (cashctrl_list_account_categories).
only_active	boolean	Only active accounts.
fiscal_period_id	integer	Fiscal period id (cashctrl_list_fiscal_periods); default is the current period.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "dir": {
      "enum": [
        "ASC",
        "DESC"
      ],
      "type": "string",
      "description": "Sort direction (each list has its own default)."
    },
    "sort": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9_.]{0,59}$",
      "description": "Column to sort by (a column name of the list reply; each list has its own default)."
    },
    "query": {
      "type": "string",
      "maxLength": 200,
      "description": "Full-text search."
    },
    "filter": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "field",
          "value"
        ],
        "properties": {
          "field": {
            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9_.]{0,59}$",
            "description": "Column name of the list reply."
          },
          "value": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 200
              },
              {
                "type": "number"
              },
              {
                "type": "array",
                "items": {
                  "anyOf": [
                    {
                      "type": "string",
                      "maxLength": 200
                    },
                    {
                      "type": "number"
                    }
                  ]
                },
                "maxItems": 50
              }
            ],
            "description": "Value, or an array of values (any matches)."
          },
          "comparison": {
            "enum": [
              "eq",
              "like",
              "gt",
              "lt"
            ],
            "type": "string",
            "description": "Default like."
          }
        }
      },
      "maxItems": 10,
      "description": "Column filters, all must match (AND)."
    },
    "category_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only accounts of this category (cashctrl_list_account_categories).",
      "exclusiveMinimum": 0
    },
    "only_active": {
      "type": "boolean",
      "description": "Only active accounts."
    },
    "fiscal_period_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Fiscal period id (cashctrl_list_fiscal_periods); default is the current period.",
      "exclusiveMinimum": 0
    }
  }
}

cashctrl_list_articles

Inventory articles (products and services) with number, name, price, stock and accounts. GET /inventory/article/list.json.

read-only

Argument	Type	Description
dir	string	Sort direction (each list has its own default).
sort	string	Column to sort by (a column name of the list reply; each list has its own default).
limit	integer	Rows to return, 1-500 (default 100).
query	string	Full-text search.
start	integer	Index of the first row (default 0). Use next_start from the previous reply.
filter	array	Column filters, all must match (AND).
category_id	integer	Only this article category.
only_active	boolean	Only active articles.
only_restock	boolean	Only articles that need restocking.

Input schema (JSON)

cashctrl_list_bank_accounts

The bank accounts set up in CashCtrl (name, IBAN, linked ledger account). GET /account/bank/list.json.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

cashctrl_list_currencies

The currencies set up in CashCtrl with their exchange rates. GET /currency/list.json.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

cashctrl_list_fiscal_periods

All fiscal periods (id, name, start, end, current flag). The id is the fiscal_period_id of the other tools. GET /fiscalperiod/list.json.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

cashctrl_list_journal

Book entries of the journal (date, title, debit and credit account, amount, reference), newest first, for the current fiscal period unless fiscal_period_id is set. GET /journal/list.json.

read-only

Argument	Type	Description
dir	string	Sort direction (each list has its own default).
sort	string	Column to sort by (a column name of the list reply; each list has its own default).
limit	integer	Rows to return, 1-500 (default 100).
query	string	Full-text search.
start	integer	Index of the first row (default 0). Use next_start from the previous reply.
filter	array	Column filters, all must match (AND).
account_id	integer	Only entries of this account (cashctrl_list_accounts).
only_sales	boolean	Only entries created by sales orders.
only_manual	boolean

cashctrl_list_order_categories

The order categories (Quote, Invoice, Credit note, Purchase invoice and so on) with their statuses (Draft, Open, Paid) and the default accounts and sequence numbers. Use it to find category_id and status_id (type PURCHASE for purchase documents). GET /order/category/list.json.

read-only

Argument	Type	Description
type	string	SALES (default) or PURCHASE categories.
fiscal_period_id	integer	Fiscal period id (cashctrl_list_fiscal_periods); default is the current period.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "type": {
      "enum": [
        "SALES",
        "PURCHASE"
      ],
      "type": "string",
      "description": "SALES (default) or PURCHASE categories."
    },
    "fiscal_period_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Fiscal period id (cashctrl_list_fiscal_periods); default is the current period.",
      "exclusiveMinimum": 0
    }
  }
}

cashctrl_list_orders

Sales or purchase documents (quotes, order confirmations, invoices, delivery notes, credit notes, vendor bills) with number, date, customer, status and total. Newest first. GET /order/list.json.

read-only

Argument	Type	Description
dir	string	Sort direction (each list has its own default).
sort	string	Column to sort by (a column name of the list reply; each list has its own default).
type	string	SALES or PURCHASE documents.
limit	integer	Rows to return, 1-500 (default 100).
query	string	Full-text search.
start	integer	Index of the first row (default 0). Use next_start from the previous reply.
filter	array	Column filters, all must match (AND).
only_open	boolean	Only open (not completed) orders, for example unpaid invoices.
person_id	integer	Only orders of this person (cashctrl_list_persons).

cashctrl_list_persons

Customers, vendors, employees and other contacts (name, company, number, roles, addresses). GET /person/list.json.

read-only

Argument	Type	Description
dir	string	Sort direction (each list has its own default).
sort	string	Column to sort by (a column name of the list reply; each list has its own default).
limit	integer	Rows to return, 1-500 (default 100).
query	string	Full-text search.
start	integer	Index of the first row (default 0). Use next_start from the previous reply.
filter	array	Column filters, all must match (AND).
category_id	integer	Only this person category.
only_active	boolean	Only active people.
only_vendors	boolean	Only vendors.
only_customers

cashctrl_list_salary_statements

Payroll statements (employee, date, status, gross and net amounts), newest first. Sensitive personal data. GET /salary/statement/list.json.

read-only

Argument	Type	Description
dir	string	Sort direction (each list has its own default).
sort	string	Column to sort by (a column name of the list reply; each list has its own default).
limit	integer	Rows to return, 1-500 (default 100).
query	string	Full-text search.
start	integer	Index of the first row (default 0). Use next_start from the previous reply.
only_open	boolean	Only open (not yet paid) statements.
person_id	integer	Only statements of this employee (cashctrl_list_persons).
only_overdue	boolean	Only statements past their payment date.
fiscal_period_id	integer	Fiscal period id (cashctrl_list_fiscal_periods); default is the current period.

cashctrl_list_sequence_numbers

The number sequences (for journal references, order numbers, customer numbers). The id is the sequence_number_id of the write tools. GET /sequencenumber/list.json.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

cashctrl_list_tax_codes

The VAT tax codes (id, code, name, rates). The id is the tax_id of the write tools. GET /tax/list.json.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

cashctrl_update_order_status

WRITE: changes the accounting records. Makes one request that is never repeated; check the result before trying again. Sets the status of 1-20 orders (for example Draft to Open, or Open to Paid). A status can book journal entries or move stock, so the books change. POST /order/update_status.json.

destructive

Argument	Type	Description
ids*	array	1-20 order ids.
status_id*	integer	The new status id (from the statuses of the order category, cashctrl_list_order_categories).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ids",
    "status_id"
  ],
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "description": "An order id (cashctrl_list_orders).",
        "exclusiveMinimum": 0
      },
      "maxItems": 20,
      "minItems": 1,
      "description": "1-20 order ids."
    },
    "status_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The new status id (from the statuses of the order category, cashctrl_list_order_categories).",
      "exclusiveMinimum": 0
    }
  }
}

CashCtrl MCP by usefulapi

Try it

cashctrl_create_journal_entry Destructive

CashCtrl MCP by usefulapi

Try it

cashctrl_create_journal_entry Destructive

Tools (28)