A.P.I dokumentation

(API: Application Programming Interface)

Kontoudtog

Du kan, som ERP udbyder, bruge vores HTTPS/REST API til at hente kontoudtog.
Denne side omhandler alene API funktioner til at modtage kontoudtog.

Alle anmodninger skal godkendes, se mere her: beregning af godkendelses header


Kontoudtog kan hentes fra:
GET
https://api.bankintegration.dk/report/account?requestId=<RequestId>
POST
https://api.bankintegration.dk/report/account

På en anmodning om kontoudtog sendes et JSON objekt tilbage i svarets body.

{
  "account": "52470021527478",
  "requestId": "REQ_01",
  "created": "2015-05-21T12:45:23+02:00",
  "currency" : "DKK",
  "name": "Driftkonto",
  "bic": "DABADKKK",
  "owner": {
    "id": "12457889",
    "name": "Bennys Pølsebar",
    "address": "Havnen 85",
    "postalCode": "9210",
    "city": "Aalborg SV",
    "country": "DK"
  },
  "from": "2005-10-15T00:00:00",
  "to": "2005-10-20T00:00:00",
  "entries": [ { ... }, { ... } ]
}
GET anmodninger

Kontoudtog kan hentes via. GET en anmodning. På anmodningen skal som minimum sættes RequestId.

Øvrige parametre på GET anmodninger kan være:

  • "requestId": ERP udbyderens ID på anmodning. Returneres i svaret.
  • "type": Type af kontoudtog der ønskes returneret. Kan være "Simple", "Full" eller anden ERP specifik værdi. Standard er "Simple".
  • from: Fra dato, inklusive. Format kan være "yyyy-MM-dd" eller "yyMMdd".
  • to: Til dato, inklusive. Format kan være "yyyy-MM-dd" eller "yyMMdd".

Angives "type" ikke returneres kontoudtog af type "Simple".
Angives fra dato ikke sættes denne til dags dato. Angives til dato ikke sættes denne ligeledes til dags dato (Dato i UTC, bemærk korrektion for tisdzone og sommer/vinter-tid). Fra dato kan ikke være større end til dato.

POST anmodninger:

Kontoudtog kan alternativt hentes med en POST admodning.

I anmodnings body indsættes et JSON objekt til at angive samme parametre som ved GET anmodninger.

  • requestId: [string, required] ERP udbyderens ID på anmodning. ID returneres i svaret.
  • type: [string, optional] Type af kontoudtog der ønskes returneret.
  • from: [date, optional] Fra dato. Format kan være "yyyy-MM-dd" eller "yyMMdd".
  • to: [date, optional] Til dato. Format kan være "yyyy-MM-dd" eller "yyMMdd".
{
  "requestId": "string",
  "type": "string",
  "from": "date",
  "to": "date"
}
Svar på anmodning om kontoudtog:

På en anmodning sendes et kontoudtog tilbage i det ønskede format, typisk "Simple".

Formatet "Simple" er et fast format, som beskrevet herunder.
Formatet "Full" er et format som løbende udvides if. med at bankerne kan levere nye data og indeholder, i princippet, alle felter. Der vil ikke blive fjernet felter, men nye kan tilføjes uden varsel.

For begge ovenstående formater gælder at kun udfyldte felter returneres.
Andre faste formater kan oprettes på forespørgsel.

Fælles for alle formater er et JSON rodobjektet som nedenstående;

  • account: [string] Konto nr.
  • requestId: [string] ERP udbyders ID for anmodning. Kopieret fra anmodning.
  • created: [datetime] Tidspunkt for oprettelse af svar (UTC).
  • currency: [string] Valuta for konto.
  • name: [string] Navn på konto (fra banken).
  • bic: [string] Bankens Swift/BIC nr.
  • from: [date] Dato for start saldo.
  • to: [date] Dato for slut dato
  • entries: [object, array] Et array af posterings værdier

{
  "account": "string",
  "requestId": "string",
  "created": "datetime",
  "currency": "string",
  "name": "string",
  "bic": "string",
  "from": "datetime",
  "to": "datetime",
  "owner": "object:AccountReportOwner",
  "entries": [ "object:<Variabel>", "object:<Variabel>" ]
}
AccountReportOwner

  • id: [string, optional] CVR nr.
  • name: [string, optional] Navn.
  • adress: [string, optional] Adresse.
  • postalCode: [string, optional] Post nr.
  • city: [string, optional] Navn på by.
  • country: [string, optional] Landkode (eksv. "DK", "DE").

{
  "id": "string",
  "name": "string",
  "address": "string",
  "postalCode": "string",
  "city": "string",
  "country": "string"
}

SimpleAccountReportEntry

  • sequence: [integer] Sekvens nr. for postering
  • amount: [double] Beløb i konto valuta
  • balance: [double] Saldo i konto valuta (ih. til sekvens nr.)
  • instructedCurrency: [string, optional] Oprindelig valuta fra evt. betalingsanmodning
  • instructedAmount: [double, optional] Oprindeligt beløb fra evt. betalingsanmodning
  • exchangeRate: [double, optional] Valutakurs såfremt betalingsanmodning er i anden valuta
  • batch: [string, optional] Batch ID if. med evt. samlebetalinger
  • debtorBic: [string, optional] Swift/Bic ID på debitors bank
  • debtorAccount: [string, optional] Debitors konto nr.
  • debtorText: [string, optional] Tekst på debitors kontoudtog.
  • debtorMessage: [string, optional] Lang besked på debitors kontoudtog
  • creditorBic: [string, optional] Swift/Bic ID på kreditors bank.
  • creditorAccount: [string, optional] Konto nr. på kreditor.
  • creditorText: [string, optional] Teskt på kreditors kontoudtog.
  • creditorMessage: [string, optional] Besked til kreditor.
  • ocrReference: [string, optional] OCR reference nr. på Giro/FI betaling (Giro 04/15 og FIK 71/75)
  • ocrType: [string, optional] OCR type nr. (01, 04, 15, 71, 73 eller 75)
  • easyAccount: [string, optional] NEM-konto nr. (kan være CVR eller CPR nr.)
  • easyAccountType: [string, optional] NEM-konto type (kan være "CVR" eller "CPR")
  • debtorsPaymentId: [string, optional] Debitors betalings ID
  • primaryReference: [string, optional] Primær reference til betaling
  • employeeNumber: [string, optional] Medarbejder nr.
  • id: [string, optional] Bankens ID af postering
  • endToEndId: [string, optional] ID reference af betaling på tværs af systemer
  • date: [object:AccountEntryDate] Booking og valør dato
  • type: [string] Posterings type i det omfang det kan afgøres
    ("Payment" = betaling, "Charges" = gebyr, "Unknown" = ukendt)
  • text: [string] Tekst på postering (kan være blank)
  • transactionCodes: [object:AccountEntryTransactionCodes] Bankens transaktions koder
  • debtor: [object:AccountEntryDebtor, optional] Oplysninger om debitor
  • creditor: [object:AccountEntryCreditor, optional] Oplysninger om kreditor

{
  "sequence": "integer",
  "amount": "double",
  "balance": "double",
  "instructedCurrency": "string",
  "instructedAmount": "string",
  "exchangeRate": "string",
  "batch": "string",
  "debtorBic": "string",
  "debtorAccount": "string",
  "debtorText": "string",
  "debtorMessage": "string",
  "creditorBic": "string",
  "creditorAccount": "string",
  "creditorText": "string",
  "creditorMessage": "string",
  "ocrReference": "string",
  "ocrType": "string",
  "easyAccount": "string",
  "easyAccountType": "string",
  "debtorsPaymentId": "string",
  "primaryReference": "string",
  "employeeNumber": "string"
  "id": "string",
  "endToEndId": "string",
  "date": "object:AccountEntryDates",
  "type" : "string",
  "text": "string",
  "transactionCodes": "object:AccountEntryTransactionCodes",
  "debtor": "object:AccountReportDebtor",
  "creditor": "object:AccountReportCreditor"
}
AccountEntryDates

  • booking: [date] Booking dato
  • value: [date] Valør/rente dato

{
  "booking": "date",
  "value": "date"
}
AccountEntryTransactionCodes

Transaktionskoden er bankens kode for bevægelsen på kontoudtoget. Koderne fortæller noget om hvilken type postering det drejer sig om. Koder er i ISO20022 format og kan findes her; ISO 20022 External Code Sets
Nogle banker benytter/udleverer disse koder, andre gør ikke. Hvor banken ikke udleverer koderne leveres disse med værdi "NTAV" (not available).

  • domain: [string] Overordnet forretningsområde; ex. betalinger (PMNT:Payments)
  • family: [string] Underordnet forretningsområde; ex. diverse udbetaling (MDOP:Misc. Debit Operations)
  • subFamily: [string] Type af postering; ex. gebyr (CHRG:Charges)
  • text: [string, optional] Tilhørende tekst

{
  "domain": "string",
  "family": "string",
  "subFamily": "string",
  "text": "string"
}
AccountReportDebtor

  • id: [string] Debitors ID (typisk CVR nr.)
  • name: [string] Navn på debitor
  • address: [string] Adresse til debitor
  • postalCode: [string] Post nr.
  • city: [string] Bynavn
  • country: [string] Landekode (ex. "DK" eller "NO")

{
  "id": "string",
  "name": "string",
  "address": "string",
  "postalCode": "string",
  "city": "string",
  "country": "string"
}
AccountReportCreditor

  • id: [string] Kreditors ID (typisk CVR nr.)
  • name: [string] Navn på kreditor
  • address: [string] Adresse til kreditor
  • postalCode: [string] Post nr.
  • city: [string] Bynavn
  • country: [string] Landekode (ex. "DK" eller "NO")

{
  "id": "string",
  "name": "string",
  "address": "string",
  "postalCode": "string",
  "city": "string",
  "country": "string"
}