Sign in

v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Customers

Gets one Customers object from the cache.

Represents data found in Vista™ AR Customers program.

Vista view: ARCM

get/direct/subscribers/{subscriber_code}/vista/ar/2/data/customers/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.

CustGroupinteger required
Customerinteger required
Namestring nullable
SortNamestring required
TempYN'Y' | 'N' required
Phonestring nullable
Faxstring nullable
EMailstring nullable
URLstring nullable
Contactstring nullable
ContactExtstring nullable
Addressstring nullable
Citystring nullable
Statestring nullable
Zipstring nullable
Address2string nullable
BillAddressstring nullable
BillCitystring nullable
BillStatestring nullable
BillZipstring nullable
BillAddress2string nullable
Statusstring required
RecTypeinteger nullable
PayTermsstring nullable
TaxGroupinteger nullable
TaxCodestring nullable
CreditLimitstring required
SelPurge'Y' | 'N' required
StmntPrint'Y' | 'N' required
StmtTypestring required
FCTypestring required
FCPctstring required
MarkupDiscPctstring required
DateOpenedstring nullable
MiscDistCodestring nullable
Notesstring nullable
PriceTemplateinteger nullable
DiscTemplateinteger nullable
HaulTaxOptinteger required
InvLvlinteger required
BillFreqstring nullable
MiscOnInv'Y' | 'N' required
MiscOnPay'Y' | 'N' required
PrintLvlinteger required
SubtotalLvlinteger required
SepHaul'Y' | 'N' required
ExclContFromFC'Y' | 'N' required
UniqueAttchIDstring nullable
KeyIDinteger required
Countrystring nullable
BillCountrystring nullable
ABNstring nullable

[PROTECTED FIELD]

ACNstring nullable

[PROTECTED FIELD]

MSDefaultInvoiceReportinteger nullable
__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"
}