Introduksjon
Metoden tillater deg å poste innbetalinger for et medlem.
...
Introduction
API-endpoint for adding payments for a member.
Parameters
This is additional to required parameters as described:
https://idrettsforbundet.atlassian.net/wiki/spaces/DDTII/pages/14024708
Headers | Eksempel | kommentar |
|---|---|---|
Querystring | Eksempel | Kommentar |
|---|---|---|
Dataobjekter:
NavnName | PåkrevdRequired | BeskrivelseDescription | EksempelExample | ||
|---|---|---|---|---|---|
Amount | JaYes | Totalsummen Total amount for innbetalingenthe payment | 450 | ||
Comment | NeiNo, men anbefaltEn beskrivende tekst hva betalingen inneholderbut recommended | Describing text, concerning the payment | |||
ExternalId | JaYes | EksternExternal, sporbar identifikator for fakturaen/innbetalingentraceable identification for the payment or invoice | |||
IsFamilyMember | Nei | Om betalingen er for en annen i familienNo | Is this persons payment a part of a family | ||
IsPaid | Ja | Om fakturaen er betalt eller ikkeYes | Wheter the invoice is paid or not | ||
OrgId | Ja | Orgid på klubbYes | OrgId, unique identifier for Club (PaymentTypeId=0), or branch (PaymentTypeId = 2) | ||
PaidDate | Ja | Dato for betalingYes | Paid date | 2020-10-15 | |
PaidToOrgId | Ja | Orgid på klubb eller gren (for treningsavgiftYes | OrgId, unique identifier for Club (PaymentTypeId=0), or branch (PaymentTypeId = 2) | ||
PaymentCategory | JaYes | Betalingsmetodikk Category (friteksttext) | |||
PaymentTypeId | Ja | Type betling (medlemsskap eller treningsavgift) | Yes | Payment type Membership, club level: 0 Training fee, branch level: 2 | 0 = Medlemsskap i klubb |
PeriodFrom | Ja | Avgiften løper fra dato. Må være i samme år, og må være større en medlemsskapsdatoenYes | From date. Must be this year, must be greater than membership start date. | ||
PeriodFrom | Ja | Avgiften løper til dato. Må være større enn Yes | To date. Must be greater than PeriodFrom | ||
PersonId | Ja | Unik id på personen det betales forYes | PersonId, unique identifier for person. Must be existing personId. |
Eksempler
JSON Request
| Code Block | ||
|---|---|---|
| ||
{
"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
| Code Block |
|---|
{
"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 OkPayment registert 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 grenkodePeriodFrom and PeriodTo is not in same year | |
3001 | No membership found in between dates | |||||||||||||||
3006 | Invalid period | |||||||||||||||
3007 | Invalid paiddate | |||||||||||||||
3008 | Invalid OrgId | |||||||||||||||
3009 | Invalid paymenttype | |||||||||||||||
3010 | Invalid period | |||||||||||||||
1006 | Invalid branchId | |||||||||||||||
1002 | PersonId does not exist |
Endpoints
URL | Miljø | Kommentar |
|---|---|---|
https://api-dst.nif.no/api/v1/payment/Addpaymentdetail | DST | |
https://api.nif.no/api/v1/payment/Addpaymentdetail | PROD |
...