Klirr Docs

Registrera en betalning

Matcha en inbetalning mot en kundfaktura, registrera hel- eller delbetalning och återför den vid behov.

Den här guiden registrerar en inbetalning mot en bokförd kundfaktura, först som delbetalning och sedan resten, och visar hur en felregistrerad betalning återförs. Alla namn, nummer och belopp är påhittade exempel.

Du behöver en access token med scope invoice. Det täcker både fakturor och inbetalningar.

Betalningen bokförs direkt

I Klirr finns ingen obokförd betalning. POST /3/invoicepayments bokför verifikatet direkt, och PUT /3/invoicepayments/{Number}/bookkeep gör ingenting. Endpointen finns bara för att Fortnox-integrationer som anropar den ska fungera.

Hitta fakturan

Sök bland obetalda fakturor, till exempel på OCR-numret från bankfilen. filter=unpaid ger bokförda, obetalda fakturor, inklusive förfallna och delbetalda.

curl "https://app.klirr.ai/api/v1/3/invoices?filter=unpaid&ocr=5700003" \
  -H "Authorization: Bearer <access_token>"
{
  "Invoices": [
    {
      "@url": "https://app.klirr.ai/api/v1/3/invoices/57",
      "DocumentNumber": "57",
      "CustomerName": "Lundgrens Måleri AB",
      "CustomerNumber": "1002",
      "Balance": "23500",
      "Total": "23500",
      "Booked": true,
      "OCR": "5700003",
      "DueDate": "2026-11-17"
    }
  ],
  "MetaInformation": { "@TotalResources": 1, "@TotalPages": 1, "@CurrentPage": 1 }
}

I listformen är Balance och Total strängar. Se Fortnox-kompatibilitet.

Registrera en delbetalning

InvoiceNumber är fakturans DocumentNumber, men här som ett tal. Amount är i kronor. Utelämnar du beloppet regleras hela det öppna beloppet. PaymentDate får inte ligga i framtiden. Utelämnat ModeOfPaymentAccount ger standardkontot.

curl -X POST https://app.klirr.ai/api/v1/3/invoicepayments \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{"InvoicePayment":{"InvoiceNumber":57,"Amount":10000,"PaymentDate":"2026-10-28","ModeOfPayment":"BG"}}'

Svar (201, förkortat):

{
  "InvoicePayment": {
    "@url": "https://app.klirr.ai/api/v1/3/invoicepayments/12",
    "Number": "12",
    "InvoiceNumber": 57,
    "Amount": 10000,
    "AmountCurrency": 10000,
    "PaymentDate": "2026-10-28",
    "ModeOfPaymentAccount": 1930,
    "ModeOfPayment": "BG",
    "Booked": true,
    "InvoiceTotal": 23500,
    "Currency": "SEK",
    "VoucherNumber": 31,
    "VoucherSeries": "C",
    "VoucherYear": 3
  }
}

Kontrollera saldot

Efter en delbetalning står fakturan kvar som obetald och Balance visar återstoden.

curl https://app.klirr.ai/api/v1/3/invoices/57 \
  -H "Authorization: Bearer <access_token>"

Registrera resten

Utelämna Amount så regleras hela det öppna beloppet. Fakturan blir då betald.

curl -X POST https://app.klirr.ai/api/v1/3/invoicepayments \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{"InvoicePayment":{"InvoiceNumber":57,"PaymentDate":"2026-11-12"}}'

Ett belopp som överstiger det öppna beloppet ger 400. Klirr har ingen modell för överbetalning. Är det öppna beloppet redan noll blir svaret 409.

Återför en felregistrerad betalning

Belopp, datum och konto kan inte ändras med PUT (ändrade värden ger 409). Återför i stället betalningen med DELETE och registrera en ny. Klirr bokför ett rättelseverifikat och öppnar fakturans saldo igen. Svaret är 204.

curl -X DELETE https://app.klirr.ai/api/v1/3/invoicepayments/12 \
  -H "Authorization: Bearer <access_token>"

Betalningen försvinner sedan ur GET /3/invoicepayments, och GET på numret ger 404.

Att tänka på

  • Utländsk valuta: för en faktura i annan valuta än SEK är AmountCurrency obligatoriskt. Se belopp och valuta.
  • Kontantmetoden: organisationer med kontantmetoden kan inte delbetala ännu (400).
  • Fakturan måste vara bokförd: ett utkast kan inte betalas (400). Bokför den först, se Skapa och skicka en faktura.

Se Inbetalningar för alla fält och fel.

On this page