Creates or replaces a pending request for a new net-pay allocation.

post

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

Access: Employee users only.

The request stores full bank-account information in the waiting request. Unless overwrite is requested, an existing pending request prevents creation of another one.

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

New net-pay-allocation request payload to store.

Payload used to submit or review a pending net-pay-allocation request that includes bank-account details.

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

accountNumber

string | null

required

^[a-zA-Z0-9-]*$

Destination bank-account number for the allocation.

routingNumber

string | null

required

^((0[0-9])|(1[0-2])|(2[1-9])|(3[0-2])|(6[1-9])|(7[0-2])|80)([0-9]{7})$

Destination bank routing number for the allocation.

accountHolderName

string | null

required

Account-holder name associated with the destination bank account.

accountType

int32

enum

Members:

1 - Checking ( Checking. )
2 - Savings ( Savings. )

Allowed:

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_v10.AllocatedByType is FixedAmount.

percentOfNetPay

double | null

0 to 100

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

overwrite

boolean

Indicates whether an existing waiting net-pay-allocation request may be replaced.

isRemove

boolean

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

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