Payroll

GetPayrollsForApprovalForUserAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/approval
Request samples
Response samples
{
}

GetPayroll

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}
Request samples
Response samples
{
}

CancelPayroll

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Responses
204

No Content

delete/api/companies/{companyUid}/payroll/{payrollUid}
Request samples

PatchPayrollAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Request Body schema:
dispositionDate
required
string <date-time>
periodFrom
required
string <date-time>
periodTo
required
string <date-time>
selectedEmployeeUid
required
Array of strings <uuid>
hasHolidaySupplementPayout
boolean
hasHolidayPaymentPayout
boolean
hasHolidayPaymentToHolidayPayPayout
boolean
hasBenefitPackagePayout
boolean
hasBenefitPackageTwoPayout
boolean
hasTimeInLieuPayout
boolean
disablePayslipNotification
boolean
sendPayslipNotificationOn
string <date-time>
isPaid
boolean
Array of objects (Zalary.Models.Payroll.PayrollRegistrationPeriodDto)
note
string [ 0 .. 250 ] characters
hasHolidayPaymentTaxationAndTransferToNextYear
boolean
hasHolidayPaymentNettoPayout
boolean
hasFifthHolidayWeekPayout
boolean
extraPayrollRun
boolean
Responses
200

OK

patch/api/companies/{companyUid}/payroll/{payrollUid}
Request samples
{
}
Response samples
"00000000-0000-0000-0000-000000000000"

CheckForActivePayroll

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
type
required
integer <int32>
Enum: 0 1 2 3 4 5
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{type}/active
Request samples
Response samples
{
}

GetPayrollRunnableTypes

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/haspayrolltypes
Request samples
Response samples
{
}

GetPayrollStatus

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/status
Request samples
Response samples
{
}

SetPayrollStatusAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Request Body schema:
status
integer <int32>
Enum: 1 2 4 8 16 17 32 36 64 128 256 512 1024 2048 3072 3089 4096 7379 7383
Responses
200

OK

post/api/companies/{companyUid}/payroll/{payrollUid}/status
Request samples
{
}
Response samples
1

GetCsvExport

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/report/salary
Request samples
Response samples
{ }

GetCompanyPayrollsAccountingTypeInformation

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/accounting-type-information
Request samples
Response samples
{
}

GetVacationCsvExportAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/report/vacation
Request samples
Response samples
"string"

GetWageTypesReportUrlAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/report/wage-types
Request samples
Response samples
"string"

GetPayslipsReportUriAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/payslips/documents
Request samples
Response samples
"string"

RegenerateAllPayslipsAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Responses
204

No Content

post/api/companies/{companyUid}/payroll/{payrollUid}/payslips/documents
Request samples

GetPayrollControlValidationsAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/control/validations
Request samples
Response samples
{
}

GetEmployeePayroll

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
employeeUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeeUid}
Request samples
Response samples
{
}

PatchEmployeePayrollAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
employeeUid
required
string <uuid>
query Parameters
api-version
string
Request Body schema:
object (Zalary.Models.Payroll.EmployeePayrollCorrectionRequest)
object (Zalary.Models.Employee.EmployeeAmPensionRequest)
montlySalaryBase
number <double>
monthlySalaryFixedBase
number <double>
monthlySalaryHourlyBase
number <double>
numberOfHoursBase
number <double>
numberOfHoursFixed
number <double>
salaryMode
integer <int32>
Enum: 0 1 2
loanAmount
number <double>
miles
number <double>
milesLowRate
number <double>
krRate
number <double>
sickDaysUsedBase
number <double>
gDays
number <double>
numberOfUsedVacationDaysBase
number <double>
careDaysUsedBase
number <double>
daysOffUsedBase
number <double>
holidayPaymentUsed
number <double>
isPayoutSaldoEnabled
boolean
benefitPackageUsedBase
number <double>
benefitPackageTwoUsedBase
number <double>
numberOfWorkingDays
number <double>
note
string [ 0 .. 250 ] characters
ancinityRate
number <double>
hasBenefitPackagePayout
boolean
hasHolidaySupplementPayout
boolean
holidaySupplementSaldoPaymentAmount
number <double>
hasTimeInLieuPayout
boolean
holidayPaymentNettoUsed
number <double>
isHolidayPaymentNettoSaldoPayoutEnabled
boolean
vacationAtOwnExpenseUsedBase
number <double>
isHolidayPaymentTransferShSaldoEnabled
boolean
Responses
204

No Content

patch/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeeUid}
Request samples
{
}

GetPayrollControlValidationsDocumentAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
request.validations
Array of integers <int32>
Items Enum: 0 1 2 3
request.description
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 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/control/validations/document
Request samples
Response samples
{ }

GetEmployeePayrollAbsences

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
employeeUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeeUid}/absences
Request samples
Response samples
[
]

GetEmployeePayrollValidationsAsync

Securityoauth2
Request
path Parameters
payrollUid
required
string <uuid>
employeeUid
required
string <uuid>
companyUid
required
string
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeeUid}/validations
Request samples
Response samples
{
}

GetDeviationChanges

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
employeeUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeeUid}/deviation/diff
Request samples
Response samples
{
}

PayslipDocumentUrlPerEmployeeAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
employeePayrollUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/payslips/{employeePayrollUid}/document
Request samples
Response samples
"string"

GetEmployeePayrollFinalCalculatinon

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
employeeUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeeUid}/finalcalculation
Request samples
Response samples
{
}

GetEmployeeStandardRate

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
employeePayrollUid
required
string <uuid>
payrollUid
required
string
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeePayrollUid}/standard-rate
Request samples
Response samples
0
0

GetPayrollReportStatusAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
reportType
required
integer <int32>
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/control/report/status
Request samples
Response samples
0
0

GetEmployeePayrollPayslipStatusAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
employeePayrollUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeePayrollUid}/payslip/status
Request samples
Response samples
0
0

DownloadPayrollReportAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
reportType
required
integer <int32>
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
format
required
integer <int32>
Enum: 1 2 3 4
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/control/report
Request samples
Response samples
"string"

GeneratePayrollReportAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Request Body schema:
integer <int32>
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Responses
204

No Content

post/api/companies/{companyUid}/payroll/{payrollUid}/control/report
Request samples
0
0

GetDeviationReportDocumentAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
isReportPerDepartment
boolean
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/deviations
Request samples
Response samples
{ }

GetEmployeePayrollDraftCalculatinon

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
employeeUid
required
string <uuid>
query Parameters
recalculatePayslip
boolean
api-version
string
Responses
200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeeUid}/draftcalculation
Request samples
Response samples
{
}

PutEmployeesInPayrollAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Request Body schema:
employeeUids
required
Array of strings <uuid>
Responses
200

OK

put/api/companies/{companyUid}/payroll/{payrollUid}/employees
Request samples
{
}
Response samples
"00000000-0000-0000-0000-000000000000"

AddPayrollPerCompany

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
query Parameters
api-version
string
Request Body schema:
type
required
integer <int32>
Enum: 0 1 2 3 4 5
dispositionDate
string <date-time>
periodFrom
required
string <date-time>
periodTo
required
string <date-time>
selectedEmployeeUid
required
Array of strings <uuid>
hasHolidaySupplementPayout
boolean
hasHolidayPaymentPayout
boolean
hasHolidayPaymentToHolidayPayPayout
boolean
hasBenefitPackagePayout
boolean
hasBenefitPackageTwoPayout
boolean
hasTimeInLieuPayout
boolean
disablePayslipNotification
boolean
sendPayslipNotificationOn
string <date-time>
isPaid
boolean
Array of objects (Zalary.Models.Payroll.PayrollRegistrationPeriodDto)
note
string [ 0 .. 250 ] characters
hasHolidayPaymentTaxationAndTransferToNextYear
boolean
hasHolidayPaymentNettoPayout
boolean
hasFifthHolidayWeekPayout
boolean
extraPayrollRun
boolean
Responses
200

OK

post/api/companies/{companyUid}/payroll/new
Request samples
{
}
Response samples
"00000000-0000-0000-0000-000000000000"

GetEmployeesInPayroll

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
query Parameters
api-version
string
Request Body schema:
Array
string <uuid>
Responses
200

OK

post/api/companies/{companyUid}/payroll/employees
Request samples
[
]
Response samples
{
}

RunPayrollAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Request Body schema:
verificationCode
required
string [ 6 .. 20 ] characters
Responses
204

No Content

post/api/companies/{companyUid}/payroll/{payrollUid}/run
Request samples
{
}

Review

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

post/api/companies/{companyUid}/payroll/{payrollUid}/review
Request samples
Response samples
{
}

ControlAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

post/api/companies/{companyUid}/payroll/{payrollUid}/control
Request samples
Response samples
1

GetEmployeePayrollWageTypesAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Request Body schema:
skip
integer <int32>
take
integer <int32>
Responses
200

OK

post/api/companies/{companyUid}/payroll/{payrollUid}/wage-type
Request samples
{
}
Response samples
{
}

ReversePayroll

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Request Body schema:
verificationCode
required
string [ 6 .. 20 ] characters
revertType
integer <int32>
Enum: 0 2 4
Responses
204

No Content

post/api/companies/{companyUid}/payroll/{payrollUid}/revert/run
Request samples
{
}

ControlRevert

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
query Parameters
api-version
string
Responses
200

OK

post/api/companies/{companyUid}/payroll/{payrollUid}/revert/control
Request samples
Response samples
{
}

GenerateEmployeePayslipAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
employeePayrollUid
required
string <uuid>
query Parameters
api-version
string
Responses
204

No Content

post/api/companies/{companyUid}/payroll/{payrollUid}/employee/{employeePayrollUid}/payslips
Request samples

UpdateEmployeeDeviation

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
employeeUid
required
string <uuid>
query Parameters
api-version
string
Request Body schema:
note
string
Responses
204

No Content

patch/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeeUid}/deviation
Request samples
{
}

DeleteEmployeePayrollAsync

Securityoauth2
Request
path Parameters
companyUid
required
string <uuid>
payrollUid
required
string <uuid>
employeePayrollUid
required
string <uuid>
query Parameters
api-version
string
Responses
204

No Content

delete/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeePayrollUid}
Request samples