v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Materials

Executes the Change action for the Materials data object.

Change

post/direct/subscribers/{subscriber_code}/vista/hq/2/data/materials/actions/change

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

HQCointeger required

Descriptionstring nullable

Categorystring

Key to hq/material_categories(MatlGroup, Category)

Type'S' | 'E'

Options:S-Standard, E-Equipment.

Active'Y' | 'N'

Taxable'Y' | 'N'

Stocked'Y' | 'N'

StdUMstring

Key to hq/unit_of_measures(UM).

Coststring

CostECM'E' | 'C' | 'M'

Pricestring

PriceECM'E' | 'C' | 'M'

WeightConvstring nullable

lbs per StdUM

PurchaseUMstring

Key to hq/unit_of_measures(UM).

SalesUMstring

Key to hq/unit_of_measures(UM).

MetricUMstring nullable

Key to hq/unit_of_measures(UM).

PayDiscType'N' | 'U' | 'R'

Options: N-No Discount, U-Discount Amt Per Unit, R-Discount Rate per dollar.

PayDiscRatestring

Rate or Amt as noted in PayDiscType.

MatlPhasestring nullable

Key to jc/phases(PhaseGroup, Phase) where Phase Group is determined by HQCo.

MatlJCCostTypeinteger nullable

Key to jc/cost_types(PhaseGroup, CostType) where Phase Group is determined by HQCo.

HaulPhasestring nullable

Key to jc/phases(PhaseGroup, Phase) where Phase Group is determined by HQCo.

HaulJCCostTypeinteger nullable

Key to jc/cost_types(PhaseGroup, CostType) where Phase Group is determined by HQCo.

HaulCodestring nullable

Key to MS Haul Codes

PriceServiceIdstring nullable

Notesstring nullable

__custom_fieldsobject

Add Properties in this object as needed to set User Defined Properties on this object as defined in Vista.

Response

Success

idstring

operationstring

statusstring