Getting StartedAPI Reference
API Reference

Executes the Add action for the Material Usage Batch Entries data object.

post
https://api.xchange.trimble.com/connect/v1/direct/subscribers//vista/jc/2/data/mat_use_bat_entries/actions/add

Adds a new Material Use batch entry

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

Body Params
integer
required
1 to 255

Company. Key to jc/mat_use_batches(Co, Mth, BatchId).

date
required
^([0-9]{4})-(1[0-2]|0[1-9])-01$

Key to jc/mat_use_batches(Co, Mth, BatchId). Format: YYYY-MM-01.

integer
required

Key to jc/mat_use_batches(Co, Mth, BatchId).

string
enum
required

Options: IN-Inventory, MI-Miscellaneous

Allowed:
integer | null

Inventory Company. Must be null if JCTransType = MI. Required if JCTransType = IN. Optional. If omitted, null will be defaulted.

string | null

Inventory Company. Must be null if JCTransType = MI. Required if JCTransType = IN. Optional. If omitted, null will be defaulted.

string
required
length ≤ 20

Key to hq/materials(MatlGroup, Material). The MatlGroup will be selected based on the HQ company_parameters for the Co company.

string
required
length ≤ 10

Key to jc/jobs(JCCo, Job). The JCCo will be set based on the Co value.

string
required
length ≤ 20

Key to jc/job_phases(JCCo, Job, PhaseGroup, Phase) The PhaseGroup will be selected based on the Co value.

integer
required

Key to CostTypes array in jc/job_phases(JCCo, Job, PhaseGroup, Phase, $.CostTypes.CostType).

string
required
length ≤ 60

Non-Empty string is required.

string | null

Key to gl/chart_of_accounts(GLCo, GLTransAcct). GLCo will be defaulted based on jc/company_parameters.Optional. If omitted, it will be defaulted based Vista defaulting behavior. This value may be ignored if Allow GL Account Override is not allowed.

string | null

Key to gl/chart_of_accounts(OffsetGLCo, GLOffsetAcct). OffsetGLCo will be defaulted based on in/company_parameters. Optional. If omitted, it will be defaulted based Vista defaulting behavior. This value may be ignored if Allow GL Account Override is not allowed.

date
required

Format: YYY-MM-DD. Optional. If omitted, it will be defaulted to the current date.

Amount
object

If omitted, each property will be defaulted as noted on each property.

Tax
object

Optional. If omitted each property will be be defaulted based on Vista defaulting behavior. Providing this value when the Use Tax on Material box is not checked will result in an error.

__custom_fields
object

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.

Headers
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.

Updated about 1 month ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago