v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Invoice Batches

Executes the Cancel action for the Invoice Batches data object.

Cancels a batch.

post/direct/subscribers/{subscriber_code}/vista/ap/2/data/inv_batches/actions/cancel

Path parameters

subscriber_codestring required

The code of the subscriber that you are making this request for.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Request body

Cointeger required

The Company ID.

Mthstring date required

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

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

__clearBatchboolean

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.

Response

Success

idstring

operationstring

statusstring