Merit Aktiva MCP by usefulapi

List sales invoices (header level: number, customer, dates, totals, paid flag) of a period. The period may span at most 3 months (Merit limit); for longer spans make several calls. Use merit_get_sales_invoice for the lines. POST /api/v2/getinvoices.

{
  "type": "object",
  "properties": {
    "period_start": {
      "type": "string",
      "description": "First day of the period, yyyy-mm-dd."
    },
    "period_end": {
      "type": "string",
      "description": "Last day of the period, yyyy-mm-dd (max 3 months after the start)."
    },
    "unpaid_only": {
      "description": "true = only unpaid invoices.",
      "type": "boolean"
    },
    "date_type": {
      "description": "Which date the period filters: 0 = document date (default), 1 = date of last change.",
      "anyOf": [
        {
          "type": "number",
          "const": 0
        },
        {
          "type": "number",
          "const": 1
        }
      ]
    },
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "required": [
    "period_start",
    "period_end"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Find sales invoices by invoice number, customer name or customer id (give at least one). POST /api/v2/getinvoices2.

{
  "type": "object",
  "properties": {
    "invoice_no": {
      "description": "Invoice number.",
      "type": "string",
      "minLength": 1,
      "maxLength": 35
    },
    "customer_name": {
      "description": "Customer name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 150
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Customer id (from merit_list_customers)."
    },
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One sales invoice in full: header, lines (items, quantities, VAT, accounts), payments and dimension allocations. The PDF attachment is never requested. POST /api/v2/getinvoice.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Invoice id (SIHId from merit_list_sales_invoices)."
    }
  },
  "required": [
    "id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List purchase invoices (vendor bills) of a period: bill number, vendor, dates, totals, paid flag. The period may span at most 3 months (Merit limit); for longer spans make several calls. POST /api/v2/getpurchorders.

{
  "type": "object",
  "properties": {
    "period_start": {
      "type": "string",
      "description": "First day of the period, yyyy-mm-dd."
    },
    "period_end": {
      "type": "string",
      "description": "Last day of the period, yyyy-mm-dd (max 3 months after the start)."
    },
    "unpaid_only": {
      "description": "true = only unpaid bills.",
      "type": "boolean"
    },
    "date_type": {
      "description": "Which date the period filters: 0 = document date (default), 1 = date of last change.",
      "anyOf": [
        {
          "type": "number",
          "const": 0
        },
        {
          "type": "number",
          "const": 1
        }
      ]
    },
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "required": [
    "period_start",
    "period_end"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One purchase invoice in full: header, lines, payments. The attachment is never requested. POST /api/v2/getpurchorder.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Purchase invoice id (PIHId from merit_list_purchase_invoices)."
    }
  },
  "required": [
    "id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Search customers by name (partial match), registry number or VAT number (exact), id, or changed since a date. At least one filter is required: Merit cannot return the whole customer list in one reply. POST /api/v1/getcustomers.

{
  "type": "object",
  "properties": {
    "name": {
      "description": "Part of the customer name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 150
    },
    "reg_no": {
      "description": "Registry number, exact.",
      "type": "string",
      "minLength": 1,
      "maxLength": 30
    },
    "vat_reg_no": {
      "description": "VAT number, exact.",
      "type": "string",
      "minLength": 1,
      "maxLength": 30
    },
    "id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Customer id."
    },
    "changed_since": {
      "type": "string",
      "description": "Only customers created or changed on or after this date."
    },
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Search vendors (suppliers) by name (partial match), registry number or VAT number (exact), id, or changed since a date. At least one filter is required: Merit cannot return the whole vendor list in one reply. POST /api/v1/getvendors.

{
  "type": "object",
  "properties": {
    "name": {
      "description": "Part of the vendor name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 150
    },
    "reg_no": {
      "description": "Registry number, exact.",
      "type": "string",
      "minLength": 1,
      "maxLength": 30
    },
    "vat_reg_no": {
      "description": "VAT number, exact.",
      "type": "string",
      "minLength": 1,
      "maxLength": 30
    },
    "id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Vendor id."
    },
    "changed_since": {
      "type": "string",
      "description": "Only vendors created or changed on or after this date."
    },
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List items, services and stock articles with price, unit, VAT and accounts. Optional filters: code or description (partial), type, id. With location_code the reply adds stock quantity and cost of that warehouse. POST /api/v1/getitems.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Item id."
    },
    "code": {
      "description": "Part of the item code.",
      "type": "string",
      "minLength": 1,
      "maxLength": 20
    },
    "description": {
      "description": "Part of the item description.",
      "type": "string",
      "minLength": 1,
      "maxLength": 150
    },
    "type": {
      "description": "1 = stock item, 2 = service, 3 = item.",
      "anyOf": [
        {
          "type": "number",
          "const": 1
        },
        {
          "type": "number",
          "const": 2
        },
        {
          "type": "number",
          "const": 3
        }
      ]
    },
    "location_code": {
      "description": "Warehouse code: adds goods on hand quantity and cost.",
      "type": "string",
      "minLength": 1,
      "maxLength": 20
    },
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

The general ledger chart of accounts (code, names, VAT, parent flag, active flag). GET /api/v2/accounts.

{
  "type": "object",
  "properties": {
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

All VAT rates of the company (TaxId, code, name, percent, active flag). The TaxId is what invoice rows refer to. GET /api/v2/taxes.

{
  "type": "object",
  "properties": {
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Departments (code, name, active flag). GET /api/v2/departments.

{
  "type": "object",
  "properties": {
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

The company's bank and cash accounts (BankId, name, IBAN, currency, ledger account). BankId feeds the payment tools. GET /api/v2/banks.

{
  "type": "object",
  "properties": {
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Accounting periods (financial years) with start, end and active flag. POST /api/v2/getaccperiods.

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

Accounting dimensions and their values (DimId, name, value code, expiry). all_values = true also lists expired values. POST /api/v2/getdimensions.

{
  "type": "object",
  "properties": {
    "all_values": {
      "description": "true = include expired dimension values (default false).",
      "type": "boolean"
    },
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Payment methods and sources (cash, banks, reporting entities, ledger accounts) usable for purchases, expense reports or sales. POST /api/v2/getpaymenttypes.

{
  "type": "object",
  "properties": {
    "type": {
      "description": "1 = purchases, 2 = expense reports, 3 = sales.",
      "anyOf": [
        {
          "type": "number",
          "const": 1
        },
        {
          "type": "number",
          "const": 2
        },
        {
          "type": "number",
          "const": 3
        }
      ]
    },
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List payments (customer and vendor receipts and payouts) of a period, with the documents they paid. The period may span at most 3 months (Merit limit); for longer spans make several calls. POST /api/v2/getpayments.

{
  "type": "object",
  "properties": {
    "period_start": {
      "type": "string",
      "description": "First day of the period, yyyy-mm-dd."
    },
    "period_end": {
      "type": "string",
      "description": "Last day of the period, yyyy-mm-dd (max 3 months after the start)."
    },
    "bank_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Only this bank account (BankId from merit_list_banks)."
    },
    "payment_type": {
      "description": "Merit payment type filter (see merit_list_payment_types).",
      "type": "integer",
      "minimum": 0,
      "maximum": 20
    },
    "date_type": {
      "description": "Which date the period filters: 0 = document date (default), 1 = date of last change.",
      "anyOf": [
        {
          "type": "number",
          "const": 0
        },
        {
          "type": "number",
          "const": 1
        }
      ]
    },
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "required": [
    "period_start",
    "period_end"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List the income payments (money received) or expense payments (money paid out) booked on one bank account for a document-date period, with the documents each paid. The period may span at most 3 months (Merit limit); for longer spans make several calls. GET /api/v2/Banks/{bankId}/IncomePayments or /ExpensePayments.

{
  "type": "object",
  "properties": {
    "bank_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "BankId from merit_list_banks."
    },
    "direction": {
      "type": "string",
      "enum": [
        "income",
        "expense"
      ],
      "description": "income = payments received, expense = payments made."
    },
    "doc_date_from": {
      "type": "string",
      "description": "Document date from, yyyy-mm-dd."
    },
    "doc_date_to": {
      "type": "string",
      "description": "Document date to, yyyy-mm-dd (max 3 months after doc_date_from)."
    },
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "required": [
    "bank_id",
    "direction",
    "doc_date_from",
    "doc_date_to"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List general ledger batches (journal entries, also those created from invoices and payments) of a period: batch code, number, date, total. The period may span at most 3 months (Merit limit); for longer spans make several calls. POST /api/v1/getglbatches.

{
  "type": "object",
  "properties": {
    "period_start": {
      "type": "string",
      "description": "First day of the period, yyyy-mm-dd."
    },
    "period_end": {
      "type": "string",
      "description": "Last day of the period, yyyy-mm-dd (max 3 months after the start)."
    },
    "date_type": {
      "description": "Which date the period filters: 0 = document date (default), 1 = date of last change.",
      "anyOf": [
        {
          "type": "number",
          "const": 0
        },
        {
          "type": "number",
          "const": 1
        }
      ]
    },
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "required": [
    "period_start",
    "period_end"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One general ledger batch with all its debit and credit lines (account, memo, department, tax, amounts). The attachment is never requested. POST /api/v1/getglbatch.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Batch id (GLBId from merit_list_gl_batches)."
    }
  },
  "required": [
    "id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Open customer receivables: for each unpaid document the customer, date, due date, total, paid and unpaid amount. Give a customer name (empty string = all customers) or a customer id; over_due_days keeps only documents overdue by at least that many days. POST /api/v1/getcustdebtrep.

{
  "type": "object",
  "properties": {
    "customer_name": {
      "description": "Customer name; an empty string or omitting it with no customer_id selects ALL customers.",
      "type": "string",
      "maxLength": 150
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Customer id."
    },
    "over_due_days": {
      "description": "Only documents overdue by at least this many days.",
      "type": "integer",
      "minimum": 0,
      "maximum": 999
    },
    "as_of": {
      "type": "string",
      "description": "Debt as of this date (default today)."
    },
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Customer invoices with their unpaid amount and overdue flag for a period, for one customer (name or id). Only the FIRST page is returned: if has_more is true, narrow the period or the customer (the continuation endpoint is not supported). POST /api/v2/getcustpaymrep.

{
  "type": "object",
  "properties": {
    "customer_name": {
      "description": "Customer name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 150
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Customer id."
    },
    "period_start": {
      "type": "string",
      "description": "Period start, yyyy-mm-dd."
    },
    "period_end": {
      "type": "string",
      "description": "Period end, yyyy-mm-dd."
    },
    "currency_code": {
      "description": "Currency, e.g. EUR.",
      "type": "string",
      "minLength": 3,
      "maxLength": 4
    }
  },
  "required": [
    "period_start",
    "period_end"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

The profit and loss report: one row per report line, with balances for per_count months counting back from end_date (newest first). Optional department filter. POST /api/v1/getprofitrep.

{
  "type": "object",
  "properties": {
    "end_date": {
      "type": "string",
      "description": "Last day of the newest month, yyyy-mm-dd."
    },
    "per_count": {
      "description": "Number of monthly periods, counting back from end_date (default 1).",
      "type": "integer",
      "minimum": 1,
      "maximum": 36
    },
    "department_code": {
      "description": "Only this department (code from merit_list_departments).",
      "type": "string",
      "maxLength": 20
    }
  },
  "required": [
    "end_date"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

The balance sheet: one row per report line (assets, liabilities, equity) with balances for per_count months counting back from end_date. POST /api/v1/getbalancerep.

{
  "type": "object",
  "properties": {
    "end_date": {
      "type": "string",
      "description": "Balance date, yyyy-mm-dd."
    },
    "per_count": {
      "description": "Number of monthly periods, counting back from end_date (default 1).",
      "type": "integer",
      "minimum": 1,
      "maximum": 36
    }
  },
  "required": [
    "end_date"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Sales totals for a period, grouped by invoice, customer, item or country. POST /api/v2/getsalesrep.

{
  "type": "object",
  "properties": {
    "start_date": {
      "type": "string",
      "description": "Period start, yyyy-mm-dd."
    },
    "end_date": {
      "type": "string",
      "description": "Period end, yyyy-mm-dd."
    },
    "report_type": {
      "anyOf": [
        {
          "type": "number",
          "const": 1
        },
        {
          "type": "number",
          "const": 2
        },
        {
          "type": "number",
          "const": 3
        },
        {
          "type": "number",
          "const": 4
        },
        {
          "type": "number",
          "const": 5
        }
      ],
      "description": "1 = by invoices, 2 = by customers, 3 = by items, 4 = by countries, 5 = by countries (general)."
    },
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "required": [
    "start_date",
    "end_date",
    "report_type"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Purchase totals for a period, grouped by invoice, vendor, item or fixed asset. POST /api/v2/getpurchrep.

{
  "type": "object",
  "properties": {
    "start_date": {
      "type": "string",
      "description": "Period start, yyyy-mm-dd."
    },
    "end_date": {
      "type": "string",
      "description": "Period end, yyyy-mm-dd."
    },
    "report_type": {
      "anyOf": [
        {
          "type": "number",
          "const": 1
        },
        {
          "type": "number",
          "const": 2
        },
        {
          "type": "number",
          "const": 3
        },
        {
          "type": "number",
          "const": 4
        }
      ],
      "description": "1 = by invoices, 2 = by vendors, 3 = by items, 4 = by fixed assets."
    },
    "max_results": {
      "description": "Show at most this many rows (default 100, max 1000); the reply says how many there are in total.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "required": [
    "start_date",
    "end_date",
    "report_type"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

WRITE: creates ONE new customer record in the Merit company (name must be unique; an existing customer is never overwritten, Merit answers with an error). Nothing is invoiced, sent or paid. In Estonia not_td_customer must be true for private persons and foreign companies; city is required in Estonia for a non-EE country. Returns the new customer id. POST /api/v2/sendcustomer.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 150,
      "description": "Customer name (unique in the company)."
    },
    "country_code": {
      "type": "string",
      "pattern": "^[A-Za-z]{2}$",
      "description": "2-letter ISO country code, e.g. EE, PL."
    },
    "not_td_customer": {
      "type": "boolean",
      "description": "true for private persons and foreign companies (Estonia), true for private persons (Poland); false for a local company."
    },
    "reg_no": {
      "description": "Registry or personal id code.",
      "type": "string",
      "maxLength": 30
    },
    "vat_reg_no": {
      "description": "VAT number.",
      "type": "string",
      "maxLength": 30
    },
    "currency_code": {
      "description": "Default currency, e.g. EUR.",
      "type": "string",
      "minLength": 3,
      "maxLength": 4
    },
    "payment_deadline_days": {
      "description": "Payment term in days (default from company settings).",
      "type": "integer",
      "minimum": 0,
      "maximum": 365
    },
    "address": {
      "description": "Street address.",
      "type": "string",
      "maxLength": 100
    },
    "city": {
      "description": "City.",
      "type": "string",
      "maxLength": 30
    },
    "county": {
      "description": "County.",
      "type": "string",
      "maxLength": 100
    },
    "postal_code": {
      "description": "Postal code.",
      "type": "string",
      "maxLength": 15
    },
    "phone_no": {
      "description": "Phone number.",
      "type": "string",
      "maxLength": 50
    },
    "email": {
      "description": "E-mail address (stored only; Merit sends nothing).",
      "type": "string",
      "maxLength": 80,
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
    },
    "home_page": {
      "description": "Web page.",
      "type": "string",
      "maxLength": 80
    },
    "sales_invoice_language": {
      "description": "Invoice language for this customer (Estonia: ET, EN, RU, FI; Poland: PL, EN, RU).",
      "type": "string",
      "enum": [
        "ET",
        "EN",
        "RU",
        "FI",
        "PL"
      ]
    },
    "contact": {
      "description": "Contact person.",
      "type": "string",
      "maxLength": 35
    },
    "bank_account": {
      "description": "Customer bank account (IBAN).",
      "type": "string",
      "maxLength": 50
    }
  },
  "required": [
    "name",
    "country_code",
    "not_td_customer"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}