POST
/
germany
/
wage-types
Create Wage Type
curl --request POST \
  --url https://api.example.com/germany/wage-types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "wageTypeNumber": 1000,
  "name": "Basic Salary"
}
'
{
  "id": 123,
  "wageTypeNumber": 123,
  "name": "<string>",
  "isTotalGrossComponent": true,
  "componentType": "gross_earning",
  "taxTreatment": "recurring_wage",
  "taxCertificateLineItem": "<string>",
  "socialSecurityTreatment": "recurring_wage",
  "isSvRelevantComponent": true,
  "isReimbursableAag": true,
  "isAccidentInsuranceRelevant": true,
  "isGlComponent": true,
  "isAverageEarningsComponent": true,
  "garnishmentTreatment": "full",
  "isMinimumWageComponent": true,
  "validFrom": "2023-12-25",
  "validTo": "2023-12-25"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request schema for creating a German wage type

​
wageTypeNumber
integer
required

The business key of the wage type

Example:

1000

​
name
string
required

The name of the wage type

Required string length: 1 - 255
Example:

"Basic Salary"

​
isTotalGrossComponent
boolean
default:true

Component of the total gross (Gesamtbrutto)

​
componentType
enum<string>
default:gross_earning

The component type of the wage, defining its place in the calculation flow

Available options:
gross_earning,
gross_deduction,
net_earning,
net_deduction
​
taxTreatment
enum<string>
default:recurring_wage

The tax treatment for this wage type

Available options:
recurring_wage,
one_time_payment,
flat_rate_tax,
tax_free
​
taxCertificateLineItem
string | null

Points to a line item in the annual tax certificate (Lohnsteuerbescheinigung)

Maximum string length: 100
​
socialSecurityTreatment
enum<string>
default:recurring_wage

The social security treatment for this wage type

Available options:
recurring_wage,
one_time_payment,
social_security_free
​
isSvRelevantComponent
boolean
default:true

Component of Arbeitsentgelt according to §14 SGB IV

​
isReimbursableAag
boolean
default:false

Reimbursable under the Aufwendungsausgleichsgesetz (U1 / U2 coverage)

​
isAccidentInsuranceRelevant
boolean
default:true

Relevant for accident insurance (Unfallversicherung)

​
isGlComponent
boolean
default:false

Component of the base wage (Grundlohn) used for calculating surcharges

​
isAverageEarningsComponent
boolean
default:true

Component of the average earnings used for continued remuneration

​
garnishmentTreatment
enum<string>
default:full

The garnishment treatment (Pfändbarkeit)

Available options:
full,
non_garnishable,
partial
​
isMinimumWageComponent
boolean
default:true

Component of the statutory minimum wage (Mindestlohn)

Response

Successful Response

Response schema for German wage type

​
id
integer
required

Database ID

​
wageTypeNumber
integer
required

The business key of the wage type

​
name
string
required

The name of the wage type

​
isTotalGrossComponent
boolean
required

Component of the total gross (Gesamtbrutto)

​
componentType
enum<string>
required

The component type

Available options:
gross_earning,
gross_deduction,
net_earning,
net_deduction
​
taxTreatment
enum<string>
required

The tax treatment

Available options:
recurring_wage,
one_time_payment,
flat_rate_tax,
tax_free
​
taxCertificateLineItem
string | null
required

Tax certificate line item

​
socialSecurityTreatment
enum<string>
required

The social security treatment

Available options:
recurring_wage,
one_time_payment,
social_security_free
​
isSvRelevantComponent
boolean
required

Component of Arbeitsentgelt

​
isReimbursableAag
boolean
required

Reimbursable under AAG

​
isAccidentInsuranceRelevant
boolean
required

Relevant for accident insurance

​
isGlComponent
boolean
required

Component of base wage

​
isAverageEarningsComponent
boolean
required

Component of average earnings

​
garnishmentTreatment
enum<string>
required

Garnishment treatment

Available options:
full,
non_garnishable,
partial
​
isMinimumWageComponent
boolean
required

Component of minimum wage

​
validFrom
string<date> | null
​
validTo
string<date> | null