Klirr Docs

Konton

Kontoplanen – lista, skapa, hämta, uppdatera och inaktivera konton via /3/accounts.

Kontoresursen speglar Fortnox /3/accounts. Kontot adresseras på sitt kontonummer (Number), fyra siffror enligt BAS. Saldona räknas fram ur bokföringen för ett visst räkenskapsår och lagras inte på kontot.

Scope: bookkeeping · Kräver AI Pro

Endpoints

Metod och sökvägBeskrivning
GET/api/v1/3/accountsLista konton (reducerad listform)
POST/api/v1/3/accountsSkapa ett konto. Svarar 201.
GET/api/v1/3/accounts/{Number}Hämta ett konto (fullständig form)
PUT/api/v1/3/accounts/{Number}Uppdatera ett konto (partiellt)
DELETE/api/v1/3/accounts/{Number}Inaktivera ett konto. Svarar 204.

Bas-URL: https://app.klirr.ai/api/v1. Skrivningar kuverteras i Account.

Räkenskapsår

Alla fem anrop läser ?financialyear=. Det styr Year och vilket år BalanceBroughtForward/BalanceCarriedForward räknas för. Värdet är räkenskapsårets Id från /3/financialyears, inte ett årtal. Utelämnat gäller det räkenskapsår som innehåller dagens datum, annars det senaste.

  • Ett värde som inte bara består av siffror ger 400.
  • Ett okänt Id ger 404.
  • Saknar organisationen räkenskapsår svarar alla anrop 404. Vid POST/PUT görs kontrollen före skrivningen, så inget sparas.

Listparametrar

Utöver paginering (page, limit, offset) och sortorder (asc/desc, även ascending/descending):

ParameterVärdenBeskrivning
sortbynumberEnda värdet. Standard är kontonummer.
numbertextExakt kontonummer. Klirr-tillägg, inte en Fortnox-parameter.
financialyearheltalSe ovan.

Det finns inget filter. Listan innehåller alla konton, både aktiva och inaktiva (Active: false). Fortnox-parametrarna sru och lastmodified stöds inte och ger 400.

Fält

Fullständig form (GET /3/accounts/{Number}, och svaret på POST/PUT).

FältTypSkrivskyddatBeskrivning
@urlstringjaResursens URL i Klirr.
Numbernumberefter skapandeKontonummer, fyra siffror (t.ex. 1930). Obligatoriskt vid POST. Ignoreras vid PUT.
DescriptionstringnejKontots namn. Obligatoriskt vid POST.
Activebooleannejfalse för inaktiverat konto. Tolkas strikt; "" räknas som ej angivet.
VATCodestringnejMomskod. Måste vara text; tömmes med API_BLANK.
BalanceBroughtForwardnumberjaIngående balans, beräknad ur bokföringen. Att skicka fältet ger 400.
BalanceCarriedForwardnumberjaUtgående balans, beräknad. Ignoreras om det skickas.
YearnumberjaRäkenskapsårets Id, inte ett årtal.
SRUnumbernejSRU-kod. Bärs vidare, standard 0.
CostCenterstringnejBärs vidare.
CostCenterSettingsALLOWED | MANDATORY | NOTALLOWEDnejBärs vidare, standard NOTALLOWED.
ProjectstringnejBärs vidare.
ProjectSettingsALLOWED | MANDATORY | NOTALLOWEDnejBärs vidare, standard NOTALLOWED.
TransactionInformationstringnejBärs vidare.
TransactionInformationSettingsALLOWED | MANDATORY | NOTALLOWEDnejBärs vidare, standard NOTALLOWED.
QuantitySettingsALLOWED | MANDATORY | NOTALLOWEDjaStandard NOTALLOWED.
QuantityUnitstringjaStandard "".
OpeningQuantitiesarraynej[{ Balance, Project }]. Bärs vidare, standard [].

"Bärs vidare" betyder att Klirr sparar värdet och returnerar det oförändrat, men det påverkar inte bokföringen. Kontotyp och normalsida härleds ur kontonumret.

Listform

GET /3/accounts returnerar exakt dessa tolv fält: @url, Active, BalanceBroughtForward, CostCenter, CostCenterSettings, Description, Number, Project, ProjectSettings, SRU, Year, VATCode. BalanceCarriedForward ingår inte i listan. Belopp och nummer är tal (JSON-nummer) även i listformen.

Skapa ett konto

curl -X POST https://app.klirr.ai/api/v1/3/accounts \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{"Account":{"Number":6991,"Description":"Övriga externa kostnader, ej avdragsgilla"}}'

Svar (201):

{
  "Account": {
    "@url": "https://app.klirr.ai/api/v1/3/accounts/6991",
    "Number": 6991,
    "Description": "Övriga externa kostnader, ej avdragsgilla",
    "Active": true,
    "VATCode": "",
    "BalanceBroughtForward": 0,
    "BalanceCarriedForward": 0,
    "Year": 3,
    "SRU": 0,
    "CostCenter": "",
    "CostCenterSettings": "NOTALLOWED",
    "Project": "",
    "ProjectSettings": "NOTALLOWED",
    "TransactionInformation": "",
    "TransactionInformationSettings": "NOTALLOWED",
    "QuantitySettings": "NOTALLOWED",
    "QuantityUnit": "",
    "OpeningQuantities": []
  }
}

Lista konton

curl "https://app.klirr.ai/api/v1/3/accounts?financialyear=3&limit=100" \
  -H "Authorization: Bearer <access_token>"
{
  "Accounts": [
    {
      "@url": "https://app.klirr.ai/api/v1/3/accounts/1930",
      "Number": 1930,
      "Description": "Företagskonto",
      "Active": true,
      "VATCode": "",
      "BalanceBroughtForward": 125000.5,
      "Year": 3,
      "SRU": 0,
      "CostCenter": "",
      "CostCenterSettings": "NOTALLOWED",
      "Project": "",
      "ProjectSettings": "NOTALLOWED"
    }
  ],
  "MetaInformation": { "@TotalResources": 1, "@TotalPages": 1, "@CurrentPage": 1 }
}

Uppdatera ett konto

PUT ändrar bara de fält du skickar. Omodellerade fält slås ihop med de redan sparade i stället för att ersätta dem. Se Fortnox-kompatibilitet.

curl -X PUT https://app.klirr.ai/api/v1/3/accounts/6991 \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{"Account":{"Description":"Ej avdragsgilla kostnader"}}'

Inaktivera ett konto

DELETE raderar inte kontot. Det inaktiveras (Active: false), eftersom bokförda rader refererar till det. Svaret är 204, och kontot finns kvar på sin URL. Systemkonton i BAS-kontoplanen (t.ex. 1930) kan varken inaktiveras eller få ändrad momskod, varken via PUT eller DELETE. Det ger 409.

Fel

StatusCodeNär
4009000400Number eller Description saknas, numret är inte fyra siffror, BalanceBroughtForward skickas, API_BLANK på Number/Description/Active, ogiltigt VATCode eller Active, ostödd sökparameter, eller ogiltigt financialyear.
4049000404Kan inte hitta kontot, okänt räkenskapsår, eller organisationen saknar räkenskapsår.
4099000409Kontonumret finns redan, eller försök att inaktivera ett systemkonto eller ändra dess momskod.

Allmänna fel (401, 403, 429) beskrivs under Felkoder.

On this page