Getting StartedAPI Reference
API Reference

Executes the Add action for the Subcontract Ledger Batch Entries data object.

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

Add Subcontract to a 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
string
required
integer
required
string | null
required
integer | null
required

This property will default based on the provided Co if not set.

string
required
length ≤ 10

Validates against JCCo.

string | null
integer
required
string | null
string | null

Defaulted from Vendor if not provided.

string | null

Defaulted from Job if not provided.

string | null
string | null
string | null
enum

N - None, P - Percent of Subcontract, A - Maximum Amount

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

If MaxRetgOpt = P, this field can be set.

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

If MaxRetgOpt = A, this field can be set.

string | null
enum

If MaxRetgOpt = P, this field can be set. Default to Y.

Allowed:
string | null
enum

If MaxRetgOpt = A OR P, this field can be set, it will Default to C. C = Composite Percentage same on all Items, I = Use Item's Percentage value from invoice.

Allowed:
string
enum
length ≤ 1

Defaults to N.

Allowed:
string
enum

Fields are only available if the Default Country is AU

Allowed:
string | null

Fields are only available if the Default Country is AU

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

LineItems
array of objects
required
length ≥ 1
LineItems*
integer

Defaults to next Available Line if not provided.

integer

Regular = 1, BackCharge = 3, Addon = 4. Will Default to 1 if not provided.

integer | null

Addon can only be specified on Addon Lines (LineType = 4)

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

Defaulted to Job from Header if not provided.

string
required
length ≤ 20
integer
required
string | null
string
length ≤ 3

Unit of Measure for this line item. UM will default to the specified UM of the JobPhase CostType set up on the Job, UM will be ignored on Addon Lines (LineType = 4)

string
length ≤ 20

Will default from Vendor and Job. If GLOverrides are not allowed this value is ignored and the default value is always input.

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

Work completed retainage percentage, Defaulted based on the Phase if not provided.

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

Stored materials retainage percentage, Defaulted based on the Phase if not provided.

integer | null

Supplier can only be specified on Regular Lines (LineType = 1)

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

Tax Type : Sales = 1, Use = 2, VAT = 3. Default to 1 if Default Company US and 3 if not US.

string | null

Defaults Tax Code based on Vista Defaulting Logic.

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

Tax Amount. Defaulted based on the TaxRate of the TaxCode * OrigCost

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

Defaulted based on the Tax Code.

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

Only input if TaxType is VAT = 3

string
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$
__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