Getting StartedAPI Reference
API Reference

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

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

Hold Invoice

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

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

string
required

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

integer
required

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

string
required
length ≤ 10

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

boolean
required

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

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 about 1 month ago

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

Updated about 1 month ago