Chilkat Online Tools

PureBasic / Coupa Postman Collection - OAuth - Master / Get Pay Invoices - Fields Query Param

Back to Collection Items

IncludeFile "CkJsonObject.pb"
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

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

    CkJsonObject::ckUpdateString(queryParams,"status[in]","wc_consideration,ready_to_pay")
    CkJsonObject::ckUpdateString(queryParams,"exported","false")
    CkJsonObject::ckUpdateString(queryParams,"fields","[" + Chr(34) + "id" + Chr(34) + "," + Chr(34) + "status" + Chr(34) + "," + Chr(34) + "exported" + Chr(34) + "," + Chr(34) + "remaining_total" + Chr(34) + "," + Chr(34) + "discount_amount" + Chr(34) + "," + Chr(34) + "discount_rate" + Chr(34) + "," + Chr(34) + "discount_due_date" + Chr(34) + ",{" + Chr(34) + "invoice_header" + Chr(34) + ":[" + Chr(34) + "id" + Chr(34) + "," + Chr(34) + "invoice_number" + Chr(34) + ",{" + Chr(34) + "supplier" + Chr(34) + ":[" + Chr(34) + "name" + Chr(34) + "," + Chr(34) + "number" + Chr(34) + "]}]},{" + Chr(34) + "currency" + Chr(34) + ":[" + Chr(34) + "code" + Chr(34) + "]}]")

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

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/coupa_pay/invoices",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

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



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)


    ProcedureReturn
EndProcedure

Curl Command

curl -G -d "status[in]=wc_consideration,ready_to_pay"
	-d "exported=false"
	-d "fields=%5B%22id%22,%22status%22,%22exported%22,%22remaining_total%22,%22discount_amount%22,%22discount_rate%22,%22discount_due_date%22,%7B%22invoice_header%22%3A%5B%22id%22,%22invoice_number%22,%7B%22supplier%22%3A%5B%22name%22,%22number%22%5D%7D%5D%7D,%7B%22currency%22%3A%5B%22code%22%5D%7D%5D"
	-H "Authorization: Bearer <access_token>"
https://domain.com/coupa_pay/invoices

Postman Collection Item JSON

{
  "name": "Get Pay Invoices - Fields Query Param",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{URL}}/coupa_pay/invoices?status[in]=wc_consideration,ready_to_pay&exported=false&fields=[\"id\",\"status\",\"exported\",\"remaining_total\",\"discount_amount\",\"discount_rate\",\"discount_due_date\",{\"invoice_header\":[\"id\",\"invoice_number\",{\"supplier\":[\"name\",\"number\"]}]},{\"currency\":[\"code\"]}] ",
      "host": [
        "{{URL}}"
      ],
      "path": [
        "coupa_pay",
        "invoices"
      ],
      "query": [
        {
          "key": "status[in]",
          "value": "wc_consideration,ready_to_pay"
        },
        {
          "key": "exported",
          "value": "false"
        },
        {
          "key": "fields",
          "value": "[\"id\",\"status\",\"exported\",\"remaining_total\",\"discount_amount\",\"discount_rate\",\"discount_due_date\",{\"invoice_header\":[\"id\",\"invoice_number\",{\"supplier\":[\"name\",\"number\"]}]},{\"currency\":[\"code\"]}] "
        }
      ]
    }
  },
  "response": [
  ]
}