Executes the Change action for the Materials data object.

post

https://api.xchange.trimble.com/connect/v1/direct/subscribers/{subscriber_code}/vista/hq/2/data/materials/actions/change

Change

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

subscriber_code

string

required

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

Body Params

HQCo

integer

required

__key

required

Description

string | null

Category

string

length ≤ 10

Key to hq/material_categories(MatlGroup, Category)

Type

string

enum

length ≤ 1

Options:S-Standard, E-Equipment.

Allowed:

Active

string

enum

Allowed:

Taxable

string

enum

Allowed:

Stocked

string

enum

Allowed:

StdUM

string

length ≤ 3

Key to hq/unit_of_measures(UM).

Cost

string

^[-+]?[0-9]{1,11}(?:.[0-9]{1,5})?$

CostECM

string

enum

length ≤ 1

Allowed:

Price

string

^[-+]?[0-9]{1,11}(?:.[0-9]{1,5})?$

PriceECM

string

enum

length ≤ 1

Allowed:

WeightConv

string | null

^[-+]?[0-9]{1,9}(?:.[0-9]{1,3})?$

lbs per StdUM

PurchaseUM

string

length ≤ 3

Key to hq/unit_of_measures(UM).

SalesUM

string

length ≤ 3

Key to hq/unit_of_measures(UM).

MetricUM

string | null

Key to hq/unit_of_measures(UM).

PayDiscType

string

enum

length ≤ 1

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

Allowed:

PayDiscRate

string

^[-+]?[0-9]{1,11}(?:.[0-9]{1,5})?$

Rate or Amt as noted in PayDiscType.

MatlPhase

string | null

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

MatlJCCostType

integer | null

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

HaulPhase

string | null

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

HaulJCCostType

integer | null

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

HaulCode

string | null

Key to MS Haul Codes

PriceServiceId

string | null

Notes

string | null

__custom_fields

object

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

Headers

X-Application-Key

string

required

Used to authorize access to the Direct API.

Responses

401

You have not provided a proper X-Application-Key in the header of this request.

403

The X-Application-Key provided is valid but the key does not have access to this resource.

404

The object with the given ID was not found OR a subscriber with the given URL was not found.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Describes issues with the request.