Transaction Export API Documentation

Overview

The Transaction Export API allows authorized organizations to export transaction data in CSV format using API Key authentication.

Prerequisites

To use this API, your organization must have the following licenses:

1. APIKEY - Required to issue API keys
2. EXTERNE_TRANSACTIE_EXPORT - Required to trigger exports

Authentication

Obtaining an API Key

1. Navigate to the API Key Management UI at: https://www.zorgdomein.nl/zd/management/api-key
2. Create a new API key and configure the allowed IP addresses or IP ranges from which you plan to access the API:
   • You can specify individual IP addresses (e.g., 192.168.1.100)
   • You can specify IP ranges using CIDR notation/IP masks (e.g., 192.168.1.0/24)
3. Store your API key securely

Using the API Key

Include the following header in your request:

• Authorization: Bearer <api-key>

Important: Requests must originate from an IP address within the allowed range configured when creating the API key.

API Endpoint

Export Transactions

Exports transaction data for a single day in CSV format.

Endpoint: POST https://www.zorgdomein.nl/api/v1/export/transactions

Request Headers:

Authorization: Bearer <your-api-key>
Content-Type: application/json

Request Body:

{
  "type": "daily",
  "date": "2025-10-27",
  "includeUpdated": false
}

Parameters:

• type (string, required): Must be "daily"
• date (string, required): Date in ISO format (YYYY-MM-DD)
• includeUpdated (boolean, optional): When true, includes transactions updated within the date range in addition to transactions created on that date. Default is false.

Date Constraints:

• Date cannot be in the future
• Date must be within the last 18 months from today

Success Response (200 OK):

The response is a CSV file with the following headers:

• Content-Type: text/csv; charset=UTF-8
• Content-Disposition: attachment; filename="transactions-fullset_YYYY-MM-DD-YYYY-MM-DD.csv"

Rate Limiting

The Transaction Export API is rate-limited to prevent abuse and ensure fair resource distribution.

Rate Limit: 60 requests per hour per IP address

Behavior when rate limit is exceeded:

When you exceed the rate limit, the API returns a 429 Too Many Requests response with the following body:

{
  "error": "Rate limit exceeded. Maximum 60 requests per 3600 seconds."
}

Error Responses

401 Unauthorized

Invalid API key or token verification failed.

Example Request

curl -X POST https://www.zorgdomein.nl/api/v1/export/transactions \
  -H "Authorization: Bearer your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "daily",
    "date": "2025-10-27",
    "includeUpdated": false
  }' \
  --output transactions-2025-10-27.csv

Support

For questions or issues with the API, please contact Zorgdomein support.