Spring til indhold
Forta Pay
English Log ind Book en samtale

Reference

Forta-bog

Forta Pay API v1

4 operationer

Forta-bogens bogføringsfeed — bilag efter markøren

GET /source/fortabog/bogfoeringer

🔴 Ikke slået til: ruten svarer 404. Kun en nøgle med skop source, bundet til præcis én kreditor. Pay danner bilagene write-ahead (ét pr. betaling, ét pr. tilbageførsel) efter bilagsmodellen med roller (debitor, metode:<rør>, opsamling, rykkergebyr, rente, afrunding, bank). Bogføringssystemet bogfører med kilde_id = id og kvitterer. Betalinger kilden selv har registreret (mark-paid) kommer aldrig i feedet. Markøren naeste gives tilbage som efter. Kaldet er ren læsning; kvittér markøren med POST /source/fortabog/bogfoeringer/markoer.

Parametre

efter

query · integer · valgfri

limit

query · integer · valgfri

Svar

200

OK · FortabogFeed

403

Fejl (RFC 9457) · Problem

404

Fejl (RFC 9457) · Problem

curl
curl -X GET https://api.fortapay.dk/v1/source/fortabog/bogfoeringer \
  -H "Authorization: Bearer $FP_KEY"

Bogføringssystemet har modtaget feedet til og med en markør

POST /source/fortabog/bogfoeringer/markoer

🔴 Ikke slået til: ruten svarer 404. Hvert klar bilag med feed_seq <= til_og_med bliver hentet. Samme eller en lavere markør igen ændrer intet.

Parametre

Idempotency-Key

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

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

Krop · FortabogMarkoerCreate

til_og_med

integer · påkrævet

Svar

200

OK · object

403

Fejl (RFC 9457) · Problem

404

Fejl (RFC 9457) · Problem

curl
curl -X POST https://api.fortapay.dk/v1/source/fortabog/bogfoeringer/markoer \
  -H "Authorization: Bearer $FP_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d @- <<'JSON'
{
  "til_og_med": 0
}
JSON

Bogføringssystemet har lagt bilaget i en kladde eller bogført det

POST /source/fortabog/bogfoeringer/{bogfoeringId}/kvittering

🔴 Ikke slået til: ruten svarer 404. i_kladde → bogfoert. Samme kvittering igen svarer det samme; en anden crm_bilag_ref giver 409 receipt_conflict. Et bogført eller afvist bilag er endeligt.

Parametre

bogfoeringId

path · string · påkrævet

Idempotency-Key

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

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

Krop · FortabogKvitteringCreate

tilstand

string · påkrævet

i_kladde · bogfoert

crm_bilag_ref

string · påkrævet

Svar

200

OK · FortabogBilag

403

Fejl (RFC 9457) · Problem

404

Fejl (RFC 9457) · Problem

409

`invalid_state_transition` · `receipt_conflict` · Problem

curl
curl -X POST https://api.fortapay.dk/v1/source/fortabog/bogfoeringer/{bogfoeringId}/kvittering \
  -H "Authorization: Bearer $FP_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d @- <<'JSON'
{
  "tilstand": "i_kladde",
  "crm_bilag_ref": "…"
}
JSON

Bogføringssystemet kan ikke bogføre bilaget (fx en rolle uden konto)

POST /source/fortabog/bogfoeringer/{bogfoeringId}/afvisning

🔴 Ikke slået til: ruten svarer 404. Bilaget bliver afvist og et arbejdspunkt hos Forta Pay. Det bogføres aldrig på en standardkonto. Samme afvisning igen svarer det samme; en anden kode giver 409 receipt_conflict.

Parametre

bogfoeringId

path · string · påkrævet

Idempotency-Key

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

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

Krop · FortabogAfvisningCreate

kode

string · påkrævet

tekst

string | null · valgfri

Svar

200

OK · FortabogBilag

403

Fejl (RFC 9457) · Problem

404

Fejl (RFC 9457) · Problem

409

`invalid_state_transition` · `receipt_conflict` · Problem

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