v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Invoice Holds

Executes the Hold Invoice action for the Invoice Holds data object.

Hold Invoice

post/direct/subscribers/{subscriber_code}/vista/ap/2/data/invoice_holds/actions/hold_invoice

subscriber_codestring required

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

X-Application-Keystring required

Used to authorize access to the Direct API.

APCointeger required

Key to ap/invoice(APCo, Mth, APTrans).

Mthstring required

Key to ap/invoice(APCo, Mth, APTrans).

APTransinteger required

Key to ap/invoice(APCo, Mth, APTrans).

HoldCodestring required

Key to hq/hold_codes(HoldCode). Must not be a Retainage type Hold Code as determined from ap/company_parameters.

__AddHoldCodeToInvoiceboolean required

Set to true to add the HoldCode to the AP Invoice Transaction Header record (APTH).

Success

idstring

operationstring

statusstring