Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequest('PUT','https://domain.com/invoices/:id/void?return_object=limited');
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";
?>
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
https://domain.com/invoices/:id/void?return_object=limited
Postman Collection Item JSON
{
"name": "Void an approved Invoice",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "\r\n"
},
"url": {
"raw": "{{URL}}/invoices/:id/void?return_object=limited",
"host": [
"{{URL}}"
],
"path": [
"invoices",
":id",
"void"
],
"query": [
{
"key": "return_object",
"value": "limited"
}
],
"variable": [
{
"key": "id",
"value": "1285"
}
]
},
"description": "Void an approved invoice\n\nThis can be used on Invoices only on approved and pending receipt Invoices.\n\nBUYER_VOIDABLE_STATUSES = [:pending_receipt, :approved, :draft]\nSUPPLIER_VOIDABLE_STATUSES = [:pending_receipt, :approved]"
},
"response": [
]
}