Chilkat Online Tools

TCL / Coupa Postman Collection - OAuth - Master / Add/update a invoice line

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

# 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-number>POSTMAN Collection - 1</invoice-number>
#     <document-type>Invoice</document-type>
#     <supplier>
#         <id type="integer">292</id>
#     </supplier>
#     <invoice-lines type="array">
#         <invoice-line>
#             <id type="integer">3056</id>
#             <line-num type="integer">1</line-num>
#             <quantity type="decimal">5.0</quantity>
#             <type>InvoiceQuantityLine</type>
#         </invoice-line>
#     </invoice-lines>
# </invoice-header>
# 

set xml [new_CkXml]

CkXml_put_Tag $xml "invoice-header"
CkXml_UpdateChildContent $xml "invoice-number" "POSTMAN Collection - 1"
CkXml_UpdateChildContent $xml "document-type" "Invoice"
CkXml_UpdateAttrAt $xml "supplier|id" 1 "type" "integer"
CkXml_UpdateChildContentInt $xml "supplier|id" 292
CkXml_UpdateAttrAt $xml "invoice-lines" 1 "type" "array"
CkXml_UpdateAttrAt $xml "invoice-lines|invoice-line|id" 1 "type" "integer"
CkXml_UpdateChildContentInt $xml "invoice-lines|invoice-line|id" 3056
CkXml_UpdateAttrAt $xml "invoice-lines|invoice-line|line-num" 1 "type" "integer"
CkXml_UpdateChildContentInt $xml "invoice-lines|invoice-line|line-num" 1
CkXml_UpdateAttrAt $xml "invoice-lines|invoice-line|quantity" 1 "type" "decimal"
CkXml_UpdateChildContent $xml "invoice-lines|invoice-line|quantity" "5.0"
CkXml_UpdateChildContent $xml "invoice-lines|invoice-line|type" "InvoiceQuantityLine"

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

set sbRequestBody [new_CkStringBuilder]

CkXml_GetXmlSb $xml $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://domain.com/invoices/:id?return_object=limited" $sbRequestBody "utf-8" "application/xml" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkXml $xml
    delete_CkStringBuilder $sbRequestBody
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkXml $xml
delete_CkStringBuilder $sbRequestBody

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '<invoice-header>
    <invoice-number>POSTMAN Collection - 1</invoice-number>
    <document-type>Invoice</document-type>
    <supplier>
        <id type="integer">292</id>
    </supplier>
    <invoice-lines type="array">
        <invoice-line>
            <id type="integer">3056</id>
            <line-num type="integer">1</line-num>
            <quantity type="decimal">5.0</quantity>
            <type>InvoiceQuantityLine</type>
        </invoice-line>
    </invoice-lines>
</invoice-header>'
https://domain.com/invoices/:id?return_object=limited

Postman Collection Item JSON

{
  "name": "Add/update a invoice line",
  "protocolProfileBehavior": {
    "disabledSystemHeaders": {}
  },
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "<invoice-header>\r\n    <invoice-number>POSTMAN Collection - 1</invoice-number>\r\n    <document-type>Invoice</document-type>\r\n    <supplier>\r\n        <id type=\"integer\">292</id>\r\n    </supplier>\r\n    <invoice-lines type=\"array\">\r\n        <invoice-line>\r\n            <id type=\"integer\">3056</id>\r\n            <line-num type=\"integer\">1</line-num>\r\n            <quantity type=\"decimal\">5.0</quantity>\r\n            <type>InvoiceQuantityLine</type>\r\n        </invoice-line>\r\n    </invoice-lines>\r\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"
        }
      ]
    },
    "description": "Updates are not restricted to Approved invoices. So be cautious of the document status before updating.\n\nUse the PUT call to add invoice lines.  Line Num is not sufficient to update an existing line. Include the line ID to update an existing line. If Line ID is not included in the payload, a new line will be created with duplicate line number."
  },
  "response": [
  ]
}