Getting StartedAPI Reference
API Reference

Executes the Add action for the Vendors data object.

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

Adds a new 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
integer
required
1 to 255

The AP Company you are working with.

1 to 999999

Maximum 6 digits. Optional. If omitted, the Default Vista logic will be used, which will use the value of the largest Vendor within the Company's VendorGroup plus one. For more options, refer to the oneOf option list in the Input Schema.

provide the value.

string
length ≤ 15

Optional. If omitted, this value will be calculated based on Vista defaulting logic with trailing digits incase of non unique results.

string | null

Optional. If omitted, null will be defaulted.

string
length ≤ 1

Options: R-Regular, S-Supplier. Optional. If omitted, R will be defaulted.

string
enum

Optional. If omitted, N will be defaulted.

Allowed:
string | null

Optional. If omitted, null will be defaulted.

string | null

Optional. If omitted, null will be defaulted.

string | null

Optional. If omitted, null will be defaulted.

string | null

Optional. If omitted, null will be defaulted.

string | null

Optional. If omitted, null will be defaulted.

PaymentAddress
object

Optional, if omitted each property will be defaulted as noted.

PurchasingAddress
object

Optional, if omitted each property will be defaulted as noted.

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. If omitted, null will be defaulted.

string | null

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

string | null

Key to hq/payment_terms(PayTerms). Optional. If omitted, null will be defaulted.

string | null

Default account for expense transactions. Optional. If omitted, null will be defaulted.

string
enum

US-Subject to 1099 reporting, AU- Subject to Taxable Payments Reporting, CA-Subject to T5018 reporting. Optional. If omitted, N will be defaulted.

Allowed:
string | null

US based APCo only. Optional. If omitted it will be defaulted based on Vista defaulting logic. A value must be provided or defaulted if $.V1099YN = Y. Input is ignored if $.V1099YN != Y.

integer | null

US based APCo only. Optional. If omitted it will be defaulted based on Vista defaulting logic. A value must be provided or defaulted if $.V1099YN = Y. Input is ignored if $.V1099YN != Y.

integer | null

Reference to AddressSeq in the AdditionalAddresses array. Optional. If omitted, null will be defaulted. Input is ignored if $.V1099YN != Y.

string | null

[PROTECTED FIELD] US based APCo only. Optional. If omitted, null will be defaulted.

string | null

US based APCo only. Proprietor name to be included on 1099 processing. Optional. If omitted, null will be defaulted. Input is ignored if $.V1099YN != Y.

string
enum

US based APCo only. Override the minimum amount for a 1099 download. Optional. If omitted, N will be defaulted. Input is ignored if $.V1099YN != Y.

Allowed:
string
enum

Optional. If omitted, Y will be defaulted.

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. If omitted, null will be defaulted.

string | null

Optional. If omitted, null will be defaulted.

string
enum

Optional. If omitted, N will be defaulted.

Allowed:
integer | null

Optional. If omitted, null will be defaulted.

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. If omitted, 0 will be defaulted.

Allowed:
string
enum
length ≤ 1

Options: N-None, A-Email Attachment, E-Email Notice. Optional. If omitted, N will be defaulted.

Allowed:
integer | null

Default CM Account. Optional. If omitted, null will be defaulted.

string | null

Default PayControl for Invoices. Optional. If omitted, null will be defaulted.

string | null

[PROTECTED FIELD] Used with Viewpoint ePay. Optional. If omitted, null will be defaulted.

string
enum

Used with Viewpoint ePay. Optional. If omitted, N will be defaulted.

Allowed:
string | null

Key to hq/reviewers(Reviewer). Optional. If omitted, null will be defaulted.

PaymentMethod
object

Optional, if omitted each property will be defaulted as noted.

IndependentContractorReporting
object

Optional, if omitted each property will be defaulted as noted. 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, if omitted each property will be defaulted as noted.

AustraliaData
object

Only used if PRCo Country is AU. Optional, if omitted each property will be defaulted as noted.

__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.

AdditionalAddresses
array of objects
AdditionalAddresses
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