Getting StartedAPI Reference
API Reference

Executes the Add action for the Employee Deductions and Liabilities data object.

post
https://api.xchange.trimble.com/connect/v1/direct/subscribers//vista/pr/2/data/employee_dedn_liabs/actions/add

Adds a new Employee Deduction/Liabilities.

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

The code of the subscriber that you are making this request for.

Body Params
integer
required
1 to 254

Key natural(PRCo, Employee, DLCode).

integer
required
1 to 999999

Key natural(PRCo, Employee, DLCode).

integer
required

Key natural(PRCo, Employee, DLCode). Key to pr/dedn_liab_codes(PRCo, DLCode)

string
enum

Optional, if omitted N will be defaulted. It is not always valud to provide Y here. You can only supply Y is the DLCode Calc method is Employee or Any.

Allowed:
string | null

Required if EmplBased = Y. Ignored and defaulted to null if EmplBased = N.

string | null

Optional, if omitted, null will be applied. Ignored unless the PRCo is set to AU (Australia).

integer | null

Required if EmplBased = Y. Ignored and defaulted to null if EmplBased = N.

__RoutineInformation
object

Represents the Routine Info section of the PR Employee Dedns / Liabs form. This information is not always allowed to be provided. Valid infomration has many factors. Please see Vista help if using these properties.

__Calculations
object

Represents the Calculations section of the PR Employee Dedns / Liabs form. This information is not always allowed to be provided. Valid information has many factors. Please see Vista help if using these properties.

__MinimumNetPay
object

Represents the Minimum Net Pay section of the PR Employee Dedns / Liabs form. This information is not always allowed to be provided. Seems to only be allowed if the DLCode Method = N-Rate of net.

string
enum
length ≤ 1

Options: N-None, A-Amount, R-Rate. Optional, if omitted, N will be defaulted.

Allowed:
string | null
^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$

Ignored and defaulted to null if AddonType = N. Optional, if omitted, null will be defaulted. When AddonType = A this is a dollar amount. When AcconType - R this is a rate.

string | null

Optional, if omitted null will be defaulted. If EmplBased = N, any input here will be ignored and null defaulted.

string | null
enum

Options: see vista help. Optional. If omitted, null will be defaulted. Input ignored if EmplBased = N

Allowed:
string
enum

Optional, If omitted, N will be defaulted. Input ignored if EmplBased = N

Allowed:
integer | null

Optional, If omitted, null will be defaulted. Input ignored, if CSAllocYN = N

__AutoAPOverrides
object

Represents the Minimum Net Pay section of the PR Employee Dedns / Liabs form. This information is not always allowed to be provided. Seems to only be allowed if the DLCode Method = N-Rate of net.

string
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

Optional, if omitted, 0 will be applied. Ignored unless the PRCo is set to AU (Australia).

string | null
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

Optiona. if omitted, null will be defaulted. It is unclear what this property is for.

string | null

Optional, if omitted, null will be defaulted.

__custom_fields
object

Add properties to this object to update any ud properties on this object.

Headers
string
required

Used to authorize access to the Direct API.

Responses

401

You have not provided a proper X-Application-Key in the header of this request.

403

The X-Application-Key provided is valid but the key does not have access to this resource.

404

The object with the given ID was not found OR a subscriber with the given URL was not found.

Updated 2 months ago

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

Updated 2 months ago