Chilkat Online Tools

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

Back to Collection Items

IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    resp.i = CkHttp::ckQuickRequest(http,"PUT","https://domain.com/invoices/:id/void?return_object=limited")
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)


    ProcedureReturn
EndProcedure

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