Läsa
Verktyg som bara läser. Alla har readOnlyHint.
get_organization
Hämta företagsinformation. Hämtar grunduppgifter om företaget som kopplingen gäller: namn, organisationsnummer, bolagsform, momsuppgifter och räkenskapsår. Anropa det här först för att veta vilket företag och vilka räkenskapsår du arbetar med.
Indata: inga.
Returnerar: name, org_number, organization_type, vat_number, vat_registered, vat_method, vat_filing_frequency, city, books_through, fiscal_years[] (start_date, end_date, is_closed) och today (dagens datum i Stockholm).
Vilka räkenskapsår har vi, och är förra året stängt?
list_customers
Lista kunder. Listar kunder i kundregistret. Sök med fritext över namn, organisationsnummer och e-post. Använd kundnumret eller id:t i svaret när du skapar ett fakturautkast.
| Parameter | Typ | Krävs | Begränsning | Standard |
|---|---|---|---|---|
search | string | nej | max 200 tecken | |
include_inactive | boolean | nej | nej | |
limit | integer | nej | 1–100 | 50 |
offset | integer | nej | min 0 | 0 |
Returnerar: total och customers[] med id, customer_number, name, org_number, vat_number, email, phone, address, postal_code, city, country_code, is_active. Sorterat på namn.
Finns det någon kund som heter Acme?
list_invoices
Lista kundfakturor. Listar kundfakturor, nyast först. Filtrera på status, kund och fakturadatum. Status: draft (utkast), sent (skickad/obetald), overdue (förfallen), paid (betald), cancelled (makulerad), written_off (avskriven).
| Parameter | Typ | Krävs | Begränsning | Standard |
|---|---|---|---|---|
status | enum | nej | draft, sent, overdue, paid, cancelled, written_off | |
customer_number | string | nej | max 50 tecken | |
from_date | string | nej | ÅÅÅÅ-MM-DD, fakturadatum från och med | |
to_date | string | nej | ÅÅÅÅ-MM-DD, fakturadatum till och med | |
limit | integer | nej | 1–100 | 50 |
offset | integer | nej | min 0 | 0 |
Returnerar: total och invoices[] med id, document_number, invoice_number, status, invoice_date, due_date, paid_date, currency, subtotal, vat_amount, total och kundens customer_number och name. Personnummer skickas aldrig.
Vilka fakturor är förfallna just nu?
get_invoice
Hämta kundfaktura. Hämtar en kundfaktura med alla rader. Ange fakturans id, fakturanummer (t.ex. INV-0012) eller dokumentnummer.
| Parameter | Typ | Krävs | Begränsning | Standard |
|---|---|---|---|---|
id | string | ett av tre | UUID | |
invoice_number | string | ett av tre | max 50 tecken. Finns bara på utfärdade fakturor. | |
document_number | integer | ett av tre | positivt. Finns även på utkast. |
Anger du flera används id först, sedan invoice_number, sedan document_number. Anger du inget blir det fel.
Returnerar: fakturan med bland annat ocr_number, exchange_rate, vat_treatment, rounding_amount, notes, payment_reference, is_advance_invoice, tax_reduction_type, kunden (customer_number, name, org_number, email) och invoice_items[] (description, quantity, unit, unit_price, vat_rate, total) i radordning.
Visa raderna på faktura INV-0012.
list_supplier_invoices
Lista leverantörsfakturor. Listar leverantörsfakturor (inköp), nyast först. Status: draft (ej registrerad), registered (registrerad/obetald), paid (betald), cancelled (makulerad).
| Parameter | Typ | Krävs | Begränsning | Standard |
|---|---|---|---|---|
status | enum | nej | draft, registered, paid, cancelled | |
from_date | string | nej | ÅÅÅÅ-MM-DD | |
to_date | string | nej | ÅÅÅÅ-MM-DD | |
limit | integer | nej | 1–100 | 50 |
offset | integer | nej | min 0 | 0 |
Returnerar: total och supplier_invoices[] med id, given_number, invoice_number, status, invoice_date, due_date, payment_date, currency, subtotal, vat_amount, total och leverantörens supplier_number och name.
Vilka leverantörsfakturor är registrerade men obetalda?
list_accounts
Lista konton. Listar konton i företagets kontoplan (BAS). Sök på kontonummer (början) eller namn. Kontotyp: tillgang, skuld, eget_kapital, intakt, kostnad.
| Parameter | Typ | Krävs | Begränsning | Standard |
|---|---|---|---|---|
search | string | nej | max 100 tecken. Bara siffror = början av kontonumret, annars del av namnet. | |
account_type | enum | nej | tillgang, skuld, eget_kapital, intakt, kostnad |
Returnerar: accounts[] (account_number, name, account_type, vat_code), total och truncated. Bara aktiva konton, högst 500 per svar. Är listan kapad följer en hint om att söka smalare.
Vilket konto ska jag använda för bankavgifter?
list_vouchers
Lista verifikationer. Listar bokförda verifikationer med konteringsrader (konto, debet, kredit) för en period, nyast först. Använd för att se vad som bokförts, t.ex. på ett visst konto eller en viss dag.
| Parameter | Typ | Krävs | Begränsning | Standard |
|---|---|---|---|---|
from_date | string | ja | ÅÅÅÅ-MM-DD, bokföringsdatum | |
to_date | string | ja | ÅÅÅÅ-MM-DD, inte före from_date | |
account_number | string | nej | exakt fyra siffror | |
limit | integer | nej | 1–50 | 25 |
offset | integer | nej | min 0 | 0 |
Returnerar: total och vouchers[] med id, series, number, date, description, source och lines[] (account_number, account_name, debit, credit, description). Med kontofilter får du ändå alla rader på varje verifikation.
Vad har bokförts på 1930 i mars?
get_income_statement
Resultaträkning. Beräknar resultaträkningen för en period: intäkter, kostnader per kategori, rörelseresultat och årets resultat. Belopp i kronor.
| Parameter | Typ | Krävs | Begränsning | Standard |
|---|---|---|---|---|
from_date | string | ja | ÅÅÅÅ-MM-DD | |
to_date | string | ja | ÅÅÅÅ-MM-DD, inte före from_date |
Returnerar: samma beräkning som resultaträkningen i appen.
Vad är resultatet hittills i år?
get_balance_sheet
Balansräkning. Beräknar balansräkningen per ett datum: tillgångar, skulder och eget kapital per konto samt summor. Belopp i kronor.
| Parameter | Typ | Krävs | Begränsning | Standard |
|---|---|---|---|---|
date | string | nej | ÅÅÅÅ-MM-DD | i dag |
Returnerar: samma beräkning som balansräkningen i appen.
Hur mycket eget kapital hade vi vid årsskiftet?
get_owner_receivable
Hämta fordran på delägare. Visar hur mycket privata köp på företagets kort som står oreglerade som fordran på delägare (konto 1685), hur gammal fordran är och om den stoppar nästa lönekörning. Används för att föreslå hur den regleras: återbetalning, propose_payroll_deduction eller, bara för en anställd som inte är delägare eller VD, propose_interest_benefit.
Indata: inga.
Returnerar: outstanding_sek, receivables[] (kind = delägare (1685) eller anställd (1619), outstanding_sek, age_days, blocks_payroll), age_days, crosses_fiscal_year_end, blocks_payroll och message.
Stoppar fordran på delägare nästa lönekörning?
list_employees
Lista anställda. Listar företagets aktiva anställda med id och namn, inget mer. Används för att välja vem ett förslag gäller, t.ex. propose_interest_benefit.
Indata: inga.
Returnerar: employees[] med id, first_name, last_name. Personnummer, lön och kontaktuppgifter lämnar inte Klirr.
Vilka anställda har vi?