Sign in

v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Vendors

Executes the Add Address action for the Vendors data object.

Adds a new Additional Address to a Vendor.

post/direct/subscribers/{subscriber_code}/vista/ap/2/data/vendors/actions/add_address

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

APCointeger required

The AP Company you are working with.

VendorGroupinteger required

Key to ap/vendors(VendorGroup, Vendor).

Vendorinteger required

Key to ap/vendors(VendorGroup, Vendor).

AddressSeqinteger

Key to AdditionalAddresses in ap/vendors. If omitted, will be defaulted based on Vista defaulting logic.

Typeinteger required

Options: 0-Both, 1-Payment, 2-Purchase.

Descriptionstring nullable

Optional. If omitted, null will be defaulted.

Addressstring nullable

Optional. If omitted, null will be defaulted.

Citystring nullable

Optional. If omitted, null will be defaulted.

Statestring nullable

Optional. If omitted, null will be defaulted. State will be validated against the hq.countries.States array for the provided or defaulted Country.

Zipstring nullable

Optional. If omitted, null will be defaulted.

Address2string nullable

Optional. If omitted, null will be defaulted.

Notesstring nullable

Optional. If omitted, null will be defaulted.

Countrystring nullable

Key to hq/countries(Country). Optional. If omitted, hq/company_parameters.DefaultCountry will be defaulted. State will be validated against the hq.countries.States array for the provided Country.

VendorAcctNumberstring nullable

Vendor Account NUmber used with Viewpoint ePay. Optional. If omitted, null will be defaulted.

__custom_fieldsobject

Add properties to this object for any custom fields you want to set as this record is added to Vista.

Response

Success

idstring
operationstring
statusstring