Spring til indhold
Forta Pay
English Log ind Book en samtale

Reference

Kreditorer

Forta Pay API v1

2 operationer

Kreditorens branding og tekstskabeloner til faktura, påmindelse, rykker og § 10-påkrav (B8)

GET /creditors/{creditorId}/document-settings

Parametre

creditorId

path · string · påkrævet

Svar

200

OK · DocumentSettings

curl
curl -X GET https://api.fortapay.dk/v1/creditors/{creditorId}/document-settings \
  -H "Authorization: Bearer $FP_KEY"

Ret branding/skabeloner. Kravspecifikation, frist og § 10-blokken dannes af Forta Pay og kan ikke fjernes (H9)

PATCH /creditors/{creditorId}/document-settings

Kræver en konto-bred nøgle med admin-scope — teksterne er det debitor læser (403 insufficient_scope for en write-nøgle eller en kreditorbegrænset nøgle).

Parametre

creditorId

path · string · påkrævet

Idempotency-Key

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

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

Krop · DocumentSettingsUpdate

branding

Branding · valgfri

templates

object | null · valgfri

{template_id: {kind, texts: {da|en|fo|kl: {subject, intro, outro, sms}}}} — kun kendte pladsholdere

open_tracking

boolean | null · valgfri

⑤ Åbningsmåling i e-mail (sporingspixel). Standard FRA (R-10) — et tilvalg; pixlen beviser ikke fremkomst

collection_agency

CollectionAgency | null · valgfri

R-20 · inkassobureauet; null fjerner det

Svar

200

OK · DocumentSettings

403

Fejl (RFC 9457) · Problem

422

Fejl (RFC 9457) · Problem

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