v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Vendors

Executes the Add action for the Vendors data object.

Adds a new Vendor record.

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

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.

SortNamestring

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

Namestring nullable

Optional. If omitted, null will be defaulted.

Typestring

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

TempYN'Y' | 'N'

Optional. If omitted, N will be defaulted.

Contactstring nullable

Optional. If omitted, null will be defaulted.

Phonestring nullable

Optional. If omitted, null will be defaulted.

Faxstring nullable

Optional. If omitted, null will be defaulted.

EMailstring nullable

Optional. If omitted, null will be defaulted.

URLstring nullable

Optional. If omitted, null will be defaulted.

Customerinteger nullable

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.

TaxCodestring nullable

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.

PayTermsstring nullable

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

GLAcctstring nullable

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

V1099YN'Y' | 'N'

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

V1099Typestring nullable

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.

V1099Boxinteger nullable

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.

V1099AddressSeqinteger nullable

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

TaxIdstring nullable

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

Propstring nullable

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.

OverrideMinAmtYN'Y' | 'N'

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.

ActiveYN'Y' | 'N'

Optional. If omitted, Y will be defaulted.

LastInvDatestring date nullable

Format: YYYY-MM-DD. Optional. If omitted, null will be defaulted.

Notesstring nullable

Optional. If omitted, null will be defaulted.

SeparatePayInvYN'Y' | 'N'

Optional. If omitted, N will be defaulted.

MasterVendorinteger nullable

Optional. If omitted, null will be defaulted.

APRefUnqOvr0 | 1 | 2 | 3 | 4

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.

PayInfoDelivMthd'N' | 'A' | 'E'

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

CMAcctinteger nullable

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

PayControlstring nullable

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

VendorAcctNumberstring nullable

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

SubcontractorYN'Y' | 'N'

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

Reviewerstring nullable

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

__custom_fieldsobject

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.

Response

Success

idstring

operationstring

statusstring