Getting StartedAPI Reference
API Reference

Executes the Add action for the Release Retainage Batch Entry data object.

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

Add Release Retainage Batch Entries

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 255

Company. Key to ap/inv_batches(Co, Mth, BatchId).

date
required
^([0-9]{4})-(1[0-2]|0[1-9])-01$

Key to ap/inv_batches(Co, Mth, BatchId). Format: YYYY-MM-01.

integer
required

Key to ap/release_retainage_batches(Co, Mth, BatchId).

integer
enum

The Type field on the AP Release Retainage. 1-Undo Release, 2-Release (default)

Allowed:
integer
required

Enter the transaction for which to release retainage for the specified expense month.

string
required
^([0-9]{4})-(1[0-2]|0[1-9])-01.*$$

Enter the expense month for the original AP transactions; that is, the posted month of the original transaction for which retainage was withheld. Format: YYYY-MM-01.

integer
required

Enter the line for which to release retainage for the selected transaction

string | null

Enter the release date for this line. Optional. If omitted, today's date will be defaulted. Format: YYYY-MM-DD

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

Enter the amount of retainage to release. Optional. If omitted, the original retainage amount less any retainage already released will be defaulted.

__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