Getting StartedAPI Reference
API Reference

Executes the Add Labor action for the Work Order Completed data object.

post
https://api.xchange.trimble.com/connect/v1/direct/subscribers//vista/sm/2/data/wo_work_completeds/actions/add_labor

Adds a 2-Labor type Work Completed record.

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

Key to sm/wo_work_completeds(SMCo, WorkOrder, WorkCompleted). Key to sm/work_order(SMCo, WorkOrder).

integer
required

Key to sm/wo_work_completeds(SMCo, WorkOrder, WorkCompleted). Key to sm/work_order(SMCo, WorkOrder).

integer
required

Key to Scopes array in sm/work_order(SMCo, WorkOrder).

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

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

string
enum

Optional. If omitted, it will be defaulted based on Vista defaulting logic.

Allowed:
string
enum

Optional. If omitted, N will be defaulted.

Allowed:
string | null
integer | null
string | null
enum
Allowed:
string | null
required
string | null
string | null

Optional. If omitted, null will be defaulted.

string | null

Optional. If omitted, null will be defaulted.

integer | null

Optional. If omitted, null will be defaulted.

string | null

Optional. If omitted, null will be defaulted.

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

Non-zero value. Optional. If omitted and CostRate is provided, ActualCost/CostRate will be defaulted. Otherwise, null will be defaulted.

Payroll
object

Optional. If omitted all properties will default as specified. This property is ignored if $.NonBillable = Y.

Equipment
object

Optional. If omitted all properties will default as specified. This property is ignored if $.NonBillable = Y.

Billable
object

Optional. If omitted all properties will default as specified. This property is ignored if $.NonBillable = Y.

Taxes
object

Optional. If omitted each property will be be defaulted based on Vista defaulting behavior.

Accounts
object

Optional. If omitted all properties will default as specified. This property is ignored if $.NonBillable = Y.

string | null
__custom_fields
object

Add a property to this object for each user defined field to be set. Property name set to the user defined field name.

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 4 months ago

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

Updated 4 months ago