API Reference

Creates or replaces a pending change request for an existing net-pay allocation.

put
https://example.com/wep/companies//employees//requests/netpayallocation

Access: Employee users only.

The request targets an existing salary-allocation record identified by data.Id. Unless overwrite is requested, an unrelated pending request causes the call to fail.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Company identifier from the route.

int32
required

Employee identifier from the route.

Body Params

Update payload for the existing net-pay allocation.

Payload used to submit or review a pending change request for an existing net-pay allocation.

int32 | null
required

Identifier of the existing net-pay allocation to update.

date | null

Updated start date in ISO 8601 date format (yyyy-MM-dd), or null to keep the current start date.
Data type is validated and must be Number

date | null

Updated end date in ISO 8601 date format (yyyy-MM-dd), or null to keep the current end date.
Data type is validated and must be Number

string | null
required

Updated account-holder name to associate with the allocation request.

int32
enum

Members:

  • 1 - FixedAmount ( Fixed Amount. )
  • 2 - Percentage ( Percentage. )
  • 255 - Reminder ( Reminder. )
Allowed:
double | null
≥ 0

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

double | null
0 to 100

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

boolean

Indicates whether an existing waiting request may be overwritten.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

Responses

Updated about 1 month ago

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago