Getting StartedAPI Reference
API Reference

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

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

Adds a new Usage entry to an existing Usage batch

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
string
required
integer
required
string
required

Which usage type: J-Job, E-Equipment, X-Expense, W-WorkOrder

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

Optional. If omitted, null will be defaulted. Format: YYYY-MM-DD.

string
required
string
required
string | null

Required if EMTransType is X or W; otherwise will default

integer | null

Defaults to company

integer | null

Defaults to the Job Company of the Equipment Record, if none is found defaults to the Job Company of the EM Company.

string | null

Defaults to the Operator configured on the Equipment. The Employee must be active.

string | null
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$
string | null
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$
string | null
^[-+]?[0-9]{1,10}(?:.[0-9]{0,3})?$
string | null
^[-+]?[0-9]{1,10}(?:.[0-9]{0,3})?$
string | null
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$
string | null
string | null

Required if EMTransType is J

string | null

Required if EMTransType is J

integer | null
integer | null

Defaults to equipment company

string | null

EMCo Required if EMTransType is E

string | null
string | null
integer | null

Required if ComponentType not supplied and EMTransType is E

string | null

Required if ComponentCode not supplied and EMTransType is E

string | null

Required if EMTransType is W

integer | null

Required if EMTransType is W

__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 3 months ago

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

Updated 3 months ago