Contracts by reference date¶

GET Retrieve the list of active contracts by reference date from PharmaPortal.

Users of PharmaPortal can retrieve the list of active contracts by reference date from their own system via an API. This is a REST API with a single endpoint and one action (with or without a reference date).

Access

Available to PharmaPortal licence holders only.

Endpoint¶

TestProduction

GET https://demo.pharma-portal.nl/api/contracten/lijst
GET https://demo.pharma-portal.nl/api/contracten/lijst/[reference date 1]/[reference date 2]

GET https://www.pharma-portal.nl/api/contracten/lijst
GET https://www.pharma-portal.nl/api/contracten/lijst/[reference date 1]/[reference date 2]

Calling without [reference date 1] returns the active contracts on the current date. Calling with [reference date 2] returns the active contracts between reference date 1 and reference date 2.

Parameter	In	Type	Required	Description
`reference date 1`	path	string (`YYYY-MM-DD`)	no	Active contracts on this reference date. Omit for the current date.
`reference date 2`	path	string (`YYYY-MM-DD`)	no	Active contracts between reference date 1 and reference date 2. Omitting it returns the contracts active on reference date 1.

Limits

The following limits apply to this endpoint:

The period between reference date 1 and reference date 2 may span at most 1 year.
Reference date 2 must not lie before reference date 1.
The result may contain at most 1000 contracts.

Outside these limits the endpoint returns a 400 response with a JSON error message. For larger periods or result sets, use the paginated v2 API.

Authentication¶

This API uses IP whitelisting for security and an API key for authentication & 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/contracten/lijst \
  -H "x-portal-key: <your-api-key>"

Response¶

Code	Meaning
`200`	Correct request.
`400`	Invalid date, invalid period, or more than 1000 results (see limits above). Body: `{"result":"error","errorMessage":"…"}`.
`401`	Invalid authentication or HMAC.

Example of a successful response:

[
    {
        "startDatum": "YYYY-MM-DD",
        "eindDatum": "YYYY-MM-DD",
        "opmerkingen": "opmerking",
        "piCode": 671234,
        "zindexNummer": 12345678,
        "isExclusief": true, // or false
        "prijsPerVerpakking": 1.23, // When fixed price
        "kortingPercentage": 50, // 50%, when discount vs AIP
        "soortAfspraak": 1, // 1 = Fixed price, 2 = Discount vs AIP
        "herkomst": "Herkomst",
        "leveringVia": 1, // 1 = Direct, 2 = Wholesaler
        "isLPL": false, // or true
        "trajectSlug": "1-trajectnaam",
        "contractGroep": "ID van contractgroep",
        "contractGroepVolume": 100, // Issued volume of the entire contract group
        "createdAt": "YYYY-MM-DD HH:mm:ss",
        "updatedAt": "YYYY-MM-DD HH:mm:ss"
    },
    {
        "startDatum": "YYYY-MM-DD",
        "eindDatum": "YYYY-MM-DD",
        "opmerkingen": "opmerking",
        "piCode": 671234,
        "zindexNummer": 12345678,
        "isExclusief": true, // or false
        "prijsPerVerpakking": 1.23, // When fixed price
        "kortingPercentage": 50, // 50%, when discount vs AIP
        "soortAfspraak": 1, // 1 = Fixed price, 2 = Discount vs AIP
        "herkomst": "Herkomst",
        "leveringVia": 1, // 1 = Direct, 2 = Wholesaler
        "isLPL": false, // or true
        "trajectSlug": "1-trajectnaam",
        "contractGroep": "ID van contractgroep",
        "contractGroepVolume": 100, // Issued volume of the entire contract group
        "createdAt": "YYYY-MM-DD HH:mm:ss",
        "updatedAt": "YYYY-MM-DD HH:mm:ss"
    }
]

Fields¶

Field	Type	Description
`startDatum`	string	Contract start date.
`eindDatum`	string	Contract end date.
`opmerkingen`	string	Remark.
`piCode`	integer	PI-Code of the party.
`zindexNummer`	integer	Z-Index number of the article.
`isExclusief`	boolean	Exclusive contract (`true`/`false`).
`prijsPerVerpakking`	number	Price per package, when fixed price.
`kortingPercentage`	number	Discount percentage vs AIP, when discount.
`soortAfspraak`	integer	`1` = Fixed price, `2` = Discount vs AIP.
`herkomst`	string	Origin.
`leveringVia`	integer	`1` = Direct, `2` = Wholesaler.
`isLPL`	boolean	`true`/`false`.
`trajectSlug`	string	Slug of the trajectory.
`contractGroep`	string	ID of the contract group.
`contractGroepVolume`	integer	Issued volume of the entire contract group.
`createdAt`	string	Creation timestamp (`YYYY-MM-DD HH:mm:ss`).
`updatedAt`	string	Update timestamp (`YYYY-MM-DD HH:mm:ss`).

Notes

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