Administrative Data
Less than to read
Health Insurance Information
The Sage Business Cloud Payroll API provides call to retrieve a list of all health insurances in Germany starting January 1st, 2015. The list can be retrieved as a CSV file:
GET /api/v1/healthinsurances.csv HTTP/1.1
Host: lohnabrechnung.sage.com
Accept: text/csv
The .csv file contains entries in the following format (5 values per health insurance, separated by a semicolon):
| Field name | Description |
|---|---|
AvailableFrom (may be empty) |
The first day as of which this health insurance was operating (if after 01-01-2015) |
AvailableFrom (may be empty) |
The last day until which this health insurance was operating |
CompanyName |
The name of the health insurance |
CompanyNumber |
Company registration number (“Betriebsnummer”) |
Replacement (may be empty) |
If a health insurance is not operating any longer, there may be a legal successor, for example if insurances merge. In this case, the company registration number of that successor can be provided here |
- If none of the dates is specified, then it is assumed that the health insurance is operating today and has started at least before January 1st, 2015. The health insurance specified for a new employee needs to be operating at the time of entry of the new employee.
- Data entries in the list use the ISO 8601 format (yyyy-mm-ddThh:mm:ss)
Example:
Health insurance “BKK GS ehemalig BKK BJB” has the following list entry:
CompanyNumber;CompanyName;AvailableFrom;AvailableTo;Replacement
41690170;"BKK GS ehemalig BKK BJB";;2015-09-30T00:00:00;31323802
So this health insurance operated until September 30, 2015. Afterwards, the health insurance with the company
registration number 31323802 took over operations.
An employee assigned to this health insurance needs to be assigned a different health insurance after September 2015, else the payroll run in Sage Business Cloud Payroll reports an error for runs starting October 2015. As a default, the employee is assigned automatically to the successor health insurance.
It is recommended to download the list of health insurances once a month to identify and changes.
Country Information
The Sage Business Cloud Payroll API provides call to retrieve a list of all supported countries and the codes to be used for them. The list can be retrieved as a CSV file:
GET /api/v1/countries.csv HTTP/1.1
Host: lohnabrechnung.sage.com
Accept: text/csv
The .csv file contains entries in the following format (3 values per country, separated by a semicolon):
| Field name | Description |
|---|---|
ID |
Country code |
Country |
Name of country |
Nationality |
Nationality for the country to use as text in communication (e. g. “deutsch” for “Deutschland”) |
Account Owner
To retrieve the account owner, a separate API invocation is provided which returns the name of the account owner. This is the name provided when registering your application:
GET /api/v1/username HTTP/1.1
Host: lohnabrechnung.sage.com
Accept: application/json
The name of the account owner is returned in the data field. Note that authentication credentials
need to have been established.