Getting StartedAPI Reference
API Reference

Executes the Add Combined 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_combined

Ability to accept any of the four work completed types.

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

Input schema for adding an Equipment Work Completed record.

string
enum
required

Must be 'equipment'

Allowed:
integer
required
1 to 255

SM Company Key.

integer
required

Work Order Key.

integer
required

Work Order Scope Key.

string
required
length ≤ 10

Required to add a new equipment

string | null
required

Required to determinate if time or work units are going to be use.

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

Optional. Format: YYYY-MM-DD.

string
enum

Optional. Defaulted based on Vista logic.

Allowed:
string
enum

Optional. Defaults to N.

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

Optional. Format YYYY-MM-01.

string | null

Agreement code.

integer | null

Agreement revision number.

string | null
enum

Use agreement rates flag.

Allowed:
string | null

Technician key value.

string | null

Reference number.

string | null

Service item key.

integer | null

SM Cost Type.

integer
1 to 255

EM Company value.

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

Cost rate.

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

Actual cost value.

string | null

Notes.

Billable
object

Billable amounts and rates. Ignored if NonBillable = Y.

Taxes
object

Tax structure definition.

Accounts
object

GL Account structure definition.

__custom_fields
object

User defined fields.

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