Creates or replaces a pending net-pay-allocation request that references an employee bank account.

post

https://example.com/wep/companies/{companyId}/employees/{employeeId}/requests/netpayallocation/account

Access: Employee users only.

Version 2.0 accepts a bank-account identifier instead of raw account details. The endpoint resolves the account through employee bank-account logic and copies the account details into the stored waiting request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

Company identifier from the route.

employeeId

int32

required

Employee identifier from the route.

Body Params

Net-pay-allocation request payload that references an employee bank account.

Payload used to submit or review a pending net-pay-allocation request that references an employee bank account.

startDate

date | null

required

Date on which the net-pay allocation should begin, in ISO 8601 date format (yyyy-MM-dd).
Data type is validated and must be Number

endDate

date | null

Optional end date for the net-pay allocation, in ISO 8601 date format (yyyy-MM-dd).
Data type is validated and must be Number

isApplyForAllPayStatements

boolean

Indicates whether the allocation should apply to all pay statements.

allocatedByType

int32

enum

Members:

1 - FixedAmount ( Fixed Amount. )
2 - Percentage ( Percentage. )
255 - Reminder ( Reminder. )

Allowed:

amount

double | null

≥ 0

Fixed amount to allocate when Worklio.ApiModels.API.Models.Employees.Requests.NetPayAllocation_v20.AllocatedByType is FixedAmount.

percentOfNetPay

double | null

0 to 100

Percentage of net pay to allocate when Worklio.ApiModels.API.Models.Employees.Requests.NetPayAllocation_v20.AllocatedByType is Percentage.

overwrite

boolean

Indicates whether an existing waiting request may be overwritten.

isRemove

boolean

Indicates whether the waiting request represents removal of an existing net-pay allocation.

bankAccountId

int32

required

Employee bank-account identifier whose details should be copied into the waiting request.

Headers

api-version

string

required

Defaults to 2.0

The requested API version

x-api-version

string

Defaults to 2.0

The requested API version

Responses

200OK

400Bad Request

403Forbidden

500Internal Server Error