v1/employments_surveys/{id}

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

company_id

int32

≥ 1

ID of a shyftplan account.

bank_account_holder

string

Bank Account Holder

bank_account_number

string

IBAN

bank_identifier_code

string

BIC

bank_name

string

Name of the Bank

birth_date

date

Format: yyyy-mm-dd

birth_name

string

Fill in case of never_worked_in_germany is set to true. If you are married and carry a different last name now, enter the last name you were given at birth here. Otherwise leave blank.

birth_place

string

Fill in case of never_worked_in_germany is set to true.

capital_forming_benefits_bank_name

string

Fill if has_capital_forming_benefits is true. Institute that issued your contract

capital_forming_benefits_contract_number

string

Fill if has_capital_forming_benefits is true. Contract number

capital_forming_benefits_contract_start

date

Fill if has_capital_forming_benefits is true. Commencement of the contract. Format: yyyy-mm-dd

capital_forming_benefits_employers_contribution

float

Fill if has_capital_forming_benefits is true. Employer’s contribution

capital_forming_benefits_total

float

Fill if has_capital_forming_benefits is true. Total amount per month

city

string

Put city when other_address is true

country

string

enum

Defaults to DE

Select country when other_address is true

children_allowance

float

Fill if has_children is true. In general you are entitled to one children’s allowance per year and per child, which includes all underaged children and under certain conditions also children until the completion of their 25th year of life (see: https://service.berlin.de/dienstleistung/325821/). Further, a so-called relief amount for single parents is automatically deducted in tax category II.

children_count

int32

Fill if has_children is true.

children_proof

string

enum

Selcet if has_children is true

Allowed:

comments

string

Additional comments

date_of_entry

date

Start date of employment. Note that this date will be visible in the GUI not in the survey but in the employment profile. Format: yyyy-mm-dd

denomination

string

enum

Relevant for the deduction of church tax from your gross pay.

employment_relationship

string

enum

Status of employment. As of now only german taxation options

employment_type

string

enum

Select one if employment_relationship is of any type but minijob

Allowed:

family_status

string

enum

Martial status

Allowed:

first_name

string

First Name of the Employee

further_minijobs

boolean

Defaults to false

In order to correctly calculate your social security contributions, the payroll department needs a complete overview of all your employment relationships. If details are wrong or missing, then you and your employer might have to pay the outstanding contributions later all at once.

gender

string

enum

Gender of the Employee

Allowed:

has_capital_forming_benefits

boolean

Defaults to false

Captial-forming benefits

has_children

boolean

Defaults to false

health_insurance_identification_number

string

On the backside of health insurance card you can find “7. Kennnummer des Trägers” consisting of a number and then the name of health insurance provider (Enter if employment_relationship is not minijob)

health_insurance_name

string

On the backside of health insurance card you can find “7. Kennnummer des Trägers” consisting of a number and then the name of health insurance provider (Enter if employment_relationship is not minijob)

highest_level_of_education

string

enum

Highest level of education

Allowed:

highest_school_degree

string

enum

Highest school degree

Allowed:

internship_certificate

file

Upload a PDF file not more than 4MB if employment_relationship is internship

job_description

string

Main activity at work

last_name

string

Last Name of the Employee

minijob_salary

float

Enter a value between 1 - 450 if further_minijobs is true

middle_name

string

Other given names

nationality

string

enum

Defaults to DE

Nationality of the Employee

never_worked_in_germany

boolean

Defaults to false

When you are working in Germany for the first time, we need to request a social security number for you from the German pension insurance

other_address

boolean

Defaults to false

By default the adress of the User model is used. If you want to use an alternative one set this value to true and fill out all address fields.

pension_insurance_exemption

string

enum

Select one if employment_relationship is of type minijob

Allowed:

social_security_number

string

The social security number serves to associate social security contributions with your person. Those social security contributions and the wage tax are deducted from your gross salary, which leads to the net salary visible in your bank account. Your social security contributions are important for you to continue receiving money in the case of an accident or illness and the longer you pay contributions, the higher will be your pension too. Therefore the social security number is also called pension insurance number. The number consists of 11 digits and 1 letter and amongst other things it contains your date of birth. This number will only be issued once in your life and you can inquire about it at your health insurance provider or contact the German Pension Insurance (in a subsidiary near you or via their free service hotline 0800/1000 480 25).

street

string

Put street when other_address is true

street_number

string

Put street_number when other_address is true

tax_bracket

string

enum

Select tax bracket

tax_bracket_factor

float

Fill if tax_bracket is "IV with factor" (Value between 0.000 - 1.000)

tax_identification_number

string

The tax identification number (also called personal identification number, IdNr. or tax ID) has life-long validity and consists of 11 digits. Every person registered in Germany automatically receives a tax identification number. You can find it on your income tax assessment note or on the income tax notification of any year, but not on your monthly pay slip. Also don’t confuse this number with the eTIN! In case you really can’t find your tax ID anymore, you can use this form to request the number to be send to you via mail - it may take up to four weeks

zip

string

Put zip when other_address is true