Chilkat Online Tools

delphiDll / Coupa Postman Collection - OAuth - Master / Void an approved Invoice

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
resp: HCkHttpResponse;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := CkHttp_Create();

// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');

resp := CkHttp_QuickRequest(http,'PUT','https://domain.com/invoices/:id/void?return_object=limited');
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);

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": [
  ]
}