Add or Update Employee Contribution

post

https://api.uzio.com/api/payroll/employeeContribution

This API assigns an employer contribution to an employee and maintains its method, amount per pay, monthly limit and annual limit.

This API lets you create a new employee level contribution when none exists or update the current configuration by applying employee level overrides.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Payload used by external systems to assign or update an employee-level employer contribution.

employeeUuid

string

required

Unique employee identifier. On update it must match the existing employee for the contribution.

contributionUuid

string

required

Identifier of the company-level employer contribution definition from Get Company Contributions.

overrideAmountPerPay

boolean

When true, a custom Amount Per Pay value is accepted for this employee.

amountPerPay

double

Employer contribution amount or percent per pay period. Required when the override flag is true or defaults do not exist.

overrideMonthlyLimit

boolean

When true, the request may supply a custom Monthly Limit for this employee.

monthlyLimit

double

Maximum employer contribution allowed in a calendar month for this employee. Required when the monthly override flag is true.

overrideAnnualLimit

boolean

When true, the request may supply a custom Annual Limit for this employee.

annualLimit

double

Maximum employer contribution allowed in a calendar year for this employee. Required when the annual override flag is true.

Headers

companyId

string

required

The company unique identifier

Responses

400

In case the request has some invalid parameter.

401

In case Security key is not provided or invalid.

500

In case system is unable to fulfil the request due to some internal error.

200OK