Sign in

v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Release Retainage Batch Entry

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

Add Release Retainage Batch Entries

post/direct/subscribers/{subscriber_code}/vista/ap/2/data/rel_ret_bat_entries/actions/add

Path parameters

subscriber_codestring required

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

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Request body

Cointeger required

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

Mthstring date required

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

BatchIdinteger required

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

TypeOf1 | 2

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

APTransinteger required

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

APExpMthstring required

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.

APLineinteger required

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

ReleaseDatestring nullable

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

Amountstring

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

__custom_fieldsobject

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.

Response

Success

idstring
operationstring
statusstring