Skip to content

Claims — list

GET Retrieve the list of imported claims from PharmaPortal.

Users of PharmaPortal can retrieve the list of imported claims from their own system via an API. This is a REST API with a single endpoint and one possible action.

Access

Available to PharmaPortal licence holders only.

Endpoint

GET https://demo.pharma-portal.nl/api/claims/list/[jaar]

GET https://www.pharma-portal.nl/api/claims/list/[jaar]
Parameter In Type Required Description
jaar path string no Year for which claims are retrieved. If left empty, the current year is used automatically.

Authentication

This API uses IP whitelisting and an API key for authentication and rate limiting. 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/list/2019 \
  -H "x-portal-key: <your-api-key>"

Response

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

Example of a successful response:

{
  "jaar": "2019",
  "numClaims": 2,
  "claims": [
    {
      "GroothandelPiCode": "871079",                      // PI code referring to the wholesaler
      "ControleResultaat": "3",                           // 1 = Correct, 2 = Accepted with differences, 3 = Awaiting correction, 4 = Correction received, 5 = In progress
      "LaatsteControleOp": null,                          // Time of the last check by the user
      "ClaimType": "W",                                   // File type per the FIX specification
      "Volgnummer": "44",                                 // Sequence number of the file, provided by the wholesaler
      "NaamAfzender": "Brocacef BV BCF Zorglogistiek",    // Name of the sender, provided by the wholesaler
      "BestandsDatum": "2019-02-01",                      // Date the file was created by the wholesaler
      "Slug": "8711722006004-1-brocacef-2"                // Unique ID to retrieve claim lines via the API
    },
    {
      "GroothandelPiCode": "871079",
      "ControleResultaat": "2",
      "LaatsteControleOp": null,
      "ClaimType": "W",
      "Volgnummer": "44",
      "NaamAfzender": "Brocacef BV BCF Zorglogistiek",
      "BestandsDatum": "2019-02-01",
      "Slug": "8711722006004-1-brocacef-3"
    }
  ]
}

Fields

Field Type Description
jaar string Year the claims relate to.
numClaims integer Number of claims in the response.
claims object[] List of claims.
GroothandelPiCode string PI code referring to the wholesaler.
ControleResultaat string 1 = Correct, 2 = Accepted with differences, 3 = Awaiting correction, 4 = Correction received, 5 = In progress.
LaatsteControleOp string Time of the last check by the user.
ClaimType string File type per the FIX specification.
Volgnummer string Sequence number of the file, provided by the wholesaler.
NaamAfzender string Name of the sender, provided by the wholesaler.
BestandsDatum string Date the file was created by the wholesaler.
Slug string Unique ID to retrieve claim lines via the API.

Notes

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