Spring til indhold
Forta Pay
English Log ind Book en samtale

Reference

Afdrag

Forta Pay API v1

5 operationer

Opret afdragsordning på en forfalden fordring — raterne skal summere til den åbne saldo; ingen rykkere mens den overholdes

POST /invoices/{invoiceId}/installment-plan

Parametre

invoiceId

path · string · påkrævet

Idempotency-Key

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

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

Krop · InstallmentPlanCreate

installments

liste af object · påkrævet

Stigende forfald; summen = fakturaens åbne saldo

grace_days

integer · valgfri

Dage efter en rates forfald før ordningen er misligholdt

note

string · valgfri

Svar

201

Oprettet · InstallmentPlan

409

Fejl (RFC 9457) · Problem

422

Fejl (RFC 9457) · Problem

curl
curl -X POST https://api.fortapay.dk/v1/invoices/{invoiceId}/installment-plan \
  -H "Authorization: Bearer $FP_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d @- <<'JSON'
{
  "installments": [
    {
      "due_date": "…",
      "amount": {}
    }
  ]
}
JSON

Afdragsberegneren («to af tre») — saldoen er givet; angiv count eller amount. Skriver intet; svaret er en krop POST …/installment-plan tager uændret

GET /invoices/{invoiceId}/installment-plan/calculation

Parametre

invoiceId

path · string · påkrævet

first_due_date

query · string (date) · påkrævet

count

query · integer · valgfri

amount

query · integer · valgfri

Beløb pr. rate i øre

interval_months

query · integer · valgfri

Svar

200

Raterne · InstallmentCalculation

404

Fejl (RFC 9457) · Problem

422

Fejl (RFC 9457) · Problem

curl
curl -X GET https://api.fortapay.dk/v1/invoices/{invoiceId}/installment-plan/calculation \
  -H "Authorization: Bearer $FP_KEY"

Afdragsordninger (filtre: invoice_id, debtor_id, status)

GET /installment-plans

Parametre

cursor

query · string · valgfri

limit

query · integer · valgfri

invoice_id

query · string · valgfri

debtor_id

query · string · valgfri

status

query · string · 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/installment-plans \
  -H "Authorization: Bearer $FP_KEY"

Hent afdragsordning med rate-status

GET /installment-plans/{installmentPlanId}

Parametre

installmentPlanId

path · string · påkrævet

Svar

200

OK · InstallmentPlan

curl
curl -X GET https://api.fortapay.dk/v1/installment-plans/{installmentPlanId} \
  -H "Authorization: Bearer $FP_KEY"

Annullér afdragsordning — rykkerforløbet genoptages fra det niveau det havde

POST /installment-plans/{installmentPlanId}/cancel

Parametre

installmentPlanId

path · string · påkrævet

Idempotency-Key

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

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

Krop · object

reason

string · valgfri

Svar

200

OK · InstallmentPlan

409

Fejl (RFC 9457) · Problem

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