Getting StartedAPI Reference
API Reference

Executes the Cancel action for the Invoice Batches data object.

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

Cancels a 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

Schema for canceling an Inventory Batch.

integer
required
1 to 255

The Company ID.

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

The accounting month/period for the batch (Format YYYY-MM-01).

integer
required

The unique identifier of the batch to cancel. If the batch is locked by someone else or can not otherwise be canceled, this action will return an error.

boolean

Optional. If true, attempts to clear entries from the batch before cancellation. Defaults to false. If false or omitted, the action will fail if the batch contains entries.

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