Chilkat Online Tools

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

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Handle hoXml
    Variant vSbRequestBody
    Handle hoSbRequestBody
    Variant vResp
    Handle hoResp
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // 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>
    // 

    Get Create (RefClass(cComChilkatXml)) To hoXml
    If (Not(IsComObjectCreated(hoXml))) Begin
        Send CreateComObject of hoXml
    End
    Set ComTag Of hoXml To "invoice-header"
    Send ComUpdateChildContent To hoXml "invoice-number" "POSTMAN Collection - 1"
    Send ComUpdateChildContent To hoXml "document-type" "Invoice"
    Get ComUpdateAttrAt Of hoXml "supplier|id" True "type" "integer" To iSuccess
    Send ComUpdateChildContentInt To hoXml "supplier|id" 292
    Get ComUpdateAttrAt Of hoXml "invoice-lines" True "type" "array" To iSuccess
    Get ComUpdateAttrAt Of hoXml "invoice-lines|invoice-line|id" True "type" "integer" To iSuccess
    Send ComUpdateChildContentInt To hoXml "invoice-lines|invoice-line|id" 3056
    Get ComUpdateAttrAt Of hoXml "invoice-lines|invoice-line|line-num" True "type" "integer" To iSuccess
    Send ComUpdateChildContentInt To hoXml "invoice-lines|invoice-line|line-num" 1
    Get ComUpdateAttrAt Of hoXml "invoice-lines|invoice-line|quantity" True "type" "decimal" To iSuccess
    Send ComUpdateChildContent To hoXml "invoice-lines|invoice-line|quantity" "5.0"
    Send ComUpdateChildContent To hoXml "invoice-lines|invoice-line|type" "InvoiceQuantityLine"

    // Adds the "Authorization: Bearer <access_token>" header.
    Set ComAuthToken Of hoHttp To "<access_token>"

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
    If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
        Send CreateComObject of hoSbRequestBody
    End
    Get pvComObject of hoSbRequestBody to vSbRequestBody
    Get ComGetXmlSb Of hoXml vSbRequestBody To iSuccess

    Get pvComObject of hoSbRequestBody to vSbRequestBody
    Get ComPTextSb Of hoHttp "PUT" "https://domain.com/invoices/:id?return_object=limited" vSbRequestBody "utf-8" "application/xml" False False To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComStatusCode Of hoResp To iTemp1
    Showln iTemp1
    Get ComBodyStr Of hoResp To sTemp1
    Showln sTemp1
    Send Destroy of hoResp


End_Procedure

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