Chilkat Online Tools

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

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

# resp is a CkHttpResponse
resp = http.QuickRequest("PUT","https://domain.com/invoices/:id/void?return_object=limited")
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\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": [
  ]
}