v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Materials

Executes the Add action for the Materials data object.

Add

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

HQCointeger required

HQ Company

Materialstring required

Key (MatlGroup, Material).

Descriptionstring nullable
Categorystring required

Key to

Type'S' | 'E'

Options:S-Standard, E-Equipment. If omitted, 'S' will be defaulted.

Active'Y' | 'N'

If omitted 'Y' will be defaulted.

Taxable'Y' | 'N'

If omitted 'N' will be defaulted.

Stocked'Y' | 'N'

If omitted 'N' will be defaulted.

StdUMstring required

Key to hq/unit_of_measures(UM).

Coststring

If omitted, 0 will be defaulted.

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

If omitted, E will be defaulted.

Pricestring

If omitted, 0 will be defaulted.

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

If omitted, E will be defaulted.

WeightConvstring nullable

lbs per StdUM

PurchaseUMstring required

Key to hq/unit_of_measures(UM).

SalesUMstring required

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. If omitted, N will be defaulted.

PayDiscRatestring

Rate or Amt as noted in PayDiscType. Ignored if PayDiscType = N

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