Introduksjon
Metoden tillater deg å poste innbetalinger for et medlem.
Parametere
Headers | Eksempel | kommentar |
|---|---|---|
Querystring | Eksempel | Kommentar |
|---|---|---|
Dataobjekter:
Navn | Påkrevd | Beskrivelse | Eksempel |
|---|---|---|---|
Amout | Ja | Totalsummen for innbetalingen | 450 |
Comment | Nei, men anbefalt | En beskrivende tekst hva betalingen inneholder | |
ExternalId | Ja | Ekstern, sporbar identifikator for fakturaen/innbetalingen | |
IsFamilyMember | Nei | Om betalingen er for en annen i familien | |
IsPaid | Ja | Om fakturaen er betalt eller ikke | |
OrgId | Ja | Orgid på klubb | |
PaidDate | Ja | Dato for betaling | 2020-10-15 |
PaidToOrgId | Ja | Orgid på klubb eller gren (for treningsavgift) | |
PaymentCategory | Ja | Betalingsmetodikk (fritekst) | |
PaymentTypeId | Ja | Type betling (medlemsskap eller treningsavgift) | 0 = Medlemsskap i klubb |
PeriodFrom | Ja | Avgiften løper fra dato. Må være i samme år, og må være større en medlemsskapsdatoen. | |
PeriodFrom | Ja | Avgiften løper til dato. Må være større enn PeriodFrom | |
PersonId | Ja | Unik id på personen det betales for |
Eksempler
JSON Request
{
"amount": "450",
"comment": "This was paid for club membership",
"externalId": "3248",
"isFamilyMember": "true",
"isPaid": "false",
"orgId": "7896",
"paidDate": "2015-05-08",
"paidToOrgId": "4568",
"paymentCategory": "Club membership",
"paymentTypeId": 0,
"periodFrom": "2015-05-08",
"periodTo": "2015-06-08",
"personId": "8675682"
}
JSON Response
{
"message": "Payment details added for membership of {personId} with {orgId} for period {periodFrom} to {periodTo}",
"updatedPersonId": 0,
"paymentTypeId": 0,
"paymentId": 0,
"paymentCategory": "string"
}
JSON Response koder
Kode | Kommentar | |
|---|---|---|
200 (http) | Betaling registrert Ok | |
3000 | Perioden fra og til har ikke samme år | |
3001 | Medlemsskap er ikke funnet på datointervallet | |
3006 | Ikke gyldig periode | |
3007 | Ikke gyldig betalingsdato | |
3008 | Ikke gyldig OrgId | |
3009 | Ikke gyldig betalingstype | |
3010 | Ikke gyldig periode | |
1006 | Ikke gyldig grenkode |
Endpoints
URL | Miljø | Kommentar |
|---|---|---|
https://api-dst.nif.no/api/v1/payment/Addpaymentdetail | DST | |
PROD |