Generate payrolls
Headers
-
TARGET-ORGANIZATION-ID integer(int32)
ID of organization, for which the operation must be performed
-
API token (can be retrieved from account settings)
Body Required
info
-
calendarYear integer(int32)
-
date string
-
employees array[object]
-
monthEndDate string(date-time)
-
monthStartDate string(date-time)
-
monthType string
Values are
JANUARY
,FEBRUARY
,MARCH
,APRIL
,MAY
,JUNE
,JULY
,AUGUST
,SEPTEMBER
,OCTOBER
,NOVEMBER
, orDECEMBER
.
POST
/api-v1/payroll/generate
curl \
-X POST http://wyzio.app/api-v1/payroll/generate \
-H "TARGET-ORGANIZATION-ID: 42" \
-H "WEAL-TOKEN: string" \
-d '{"calendarYear":42,"date":"string","employees":[{"birthday":"string","currencyId":42,"genderType":"MALE","hourlySalaryType":true,"id":42,"organizationAccountId":42,"payableToBankId":42,"salaryType":"MONTHLY","staffAccountId":42,"staffId":42,"staffPayslipId":42}],"monthEndDate":"2024-05-04T09:42:00+00:00","monthStartDate":"2024-05-04T09:42:00+00:00","monthType":"JANUARY"}'
Request examples
# Headers
TARGET-ORGANIZATION-ID: 42
WEAL-TOKEN: string
# Payload
{
"calendarYear": 42,
"date": "string",
"employees": [
{
"birthday": "string",
"currencyId": 42,
"genderType": "MALE",
"hourlySalaryType": true,
"id": 42,
"organizationAccountId": 42,
"payableToBankId": 42,
"salaryType": "MONTHLY",
"staffAccountId": 42,
"staffId": 42,
"staffPayslipId": 42
}
],
"monthEndDate": "2024-05-04T09:42:00+00:00",
"monthStartDate": "2024-05-04T09:42:00+00:00",
"monthType": "JANUARY"
}
Response examples (200)
[
{
"address": {
"city": "string",
"countryCode2": "string",
"countryId": 42,
"houseNumber": "string",
"id": 42,
"line1": "string",
"line2": "string",
"name": "string",
"position": 42,
"postCode": "string",
"readOnly": true,
"region": {
"code": "string",
"id": 42,
"name": "string",
"taxMode": "ANNUALLY"
},
"service": "string",
"toTheAttentionOf": "string"
},
"calendarYear": 42,
"contactEntityId": 42,
"createdOn": "string",
"currencyId": 42,
"description": "string",
"employeeInfoId": 42,
"grossSalary": "string",
"id": 42,
"isDeleted": true,
"isFromLockedAccountingPeriod": true,
"journalEntryId": 42,
"monthEndDate": "2024-05-04T09:42:00+00:00",
"monthStartDate": "2024-05-04T09:42:00+00:00",
"monthType": "JANUARY",
"netSalary": "string",
"organizationEmployeeGroupId": 42,
"organizationId": 42,
"payable": "string",
"paymentDate": "string",
"payrollLines": [
{
"baseAmount": "string",
"description": "string",
"employeeAmount": "string",
"employeeRate": "string",
"employerAmount": "string",
"employerRate": "string",
"id": 42,
"isAutomaticallyAdded": true,
"isChanged": true,
"isShownOnSalarySlip": true,
"localizations": {
"de": "string",
"en": "string",
"fr": "string",
"id": 42,
"it": "string"
},
"number": 42,
"payrollEntityId": 42,
"payslipLineEntityId": 42,
"payslipLineType": "EMPLOYEE_LINE",
"payslipValueType": "VALUE",
"specialAttributionType": "BASE_SALARY"
}
],
"payrollPayments": [
{
"bankCharges": "string",
"id": 42,
"isFromLockedAccountingPeriod": true,
"paidAmount": "string",
"payableByAccountId": 42,
"payableToBankId": 42,
"payrollEntityId": 42,
"plannedDate": "string",
"requestedAmount": "string",
"requestedDate": "string",
"sentDate": "string",
"valueDate": "string"
}
],
"removedPayrollLineNumbers": [
42
],
"staffEntityId": 42,
"staffPayslipId": 42,
"status": "UNPAID",
"warnings": "string"
}
]