Getting StartedAPI Reference
API Reference

Executes the Cancel action for the Subcontract Ledger Batches data object.

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

Cancel a SL 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
1 to 255
date
required
^([0-9]{4})-(1[0-2]|0[1-9])-01$

Format YYYY-MM-01.

integer
required

If the batch is locked by someone else or can not otherwise be canceled, this action will return an error.

boolean

Optional. If omitted defaults to false. If omitted or falce this action will return a failure if there are entries in this batch.

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