PayrollApprovalForPayroll

GetPayrollApprovalSettingsForPayrollAsync

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}/approval/settings

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"requestedByUser": {"email": "string",
"name": "string",
"photoUrl": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"payrollApproversInPayroll": [{"action": 0,
"actionPerformedOn": "2019-08-24T14:15:22Z",
"comment": "string",
"user": {"email": "string",
"name": "string",
"photoUrl": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"role": 1,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"isPayrollApprovalActivated": true,
"isAutoCompletePayrollEnabled": true,
"minimumNumberOfApprovers": 0
}

GetResponsiblePersonsForApprovalFlowForPayrollAsync

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}/approval/responsible-persons

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

[{"isRequester": true,
"isExecutor": true,
"action": 0,
"actionPerformedOn": "2019-08-24T14:15:22Z",
"comment": "string",
"user": {"email": "string",
"name": "string",
"photoUrl": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"role": 1,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]

ActivatePayrollApprovalFlowForPayrollAsync

Securityoauth2

Request

path Parameters

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

query Parameters

api-version

string

Request Body schema:
application/json

payrollApprovers

Array of strings <uuid>

Responses

204

No Content

post/api/companies/{companyUid}/payroll/{payrollUid}/approval

Request samples

{"payrollApprovers": ["00000000-0000-0000-0000-000000000000"
]
}

ChangeApproverActionForUserInPayrollAsync

Securityoauth2

Request

path Parameters

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

query Parameters

api-version

string

Request Body schema:
application/json

verificationCode	string
action	integer <int32> Enum: 0 1 2
comment	string

Responses

204

No Content

patch/api/companies/{companyUid}/payroll/{payrollUid}/approval

Request samples

{"verificationCode": "string",
"action": 0,
"comment": "string"
}

ActivatePayrollApprovalFlowForPayrollWithAutoCompleteAsync

Securityoauth2

Request

path Parameters

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

query Parameters

api-version

string

Request Body schema:
application/json

mobileVerificationCode required	string = 6 characters
payrollApprovers	Array of strings <uuid>

Responses

204

No Content

post/api/companies/{companyUid}/payroll/{payrollUid}/approval/autocomplete

Request samples

{"mobileVerificationCode": "string",
"payrollApprovers": ["00000000-0000-0000-0000-000000000000"
]
}

CompletePayrollWithACommentAsync

Securityoauth2

Request

path Parameters

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

query Parameters

api-version

string

Request Body schema:
application/json

mobileVerificationCode required	string = 6 characters
comment required	string [ 0 .. 250 ] characters

Responses

204

No Content

post/api/companies/{companyUid}/payroll/{payrollUid}/approval/run/override

Request samples

{"mobileVerificationCode": "string",
"comment": "string"
}

CancelPayrollApprovalFlowForPayrollAsync

Securityoauth2

Request

path Parameters

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

query Parameters

api-version

string

Request Body schema:
application/json

comment

required

string [ 0 .. 250 ] characters

Responses

204

No Content

patch/api/companies/{companyUid}/payroll/{payrollUid}/approval/cancel

Request samples

{"comment": "string"
}

PayrollApprovalForPayroll

GetPayrollApprovalSettingsForPayrollAsync

path Parameters

query Parameters

GetResponsiblePersonsForApprovalFlowForPayrollAsync

path Parameters

query Parameters

ActivatePayrollApprovalFlowForPayrollAsync

path Parameters

query Parameters

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

ChangeApproverActionForUserInPayrollAsync

path Parameters

query Parameters

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

ActivatePayrollApprovalFlowForPayrollWithAutoCompleteAsync

path Parameters

query Parameters

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

CompletePayrollWithACommentAsync

path Parameters

query Parameters

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

CancelPayrollApprovalFlowForPayrollAsync

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

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json