Akce

Jak najít akci, zjistit její vstup a spustit ji. Formát požadavků a odpovědí.

Akce je jedna operace v Moniary, třeba „vypsat štítky“ nebo „vystavit fakturu“. Její název má tvar oblast.metoda, například tags.getAll nebo issuedInvoices.issueInvoice.

Vyhledání akce

curl "https://moniary.com/api/v1/actions?q=invoice" \
  -H "Authorization: Bearer $MONIARY_API_KEY"

Dostanete seznam akcí, které váš API klíč může spustit. Filtrovat můžete textem (q) nebo oblastí (area, například area=bankTransactions). Názvy a popisy akcí jsou anglicky.

{
  "actions": [
    {
      "name": "invoices.getInvoiceStats",
      "area": "invoices",
      "access": "read",
      "description": "Totals and counts of documents for an optional filter (amounts, paid/unpaid, overdue)."
    }
  ]
}

Pole access má hodnotu read, write nebo confirm. Akce write i confirm potřebují API klíč s přístupem Čtení a zápis. confirm označuje větší změny, které mají dopad mimo Moniary, například odeslání faktury.

Vstup akce

curl https://moniary.com/api/v1/actions/invoices.getInvoiceStats \
  -H "Authorization: Bearer $MONIARY_API_KEY"

V odpovědi je pole input se schématem vstupu ve formátu JSON Schema (draft 2020-12). Akce bez vstupu mají input: null. Datum a čas posílejte jako text ve formátu ISO 8601 (2026-10-01 nebo 2026-10-01T08:00:00Z).

Spuštění akce

Vstup pošlete v těle požadavku jako JSON objekt. Když jsou všechna pole nepovinná, tělo můžete vynechat.

curl -X POST https://moniary.com/api/v1/actions/tags.create \
  -H "Authorization: Bearer $MONIARY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Pohonné hmoty", "color": "#3b82f6"}'

Výsledek najdete vždy v poli data:

{
  "data": {
    "id": "er48wdjdsd3zacfkye1vgmgb",
    "name": "Pohonné hmoty",
    "color": "#3b82f6"
  }
}

Příklady

Nezaplacené přijaté doklady po splatnosti:

curl -X POST https://moniary.com/api/v1/actions/invoices.getOverdueInvoices \
  -H "Authorization: Bearer $MONIARY_API_KEY"

Nespárované bankovní transakce:

curl -X POST https://moniary.com/api/v1/actions/bankTransactions.list \
  -H "Authorization: Bearer $MONIARY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"matchStatus": ["UNMATCHED"], "pageSize": 20}'

Přesný vstup každé akce najdete v Referenční příručce nebo přes GET /actions/<název>.

Stránkování

Seznamy se stránkují stejně jako v aplikaci. Některé akce berou page a pageSize, jiné limit a cursor. Vždy se řiďte schématem vstupu konkrétní akce.