Sign in

v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Materials

Gets one Materials object from the cache.

Represents data found in Vista™ HQ Materials program. See escalation_materials endpoint for the Escalation Price Index tab info.

Vista views: HQMT, HQMU

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

MatlGroupinteger required
Materialstring required
Categorystring required
Descriptionstring nullable
StdUMstring required
Coststring required
CostECMstring required
Pricestring required
PriceECMstring required
PayDiscTypestring required
PurchaseUMstring required
SalesUMstring required
WeightConvstring nullable
Stocked'Y' | 'N' required
Taxable'Y' | 'N' required
MatlPhasestring nullable
MatlJCCostTypeinteger nullable
HaulPhasestring nullable
HaulJCCostTypeinteger nullable
HaulCodestring nullable
Active'Y' | 'N' required
PriceServiceIdstring nullable
Typestring required
Notesstring nullable
PayDiscRatestring required
MetricUMstring nullable
UniqueAttchIDstring nullable
KeyIDinteger 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"
}