Executes the Add Address action for the Vendors data object.

post

https://api.xchange.trimble.com/connect/v1/direct/subscribers/{subscriber_code}/vista/ap/2/data/vendors/actions/add_address

Adds a new Additional Address to a Vendor.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

subscriber_code

string

required

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

Body Params

APCo

integer

required

1 to 255

The AP Company you are working with.

VendorGroup

integer

required

1 to 255

Key to ap/vendors(VendorGroup, Vendor).

Vendor

integer

required

1 to 999999

Key to ap/vendors(VendorGroup, Vendor).

AddressSeq

integer

1 to 255

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

Type

integer

required

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

Description

string | null

Optional. If omitted, null will be defaulted.

Address

string | null

Optional. If omitted, null will be defaulted.

City

string | null

Optional. If omitted, null will be defaulted.

State

string | null

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

Zip

string | null

Optional. If omitted, null will be defaulted.

Address2

string | null

Optional. If omitted, null will be defaulted.

Notes

string | null

Optional. If omitted, null will be defaulted.

Country

string | null

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.

VendorAcctNumber

string | null

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

__custom_fields

object

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

Headers

X-Application-Key

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.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json