v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Vendors

Gets one Vendors object from the cache.

Represents data found in Vista™ AP Vendor Master program.

Vista views: APVM, and APAA

get/direct/subscribers/{subscriber_code}/vista/ap/2/data/vendors/cache/{ryvitId_value}

Path parameters

subscriber_codestring required

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

ryvitId_valuestring required

The code of the data object you want to get.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Response

Success

__ryvitKeysstring[]

Array of key paths that can be used to retrieve this object.

__modifiedUTCstring

UTC timestamp of when this object was last modified in the cache.

VendorGroupinteger required
Vendorinteger required
SortNamestring required
Namestring nullable
Typestring required
TempYN'Y' | 'N' required
Contactstring nullable
Phonestring nullable
Faxstring nullable
EMailstring nullable

Vista default max length is 60.

URLstring nullable
Addressstring nullable
Citystring nullable
Statestring nullable
Zipstring nullable
Address2string nullable
POAddressstring nullable
POCitystring nullable
POStatestring nullable
POZipstring nullable
POAddress2string nullable
Purge'Y' | 'N' required
CustGroupinteger nullable
Customerinteger nullable
TaxGroupinteger nullable
TaxCodestring nullable
PayTermsstring nullable
GLCointeger required
GLAcctstring nullable
V1099YN'Y' | 'N' required
V1099Typestring nullable
V1099Boxinteger nullable
TaxIdstring nullable

[PROTECTED FIELD]

Propstring nullable
ActiveYN'Y' | 'N' required
EFTstring required
RoutingIdstring nullable

[PROTECTED FIELD]

BankAcctstring nullable

[PROTECTED FIELD]

AcctTypestring nullable
LastInvDatestring nullable
AuditYN'Y' | 'N' required
Notesstring nullable
AddnlInfostring nullable
AddendaTypeIdinteger nullable
Reviewerstring nullable
SeparatePayInvYN'Y' | 'N' required
UniqueAttchIDstring nullable
OverrideMinAmtYN'Y' | 'N' required
MasterVendorinteger nullable
APRefUnqOvrinteger required
ICFirstNamestring nullable
ICMInitialstring nullable
ICLastNamestring nullable
ICSocSecNbrstring nullable
ICStreetNbrstring nullable
ICStreetNamestring nullable
ICAptNbrstring nullable
ICCitystring nullable
ICStatestring nullable
ICZipstring nullable
ICLastRptDatestring nullable
UpdatePMYN'Y' | 'N' required
KeyIDinteger required
Countrystring nullable
POCountrystring nullable
ICCountrystring nullable
AddRevToAllLinesYN'Y' | 'N' required
AUVendorEFTYN'Y' | 'N' required
AUVendorAccountNumberstring nullable

[PROTECTED FIELD]

AUVendorBSBstring nullable

[PROTECTED FIELD]

AUVendorReferencestring nullable
PayInfoDelivMthdstring nullable
IATYN'Y' | 'N' required
ISODestinationCountryCodestring nullable
RDFIBankNamestring nullable

[PROTECTED FIELD]

BranchCountryCodestring nullable

[PROTECTED FIELD]

RDFIIdentNbrQualifierstring nullable

[PROTECTED FIELD]

GatewayOperatorRDFIIdentstring nullable

[PROTECTED FIELD]

CMAcctinteger nullable
T5FirstNamestring nullable
T5MiddleInitstring nullable
T5LastNamestring nullable
T5SocInsNbrstring nullable

[PROTECTED FIELD]

T5BusinessNbrstring nullable

[PROTECTED FIELD]

T5BusTypeCodestring nullable
T5PartnerFINstring nullable

[PROTECTED FIELD]

AusBusNbrstring nullable

[PROTECTED FIELD]

AusCorpNbrstring nullable

[PROTECTED FIELD]

CASubjToWC'Y' | 'N' required
CAClearanceCertstring nullable
CACertEffectiveDatestring nullable
PayControlstring nullable
V1099AddressSeqinteger nullable
PayMethodstring required
SubjToOnCostYN'Y' | 'N' required
CSEmailstring nullable
OnCostCostTypeinteger nullable
UpdatePREHYN'Y' | 'N' required
VendorAcctNumberstring nullable

[PROTECTED FIELD]

SubcontractorYN'Y' | 'N' required
__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.

Example response

{
  "__modifiedUTC": "2020-01-01T13:01:01.1234567Z"
}