PI - API Docs

Voor gebruikers van PharmaPortal is het mogelijk om via een API vanuit een eigen systeem de lijst met regels per claim op te vragen uit PharmaPortal.

Deze API is een REST api met 1 endpoint en 1 mogelijke actie

Test API endpoint:
https://demo.pharma-portal.nl/api/claims/regels/[claimID]

Productie API endpoint:
https://www.pharma-portal.nl/api/claims/regels/[claimID]

[claimID] kan worden opgehaald via de claim lijst API

Response

Deze API retourneert de volgende HTTP status codes:

401 Bij foutieve authenticatie of HMAC
200 Bij een correct request

Voorbeeld van een response bij een succesvol & correct request:

{
  "claim": "8711722006004-1-brocacef-3",
  "numRegels": 53,
  "regels": [
    {
      "Regelnummer": 1, # Regelnummer uit de claim
      "RegelType": 'D', # Regeltype conform FIX specificatie
      "DatumVan": '2019-02-01', # Begindatum claimperiode
      "DatumTot": '2019-02-28', # Einddatum claimperiode
      "IdfKlant": "8154", # IDF van klant
      "GlnKlant": "", # GLN van klant
      "NaamKlant": "St.A. van Leeuwenhoek afdeling", # naam klant volgens groothandel
      "KlantId": 631205, # PI Code van gekoppelde klant
      "Gtin": "5055565719534", # GTIN van product
      "ZindexNummer": 16233123, # ZI# van product
      "ArtnrLeverancier": "", # Artikelnummer leverancier van product
      "EtiketNaam": "Temozolomide@ harde caps 180mg  acc", # Omschrijving van product
      "Eenheid1": "5", # Verpakkingshoeveelheid
      "Eenheid2": "ST", # Verpakkingseenheid
      "ContractPrijsCenten": 1010, # Contractprijs in centen  # Zie FIX specificatie
      "Kortingspercentage1Basispunten": 0, # Zie FIX specificatie
      "Kortingspercentage2Basispunten": 0, # Zie FIX specificatie
      "InkoopPrijsCenten": 1501, # GIP Prijs Zie FIX specificatie
      "ClaimpercentageBasispunten": 0, # Claim %, Zie FIX specificatie
      "ClaimbedragCenten": 75,  # Claimbedrag in centen, Zie FIX specificatie
      "AantalVerpakkingenGeleverd": 10, # Aantal verpakkingen geleverd
      "Claim1BedragCenten": 5000, # Zie FIX specificatie
      "Claim2BedragCenten": 751, # Zie FIX specificatie
      "ClaimTotaalBedragCenten": 5751, # Zie FIX specificatie
      "ClaimPeriode": {
        "date": "2019-02-01 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe\/Amsterdam"
      }, # Ingangsdatum van claimperiode, uit claimbestand
      "ClaimGrondslag": "G",  # Grondslag [G]IP, [T]ransactie of [A]IP, Zie FIX specificatie
      "IsContractprijsCorrect": true, # Is contract correct volgens PharmaPortal
      "IsInkoopprijsCorrect": false, # Is GIP correct volgens PharmaPortal
      "IsGeaccordeerd": false, # Is regel akkoord
      "AkkoordSoort": 0, # 0 = Niet akkoord, 1 = Automatisch akkoord, 2 = Akkoord na interventie medewerker
      "AipBedragCenten": 51400 # AIP op moment van verstrekken
    },(...)
]
}

PharmaPortal Claimregels API

Authenticatie

Headers

Request

Response

Aandachtspunten