Getting StartedAPI Reference
API Reference

Executes the Change action for the Vendors data object.

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

Changes an existing Vendor record.

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
__key
required
integer
required
1 to 255

The AP Company you are working with.

string
length ≤ 15

Optional.

string | null

Optional.

string
length ≤ 1

Options: R-Regular, S-Supplier. Optional.

string
enum

Optional.

Allowed:
string | null

Optional.

string | null

Optional.

string | null

Optional.

string | null

Optional.

string | null

Optional.

PaymentAddress
object

Optional.

PurchasingAddress
object

Optional.

integer | null
1 to 999999

Reference to Customer if this Vendor is also a Customer. Key to ar/customers(CustGroup, Customer). CustGroup is determined based on supplied APCo. Optional.

string | null

Default sales/use TaxCode for non-job transactions. Key to hq/tax_codes(TaxGroup, TaxCode) TaxGroup based on the Provided ARCo. Optional.

string | null

Key to hq/payment_terms(PayTerms). Optional.

string | null

Default account for expense transactions. Optional.

string
enum

US-Subject to 1099 reporting, AU- Subject to Taxable Payments Reporting, CA-Subject to T5018 reporting. Optional.

Allowed:
string | null

US based APCo only. Optional. Input is ignored if $.V1099YN != Y.

integer | null

US based APCo only. Optional. Input is ignored if $.V1099YN != Y.

integer | null

Reference to AddressSeq in the AdditionalAddresses array. Optional. Input is ignored if $.V1099YN != Y.

string | null

[PROTECTED FIELD] US based APCo only. Optional.

string | null

US based APCo only. Proprietor name to be included on 1099 processing. Optional. Input is ignored if $.V1099YN != Y.

string
enum

US based APCo only. Override the minimum amount for a 1099 download. Optional. Input is ignored if $.V1099YN != Y.

Allowed:
string
enum

Optional.

Allowed:
date | null
^([0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|2[0-9]|1[0-9]|0[1-9])$

Format: YYYY-MM-DD. Optional.

string | null

Optional.

string
enum

Optional.

Allowed:
integer | null

Optional.

integer
enum

Override unique APRef Level. Options: 0-No Override, 1-By Vendor & Co, 2-By Vendor & Cross-Co, 3-By Master Vendor & Co, 4-By Master Vendor & Cross-Co. Optional.

Allowed:
string
enum
length ≤ 1

Options: N-None, A-Email Attachment, E-Email Notice. Optional.

Allowed:
integer | null

Default CM Account. Optional.

string | null

Default PayControl for Invoices. Optional.

string | null

[PROTECTED FIELD] Used with Viewpoint ePay. Optional.

string
enum

Used with Viewpoint ePay. Optional.

Allowed:
string | null

Key to hq/reviewers(Reviewer). Optional.

PaymentMethod
object

Optional.

IndependentContractorReporting
object

Optional. This object will only be used if $.ICRptYN = Y in ap/company_parameters for the provided $.APCo.

CanadaData
object

Only used if PRCo Country is CA. Optional.

AustraliaData
object

Only used if PRCo Country is AU. Optional.

__custom_fields
object

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.

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 2 months ago

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

Updated 2 months ago