PayrollPaychecks

GetPayrollPaycheckPerEmployee

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
payrollUid required	string <uuid>
employeePayrollUid required	string <uuid>

query Parameters

api-version

string

Responses

200

get/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeePayrollUid}/paychecks

Request samples

C#
Java
Python
JavaScript
curl

Response samples

[{"payrollEmployeeFk": 0,
"name": "string",
"unit": 0,
"paymentPerUnit": 0,
"payCheckFor": 0,
"regNumber": "string",
"kontoNumber": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]

InsertPayrollPaycheckPerEmployee

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
payrollUid required	string <uuid>
employeePayrollUid required	string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

payCheckFor	integer <int32> Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
name required	string [ 0 .. 128 ] characters
unit	number <double>
paymentPerUnit	number <double>
rateUid	string <uuid>
regNumber	string
kontoNumber	string
includeInPensionBase	boolean
includeInAmPensionBase	boolean
isIncludedInHolidayEntitlementSalary	boolean
departmentUid	string <uuid>
costCenterUid	string <uuid>
profitCenterUid	string <uuid>
percentage	number <double>
isIncludedInHolidayEntitlementSalaryReduction	boolean

Responses

200

post/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeePayrollUid}/paychecks

Request samples

{"payCheckFor": 0,
"name": "string",
"unit": 0,
"paymentPerUnit": 0,
"rateUid": "00000000-0000-0000-0000-000000000000",
"regNumber": "string",
"kontoNumber": "string",
"includeInPensionBase": true,
"includeInAmPensionBase": true,
"isIncludedInHolidayEntitlementSalary": true,
"departmentUid": "00000000-0000-0000-0000-000000000000",
"costCenterUid": "00000000-0000-0000-0000-000000000000",
"profitCenterUid": "00000000-0000-0000-0000-000000000000",
"percentage": 0,
"isIncludedInHolidayEntitlementSalaryReduction": true
}

Response samples

{"source": "string",
"payCheckFor": 0,
"name": "string",
"unit": 0,
"paymentPerUnit": 0,
"rate": {"hasOverride": true,
"accountType": 0,
"accountNumber": "string",
"accountText": "string",
"wageCode": "string",
"creditAccountNumber": "string",
"regNumber": "string",
"kontoNumber": "string",
"isDeleted": true,
"isProratedRate": true,
"includeInPensionBase": true,
"includeInAmPensionBase": true,
"isIncludedInHolidayEntitlementSalary": true,
"useSupplementRates": true,
"useHourRates": true,
"composedRates": "string",
"calculateOnPercentage": true,
"percentageInfoText": "string",
"calculateOnGrossSalary": true,
"isFromTemplate": true,
"predefinedRateType": 0,
"isIncludedInHolidayEntitlementSalaryReduction": true,
"number": "string",
"type": 0,
"limitedToEmployee": true,
"isBenefitPackageTwoEnabled": true,
"overrideRate": true,
"hours": 0,
"overrideName": true,
"employees": ["00000000-0000-0000-0000-000000000000"
],
"departments": ["00000000-0000-0000-0000-000000000000"
],
"rate": 0,
"name": "string",
"percentage": 0,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"regNumber": "string",
"kontoNumber": "string",
"isProrated": true,
"proratedAmount": 0,
"costCenterCode": "string",
"costCenterName": "string",
"countrySpecificDto": {"countryUid": "00000000-0000-0000-0000-000000000000",
"countryName": "string",
"countryCode": "string",
"countryId": "string",
"countryTaxPercentage": 0,
"countryTaxableIncome": true
},
"registrationDate": "2019-08-24T14:15:22Z",
"shouldTriggerRetro": true,
"includeInPensionBase": true,
"includeInAmPensionBase": true,
"isIncludedInHolidayEntitlementSalary": true,
"createdOn": "2019-08-24T14:15:22Z",
"department": {"isDeleteAllowed": true,
"responsiblePersons": [{"incomeType": 0,
"holidayPayReceiverType": 0,
"extraHolidayEntitlementRule": "string",
"name": "string",
"employeeNumber": "string",
"extraEmployeeNumber": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"companyWorkSchemas": [{"name": "string",
"workingHoursPerDay": 0,
"canBeDeleted": true,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"name": "string",
"number": "string",
"hasWorkSchema": true,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"costCenter": {"numberOfEmployees": 0,
"employeeUids": ["00000000-0000-0000-0000-000000000000"
],
"costCenterName": "string",
"costCenterCode": "string",
"type": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"profitCenter": {"numberOfEmployees": 0,
"employeeUids": ["00000000-0000-0000-0000-000000000000"
],
"costCenterName": "string",
"costCenterCode": "string",
"type": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"percentageInfoText": "string",
"calculatedAmount": 0,
"hours": 0,
"percentage": 0,
"isIncludedInHolidayEntitlementSalaryReduction": true,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}

DeletePayrollPaycheckPerEmployee

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
payrollUid required	string <uuid>
employeePayrollUid required	string <uuid>
payrollPaycheckUid required	string <uuid>

query Parameters

api-version

string

Responses

204

No Content

delete/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeePayrollUid}/paychecks/{payrollPaycheckUid}

Request samples

C#
Java
Python
JavaScript
curl

PatchPayrollPaycheckPerEmployee

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
employeePayrollUid required	string <uuid>
payrollPaycheckUid required	string <uuid>
payrollUid required	string

query Parameters

api-version

string

Request Body schema:
application/json

payCheckFor	integer <int32> Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
name required	string [ 0 .. 128 ] characters
unit	number <double>
paymentPerUnit	number <double>
rateUid	string <uuid>
regNumber	string
kontoNumber	string
includeInPensionBase	boolean
includeInAmPensionBase	boolean
isIncludedInHolidayEntitlementSalary	boolean
departmentUid	string <uuid>
costCenterUid	string <uuid>
profitCenterUid	string <uuid>
percentage	number <double>
isIncludedInHolidayEntitlementSalaryReduction	boolean

Responses

200

patch/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeePayrollUid}/paychecks/{payrollPaycheckUid}

Request samples

{"payCheckFor": 0,
"name": "string",
"unit": 0,
"paymentPerUnit": 0,
"rateUid": "00000000-0000-0000-0000-000000000000",
"regNumber": "string",
"kontoNumber": "string",
"includeInPensionBase": true,
"includeInAmPensionBase": true,
"isIncludedInHolidayEntitlementSalary": true,
"departmentUid": "00000000-0000-0000-0000-000000000000",
"costCenterUid": "00000000-0000-0000-0000-000000000000",
"profitCenterUid": "00000000-0000-0000-0000-000000000000",
"percentage": 0,
"isIncludedInHolidayEntitlementSalaryReduction": true
}

Response samples

{"source": "string",
"payCheckFor": 0,
"name": "string",
"unit": 0,
"paymentPerUnit": 0,
"rate": {"hasOverride": true,
"accountType": 0,
"accountNumber": "string",
"accountText": "string",
"wageCode": "string",
"creditAccountNumber": "string",
"regNumber": "string",
"kontoNumber": "string",
"isDeleted": true,
"isProratedRate": true,
"includeInPensionBase": true,
"includeInAmPensionBase": true,
"isIncludedInHolidayEntitlementSalary": true,
"useSupplementRates": true,
"useHourRates": true,
"composedRates": "string",
"calculateOnPercentage": true,
"percentageInfoText": "string",
"calculateOnGrossSalary": true,
"isFromTemplate": true,
"predefinedRateType": 0,
"isIncludedInHolidayEntitlementSalaryReduction": true,
"number": "string",
"type": 0,
"limitedToEmployee": true,
"isBenefitPackageTwoEnabled": true,
"overrideRate": true,
"hours": 0,
"overrideName": true,
"employees": ["00000000-0000-0000-0000-000000000000"
],
"departments": ["00000000-0000-0000-0000-000000000000"
],
"rate": 0,
"name": "string",
"percentage": 0,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"regNumber": "string",
"kontoNumber": "string",
"isProrated": true,
"proratedAmount": 0,
"costCenterCode": "string",
"costCenterName": "string",
"countrySpecificDto": {"countryUid": "00000000-0000-0000-0000-000000000000",
"countryName": "string",
"countryCode": "string",
"countryId": "string",
"countryTaxPercentage": 0,
"countryTaxableIncome": true
},
"registrationDate": "2019-08-24T14:15:22Z",
"shouldTriggerRetro": true,
"includeInPensionBase": true,
"includeInAmPensionBase": true,
"isIncludedInHolidayEntitlementSalary": true,
"createdOn": "2019-08-24T14:15:22Z",
"department": {"isDeleteAllowed": true,
"responsiblePersons": [{"incomeType": 0,
"holidayPayReceiverType": 0,
"extraHolidayEntitlementRule": "string",
"name": "string",
"employeeNumber": "string",
"extraEmployeeNumber": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"companyWorkSchemas": [{"name": "string",
"workingHoursPerDay": 0,
"canBeDeleted": true,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"name": "string",
"number": "string",
"hasWorkSchema": true,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"costCenter": {"numberOfEmployees": 0,
"employeeUids": ["00000000-0000-0000-0000-000000000000"
],
"costCenterName": "string",
"costCenterCode": "string",
"type": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"profitCenter": {"numberOfEmployees": 0,
"employeeUids": ["00000000-0000-0000-0000-000000000000"
],
"costCenterName": "string",
"costCenterCode": "string",
"type": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"percentageInfoText": "string",
"calculatedAmount": 0,
"hours": 0,
"percentage": 0,
"isIncludedInHolidayEntitlementSalaryReduction": true,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}

PayrollPaychecks

GetPayrollPaycheckPerEmployee

path Parameters

query Parameters

InsertPayrollPaycheckPerEmployee

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

DeletePayrollPaycheckPerEmployee

path Parameters

query Parameters

PatchPayrollPaycheckPerEmployee

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

Request Body schema:
application/json

Request Body schema:
application/json