Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
' 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>
'
Dim xml As New ChilkatXml
xml.Tag = "invoice-header"
xml.UpdateChildContent "invoice-number","POSTMAN Collection - 1"
xml.UpdateChildContent "document-type","Invoice"
success = xml.UpdateAttrAt("supplier|id",1,"type","integer")
xml.UpdateChildContentInt "supplier|id",292
success = xml.UpdateAttrAt("invoice-lines",1,"type","array")
success = xml.UpdateAttrAt("invoice-lines|invoice-line|id",1,"type","integer")
xml.UpdateChildContentInt "invoice-lines|invoice-line|id",3056
success = xml.UpdateAttrAt("invoice-lines|invoice-line|line-num",1,"type","integer")
xml.UpdateChildContentInt "invoice-lines|invoice-line|line-num",1
success = xml.UpdateAttrAt("invoice-lines|invoice-line|quantity",1,"type","decimal")
xml.UpdateChildContent "invoice-lines|invoice-line|quantity","5.0"
xml.UpdateChildContent "invoice-lines|invoice-line|type","InvoiceQuantityLine"
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim sbRequestBody As New ChilkatStringBuilder
success = xml.GetXmlSb(sbRequestBody)
Dim resp As ChilkatHttpResponse
Set resp = http.PTextSb("PUT","https://domain.com/invoices/:id?return_object=limited",sbRequestBody,"utf-8","application/xml",0,0)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Debug.Print resp.StatusCode
Debug.Print resp.BodyStr
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": [
]
}