Getting StartedAPI Reference
API Reference

Executes the Change Adtnl Direct Deposit action for the Employees data object.

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

Change Adtnl Direct Deposit

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
__key
required
string
length between 9 and 9
^\d*$

Optional. If omitted, the value will remain unchanged.

string
length ≤ 20

Optional. If omitted, the value will remain unchanged.

string
enum
length ≤ 1

Options:C-Checking, S-Savings. Optional. If omitted, the value will remain unchanged.

Allowed:
string
enum
length ≤ 1

Options:A-Active, I-Inacitve, P-Prenote. Optional. If omitted, the value will remain unchanged.

Allowed:
string | null

Optional. If omitted, the value will remain unchanged.

string
enum
length ≤ 1

Options:A-Amount, P-Percentage. Optional. If omitted, the value will remain unchanged.

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

Ignored if method != P. Set to null if Method is set to A. Optional. If omitted, the value will remain unchanged unless the Method was changed then it may be set to null.

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

Ignored if Method != A. Set to null if Method is set to P. Optional. If omitted, the value will remain unchanged unless the Method was changed then it may be set to null.

__custom_fields
object

This property will be added if there are any custom fields defined for this object in Vista. Each custom field will be a property of 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