Claim lines per claim¶

GET Retrieve the list of lines for a claim from PharmaPortal.

Users of PharmaPortal can retrieve the list of lines per claim from their own system via an API. This is a REST API with a single endpoint and a single action.

Access

Available to PharmaPortal licence holders only.

Endpoint¶

TestProduction

GET https://demo.pharma-portal.nl/api/claims/regels/{claimID}

GET https://www.pharma-portal.nl/api/claims/regels/{claimID}

Parameter	In	Type	Required	Description
`claimID`	path	string	yes	Claim ID; retrieved via the claim list API.

Authentication¶

This API uses IP whitelisting and an API key. Send the header:

Header	Description
`x-portal-key`	The API key issued to your organisation.

Request¶

Requests are GET requests.

curl https://demo.pharma-portal.nl/api/claims/regels/8711722006004-1-brocacef-3 \
  -H "x-portal-key: <your-api-key>"

Response¶

Code	Meaning
`200`	Correct request.
`401`	Invalid authentication or HMAC.

Example of a successful response:

{
  "claim": "8711722006004-1-brocacef-3",
  "numRegels": 53,
  "regels": [
    {
      "Regelnummer": 1, # Line number from the claim
      "RegelType": 'D', # Line type per FIX specification
      "DatumVan": '2019-02-01', # Claim period start date
      "DatumTot": '2019-02-28', # Claim period end date
      "IdfKlant": "8154", # Customer IDF
      "GlnKlant": "", # Customer GLN
      "NaamKlant": "St.A. van Leeuwenhoek afdeling", # customer name according to wholesaler
      "KlantId": 631205, # PI Code of linked customer
      "Gtin": "5055565719534", # Product GTIN
      "ZindexNummer": 16233123, # Product ZI number
      "ArtnrLeverancier": "", # Supplier article number of product
      "EtiketNaam": "Temozolomide@ harde caps 180mg  acc", # Product description
      "Eenheid1": "5", # Package quantity
      "Eenheid2": "ST", # Package unit
      "ContractPrijsCenten": 1010, # Contract price in cents  # See FIX specification
      "Kortingspercentage1Basispunten": 0, # See FIX specification
      "Kortingspercentage2Basispunten": 0, # See FIX specification
      "InkoopPrijsCenten": 1501, # GIP price, see FIX specification
      "ClaimpercentageBasispunten": 0, # Claim %, see FIX specification
      "ClaimbedragCenten": 75,  # Claim amount in cents, see FIX specification
      "AantalVerpakkingenGeleverd": 10, # Number of packages delivered
      "Claim1BedragCenten": 5000, # See FIX specification
      "Claim2BedragCenten": 751, # See FIX specification
      "ClaimTotaalBedragCenten": 5751, # See FIX specification
      "ClaimPeriode": {
        "date": "2019-02-01 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe\/Amsterdam"
      }, # Claim period start date, from claim file
      "ClaimGrondslag": "G",  # Basis: [G]IP, [T]ransaction or [A]IP, see FIX specification
      "IsContractprijsCorrect": true, # Whether contract is correct according to PharmaPortal
      "IsInkoopprijsCorrect": false, # Whether GIP is correct according to PharmaPortal
      "IsGeaccordeerd": false, # Whether line is approved
      "AkkoordSoort": 0, # 0 = not approved, 1 = automatically approved, 2 = approved after employee intervention
      "AipBedragCenten": 51400 # AIP at time of dispensing
    },(...)
]
}

Fields¶

Field	Type	Description
`claim`	string	Claim ID as requested.
`numRegels`	integer	Number of claim lines.
`regels`	object[]	The claim lines (see below).

Fields per line:

Field	Type	Description
`Regelnummer`	integer	Line number from the claim.
`RegelType`	string	Line type per FIX specification.
`DatumVan`	string	Claim period start date.
`DatumTot`	string	Claim period end date.
`IdfKlant`	string	Customer IDF.
`GlnKlant`	string	Customer GLN.
`NaamKlant`	string	Customer name according to wholesaler.
`KlantId`	integer	PI Code of linked customer.
`Gtin`	string	Product GTIN.
`ZindexNummer`	integer	Product ZI number.
`ArtnrLeverancier`	string	Supplier article number of product.
`EtiketNaam`	string	Product description.
`Eenheid1`	string	Package quantity.
`Eenheid2`	string	Package unit.
`ContractPrijsCenten`	integer	Contract price in cents (see FIX specification).
`Kortingspercentage1Basispunten`	integer	See FIX specification.
`Kortingspercentage2Basispunten`	integer	See FIX specification.
`InkoopPrijsCenten`	integer	GIP price (see FIX specification).
`ClaimpercentageBasispunten`	integer	Claim percentage (see FIX specification).
`ClaimbedragCenten`	integer	Claim amount in cents (see FIX specification).
`AantalVerpakkingenGeleverd`	integer	Number of packages delivered.
`Claim1BedragCenten`	integer	See FIX specification.
`Claim2BedragCenten`	integer	See FIX specification.
`ClaimTotaalBedragCenten`	integer	See FIX specification.
`ClaimPeriode`	object	Claim period start date, from claim file.
`ClaimGrondslag`	string	Basis: [G]IP, [T]ransaction or [A]IP (see FIX specification).
`IsContractprijsCorrect`	boolean	Whether contract is correct according to PharmaPortal.
`IsInkoopprijsCorrect`	boolean	Whether GIP is correct according to PharmaPortal.
`IsGeaccordeerd`	boolean	Whether line is approved.
`AkkoordSoort`	integer	0 = not approved, 1 = automatically approved, 2 = approved after employee intervention.
`AipBedragCenten`	integer	AIP at time of dispensing.

Notes

Want to test your integration? Contact us in good time at info@zagis.nl. We will then prepare test data and provide you with an API key.