Chilkat Online Tools

PureBasic / Coupa Postman Collection - OAuth - Master / Update invoice line accounting details

Back to Collection Items

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkXml.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

    ; Use this online tool to generate code from sample XML: Generate Code to Create XML

    ; The following XML is sent in the request body.

    ; <?xml version="1.0" encoding="utf-8"?>
    ; <invoice-header>
    ;     <invoice-lines type="array">
    ;         <invoice-line>
    ;             <id type="integer">3056</id>
    ;             <account>
    ;                 <code>DUM_SEG_1_LV_1-DUM_SEG_2_LV_1</code>
    ;                 <account-type>
    ;                     <name>Dummy 2 Chart of Accounts</name>
    ;                     <currency>
    ;                         <code>USD</code>
    ;                     </currency>
    ;                 </account-type>
    ;             </account>
    ;         </invoice-line>
    ;     </invoice-lines>
    ; </invoice-header>
    ; 

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

    CkXml::setCkTag(xml, "invoice-header")
    CkXml::ckUpdateAttrAt(xml,"invoice-lines",1,"type","array")
    CkXml::ckUpdateAttrAt(xml,"invoice-lines|invoice-line|id",1,"type","integer")
    CkXml::ckUpdateChildContentInt(xml,"invoice-lines|invoice-line|id",3056)
    CkXml::ckUpdateChildContent(xml,"invoice-lines|invoice-line|account|code","DUM_SEG_1_LV_1-DUM_SEG_2_LV_1")
    CkXml::ckUpdateChildContent(xml,"invoice-lines|invoice-line|account|account-type|name","Dummy 2 Chart of Accounts")
    CkXml::ckUpdateChildContent(xml,"invoice-lines|invoice-line|account|account-type|currency|code","USD")

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

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

    CkXml::ckGetXmlSb(xml,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/invoices/:id?return_object=limited",sbRequestBody,"utf-8","application/xml",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkXml::ckDispose(xml)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

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



    CkHttp::ckDispose(http)
    CkXml::ckDispose(xml)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '<invoice-header>
  <invoice-lines type="array">
        <invoice-line>
            <id type="integer">3056</id>
            <account>
                <code>DUM_SEG_1_LV_1-DUM_SEG_2_LV_1</code>
                <account-type>
                    <name>Dummy 2 Chart of Accounts</name>
                    <currency>
                        <code>USD</code>
                    </currency>
                </account-type>
            </account>
        </invoice-line>
    </invoice-lines>
</invoice-header>'
https://domain.com/invoices/:id?return_object=limited

Postman Collection Item JSON

{
  "name": "Update invoice line accounting details",
  "protocolProfileBehavior": {
    "disabledSystemHeaders": {}
  },
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "<invoice-header>\n  <invoice-lines type=\"array\">\n        <invoice-line>\n            <id type=\"integer\">3056</id>\n            <account>\n                <code>DUM_SEG_1_LV_1-DUM_SEG_2_LV_1</code>\n                <account-type>\n                    <name>Dummy 2 Chart of Accounts</name>\n                    <currency>\n                        <code>USD</code>\n                    </currency>\n                </account-type>\n            </account>\n        </invoice-line>\n    </invoice-lines>\n</invoice-header>",
      "options": {
        "raw": {
          "language": "xml"
        }
      }
    },
    "url": {
      "raw": "{{URL}}/invoices/:id?return_object=limited",
      "host": [
        "{{URL}}"
      ],
      "path": [
        "invoices",
        ":id"
      ],
      "query": [
        {
          "key": "return_object",
          "value": "limited"
        }
      ],
      "variable": [
        {
          "key": "id",
          "value": "1308"
        }
      ]
    }
  },
  "response": [
  ]
}