Spring til indhold
Forta Pay
English Log ind Book en samtale

Reference

Sagsnotater

Forta Pay API v1

4 operationer

Sagsnotater (filtre: creditor_id, debtor_id, invoice_id, follow_up_before, follow_up_done)

GET /case-notes

Forsidens «Følger op» er follow_up_before=<i dag>&follow_up_done=false — samme prædikat som tallet, fordi det er den samme forespørgsel (design §7.5).

Parametre

cursor

query · string · valgfri

limit

query · integer · valgfri

creditor_id

query · string · valgfri

debtor_id

query · string · valgfri

invoice_id

query · string · valgfri

follow_up_before

query · string (date) · valgfri

follow_up_done

query · boolean · valgfri

updated_after

query · string (date-time) · valgfri

K5: alle lister har updated_after

Svar

200

OK · Page

curl
curl -X GET https://api.fortapay.dk/v1/case-notes \
  -H "Authorization: Bearer $FP_KEY"

Opret sagsnotat — med opfølgningsdato og evt. udsættelse af næste rykkertrin i SAMME handling

POST /case-notes

*«Christian siger han vil betale d. 3. februar — har ikke penge lige nu.»* Det er inddrivelse i virkeligheden, og det fandtes ikke i kravspecen.

🔴 defer_dunning_to og notatet er ÉN beslutning. Aftalen med debitoren og udsættelsen af rykkeren hører sammen; skilles de ad, og glemmer man den ene, sendes rykkeren alligevel — så har sælgeren lovet noget systemet ikke holder. Kan udsættelsen ikke gennemføres, fejler HELE kaldet, og notatet skrives ikke. De tilfælde er: 422 uden invoice_id (et rykkertrin hører til en faktura) eller dato før i dag · 409 dunning_not_deferrable hvis fakturaen er lukket · 409 dunning_paused_indefinitely hvis forløbet allerede står på pause UDEN slutdato (der er intet at udsætte). Står forløbet på pause til en SENERE dato, gælder den dato — udsættelsen forlænger, men forkorter aldrig, og svarets deferred_to siger hvad der faktisk kom til at gælde.

Parametre

Idempotency-Key

header · string (uuid) · påkrævet

Obligatorisk på alle POST/PATCH/DELETE. Lever 24 timer.

Krop · CaseNoteCreate

debtor_id

string | null · valgfri

Påkrævet når invoice_id udelades

invoice_id

string | null · valgfri

body

string · påkrævet

follow_up_on

string | null (date) · valgfri

Lander på forsidens «Følger op». ⚠️ UMÅLT om en kreditor vil bruge den (design §12 nr. 3) — feltet er valgfrit

defer_dunning_to

string | null (date) · valgfri

🔴 Udsæt næste rykkertrin til denne dato i SAMME handling. Kan den ikke gennemføres, skrives notatet ikke

author

string | null · valgfri

Svar

201

Oprettet · CaseNote

409

Fejl (RFC 9457) · Problem

422

Fejl (RFC 9457) · Problem

curl
curl -X POST https://api.fortapay.dk/v1/case-notes \
  -H "Authorization: Bearer $FP_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d @- <<'JSON'
{
  "body": "…"
}
JSON

Hent sagsnotat

GET /case-notes/{noteId}

Parametre

noteId

path · string · påkrævet

Svar

200

OK · CaseNote

curl
curl -X GET https://api.fortapay.dk/v1/case-notes/{noteId} \
  -H "Authorization: Bearer $FP_KEY"

Ret sagsnotat — den gamle ordlyd gemmes i `history`

PATCH /case-notes/{noteId}

🔴 Der findes ingen DELETE. «Notatet er en hændelse; det kan ikke slettes, kun rettes med historik» (design §7.1) er en rettighed der ikke er givet i databasen, ikke en regel en kodesti kan glemme.

Parametre

noteId

path · string · påkrævet

Idempotency-Key

header · string (uuid) · påkrævet

Obligatorisk på alle POST/PATCH/DELETE. Lever 24 timer.

Krop · CaseNoteUpdate

body

string | null · valgfri

follow_up_on

string | null (date) · valgfri

follow_up_done

boolean | null · valgfri

Svar

200

OK · CaseNote

curl
curl -X PATCH https://api.fortapay.dk/v1/case-notes/{noteId} \
  -H "Authorization: Bearer $FP_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d @- <<'JSON'
{}
JSON