Anställda

Personalresursen speglar Fortnox /3/employees. Den anställde adresseras på sitt anställningsnummer (EmployeeId), och numret kan inte ändras när det väl är satt.

Scope: salary · Kräver AI Pro

EndpointsCopy Anchor Link

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

POST svarar 200 precis som Fortnox gör. Det är den enda skapande endpointen i API:t som inte svarar 201.

Det finns ingen DELETE, varken hos Fortnox eller i Klirr. Att radera en anställd skulle radera bokförda lönespecifikationer. Avsluta i stället anställningen med PUT och "Inactive": true.

ListparametrarCopy Anchor Link

Utöver paginering (page, limit, offset) och sortorder (asc/desc). Listan sorteras alltid på EmployeeId.

sortby och lastmodified stöds inte och ger 400 i stället för ett tyst ofiltrerat svar.

Personnummer maskeras alltidCopy Anchor Link

PersonalIdentityNumber returneras alltid maskerat som ÅÅÅÅMMDD-XXXX (till exempel 19900101-XXXX), eller XXXXXXXX-XXXX om numret inte har tolv siffror. API:t lämnar aldrig ut det fullständiga personnumret.

Skickar du tillbaka det maskerade värdet i en PUT ignoreras fältet, och det sparade personnumret lämnas oförändrat. Du kan alltså läsa en anställd, ändra ett fält och skicka tillbaka hela objektet utan att personnumret förstörs. Vill du ändra personnumret skickar du det fullständiga numret.

FältCopy Anchor Link

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

SalaryForm och PersonelType har färre värden hos Fortnox än i Klirr: en företagsledare returneras som TJM och en deltidsanställd som MAN. Skickar du tillbaka samma värde i en PUT skrivs den mer precisa kategorin i Klirr inte över.

Övriga Fortnox-fält (adress, BankAccountNo, TaxTable, TaxColumn, EmploymentForm, semestersaldon, DatedWages m.fl.) modelleras inte av Klirr. De returneras alltid, med Fortnox nollvärde ("", 0, false eller []) eller med det värde du senast skickade, och slås vid PUT ihop med de sparade. Klirr använder dem inte i sin egen lönekörning. Till exempel härleds skattetabellen inte ur dem.

ListformCopy Anchor Link

Personalresursen har ingen reducerad listform. GET /3/employees returnerar samma fält som den fullständiga formen plus @url. Omvänt saknar den fullständiga formen @url. Båda delarna stämmer med Fortnox.

Skapa en anställdCopy Anchor Link

curl -X POST https://app.klirr.ai/api/v1/3/employees \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{"Employee":{"FirstName":"Anna","LastName":"Svensson","PersonalIdentityNumber":"<personnummer>","EmploymentDate":"2026-09-01","MonthlySalary":"32000","SalaryForm":"MAN","PersonelType":"TJM"}}'

Svar (200), förkortat. De omodellerade Fortnox-fälten är utelämnade här:

{
  "Employee": {
    "EmployeeId": "1",
    "PersonalIdentityNumber": "19900101-XXXX",
    "FirstName": "Anna",
    "LastName": "Svensson",
    "FullName": "Anna Svensson",
    "Email": "",
    "Phone1": "",
    "EmploymentDate": "2026-09-01",
    "MonthlySalary": "32000",
    "HourlyPay": "",
    "Inactive": false,
    "SalaryForm": "MAN",
    "PersonelType": "TJM",
    "EmploymentForm": "TV",
    "TaxTable": "",
    "TaxColumn": 0,
    "VacationDaysSaved": 0,
    "DatedWages": []
  }
}

Lista anställdaCopy Anchor Link

curl "https://app.klirr.ai/api/v1/3/employees?filter=active" \
  -H "Authorization: Bearer <access_token>"

{
  "Employees": [
    {
      "@url": "https://app.klirr.ai/api/v1/3/employees/1",
      "EmployeeId": "1",
      "PersonalIdentityNumber": "19900101-XXXX",
      "FirstName": "Anna",
      "LastName": "Svensson",
      "FullName": "Anna Svensson",
      "Inactive": false,
      "SalaryForm": "MAN",
      "PersonelType": "TJM"
    }
  ],
  "MetaInformation": { "@TotalResources": 1, "@TotalPages": 1, "@CurrentPage": 1 }
}

Raden ovan är förkortad. Varje rad innehåller alla fält i den fullständiga formen.

Uppdatera en anställdCopy Anchor Link

PUT ändrar bara de fält du skickar. Använd "API_BLANK" för att tömma ett fält. Det fungerar inte på FirstName, LastName, Inactive eller PersonelType, som ger 400. Se Fortnox-kompatibilitet.

curl -X PUT https://app.klirr.ai/api/v1/3/employees/1 \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{"Employee":{"Inactive":true}}'

FelCopy Anchor Link

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