Chilkat Online Tools

VB6 / Coupa Postman Collection - OAuth - Master / Create a Contract

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"?>
' <contract>
'     <name>Test API Contract 159753</name>
'     <number>159753</number>
'     <type>Equipment Lease</type>
'     <version type="integer">1</version>
'     <start-date type="dateTime">2021-12-20T00:00:00+05:30</start-date>
'     <end-date type="dateTime">2022-12-20T00:00:00+05:30</end-date>
'     <status>draft</status>
'     <minimum-value type="decimal">100.00</minimum-value>
'     <maximum-value type="decimal">2000.00</maximum-value>
'     <stop-spend-based-on-max-value>Yes</stop-spend-based-on-max-value>
'     <terms>Annual</terms>
'     <savings-pct>10</savings-pct>
'     <supplier-invoiceable type="boolean">true</supplier-invoiceable>
'     <is-default type="boolean">true</is-default>
'     <preferred nil="true"/>
'     <min-commit type="decimal">0.00</min-commit>
'     <max-commit type="decimal">0.00</max-commit>
'     <supplier-account/>
'     <use-order-windows type="boolean">false</use-order-windows>
'     <order-window-tz>Asia/Kolkata</order-window-tz>
'     <requisition-message/>
'     <po-message/>
'     <legal-agreement-url nil="true"/>
'     <current-approval nil="true"/>
'     <used-for-buying type="boolean">true</used-for-buying>
'     <strict-invoicing-rules type="boolean">false</strict-invoicing-rules>
'     <term-type nil="true"/>
'     <auto-extend-end-date-for-renewal type="boolean">false</auto-extend-end-date-for-renewal>
'     <terminated type="boolean">false</terminated>
'     <termination-notice nil="true"/>
'     <termination-notice-length-unit nil="true"/>
'     <termination-notice-length-value nil="true"/>
'     <consent nil="true"/>
'     <no-of-renewals nil="true"/>
'     <renewal-length-unit nil="true"/>
'     <renewal-length-value nil="true"/>
'     <length-of-notice-unit nil="true"/>
'     <length-of-notice-value nil="true"/>
'     <source-id nil="true"/>
'     <source-type nil="true"/>
'     <source nil="true"/>
'     <amended-contract-type nil="true"/>
'     <quote-response-id nil="true"/>
'     <description/>
'     <execution-date nil="true"/>
'     <supplier>
'         <number>123456</number>
'     </supplier>
'     <currency>
'         <code>USD</code>
'     </currency>
'     <content-groups type="array">
'         <content-group>
'             <name>Everyone</name>
'         </content-group>
'     </content-groups>
'     <reason-insight-events type="array"/>
'     <schedule>
'         <day0>anytime</day0>
'         <day1>anytime</day1>
'         <day2>anytime</day2>
'         <day3>anytime</day3>
'         <day4>anytime</day4>
'         <day5>anytime</day5>
'         <day6>anytime</day6>
'     </schedule>
'     <contract-terms type="array"/>
'     <submitter>
'         <login>coupasam</login>
'     </submitter>
'     <tags type="array"/>
'     <taggings type="array"/>
'     <contract-owner>
'         <login>coupasam</login>
'     </contract-owner>
' </contract>
' 

Dim xml As New ChilkatXml
xml.Tag = "contract"
xml.UpdateChildContent "name","Test API Contract 159753"
xml.UpdateChildContentInt "number",159753
xml.UpdateChildContent "type","Equipment Lease"
success = xml.UpdateAttrAt("version",1,"type","integer")
xml.UpdateChildContentInt "version",1
success = xml.UpdateAttrAt("start-date",1,"type","dateTime")
xml.UpdateChildContent "start-date","2021-12-20T00:00:00+05:30"
success = xml.UpdateAttrAt("end-date",1,"type","dateTime")
xml.UpdateChildContent "end-date","2022-12-20T00:00:00+05:30"
xml.UpdateChildContent "status","draft"
success = xml.UpdateAttrAt("minimum-value",1,"type","decimal")
xml.UpdateChildContent "minimum-value","100.00"
success = xml.UpdateAttrAt("maximum-value",1,"type","decimal")
xml.UpdateChildContent "maximum-value","2000.00"
xml.UpdateChildContent "stop-spend-based-on-max-value","Yes"
xml.UpdateChildContent "terms","Annual"
xml.UpdateChildContentInt "savings-pct",10
success = xml.UpdateAttrAt("supplier-invoiceable",1,"type","boolean")
xml.UpdateChildContent "supplier-invoiceable","true"
success = xml.UpdateAttrAt("is-default",1,"type","boolean")
xml.UpdateChildContent "is-default","true"
success = xml.UpdateAttrAt("preferred",1,"nil","true")
success = xml.UpdateAttrAt("min-commit",1,"type","decimal")
xml.UpdateChildContent "min-commit","0.00"
success = xml.UpdateAttrAt("max-commit",1,"type","decimal")
xml.UpdateChildContent "max-commit","0.00"
xml.UpdateChildContent "supplier-account",""
success = xml.UpdateAttrAt("use-order-windows",1,"type","boolean")
xml.UpdateChildContent "use-order-windows","false"
xml.UpdateChildContent "order-window-tz","Asia/Kolkata"
xml.UpdateChildContent "requisition-message",""
xml.UpdateChildContent "po-message",""
success = xml.UpdateAttrAt("legal-agreement-url",1,"nil","true")
success = xml.UpdateAttrAt("current-approval",1,"nil","true")
success = xml.UpdateAttrAt("used-for-buying",1,"type","boolean")
xml.UpdateChildContent "used-for-buying","true"
success = xml.UpdateAttrAt("strict-invoicing-rules",1,"type","boolean")
xml.UpdateChildContent "strict-invoicing-rules","false"
success = xml.UpdateAttrAt("term-type",1,"nil","true")
success = xml.UpdateAttrAt("auto-extend-end-date-for-renewal",1,"type","boolean")
xml.UpdateChildContent "auto-extend-end-date-for-renewal","false"
success = xml.UpdateAttrAt("terminated",1,"type","boolean")
xml.UpdateChildContent "terminated","false"
success = xml.UpdateAttrAt("termination-notice",1,"nil","true")
success = xml.UpdateAttrAt("termination-notice-length-unit",1,"nil","true")
success = xml.UpdateAttrAt("termination-notice-length-value",1,"nil","true")
success = xml.UpdateAttrAt("consent",1,"nil","true")
success = xml.UpdateAttrAt("no-of-renewals",1,"nil","true")
success = xml.UpdateAttrAt("renewal-length-unit",1,"nil","true")
success = xml.UpdateAttrAt("renewal-length-value",1,"nil","true")
success = xml.UpdateAttrAt("length-of-notice-unit",1,"nil","true")
success = xml.UpdateAttrAt("length-of-notice-value",1,"nil","true")
success = xml.UpdateAttrAt("source-id",1,"nil","true")
success = xml.UpdateAttrAt("source-type",1,"nil","true")
success = xml.UpdateAttrAt("source",1,"nil","true")
success = xml.UpdateAttrAt("amended-contract-type",1,"nil","true")
success = xml.UpdateAttrAt("quote-response-id",1,"nil","true")
xml.UpdateChildContent "description",""
success = xml.UpdateAttrAt("execution-date",1,"nil","true")
xml.UpdateChildContentInt "supplier|number",123456
xml.UpdateChildContent "currency|code","USD"
success = xml.UpdateAttrAt("content-groups",1,"type","array")
xml.UpdateChildContent "content-groups|content-group|name","Everyone"
success = xml.UpdateAttrAt("reason-insight-events",1,"type","array")
xml.UpdateChildContent "schedule|day0","anytime"
xml.UpdateChildContent "schedule|day1","anytime"
xml.UpdateChildContent "schedule|day2","anytime"
xml.UpdateChildContent "schedule|day3","anytime"
xml.UpdateChildContent "schedule|day4","anytime"
xml.UpdateChildContent "schedule|day5","anytime"
xml.UpdateChildContent "schedule|day6","anytime"
success = xml.UpdateAttrAt("contract-terms",1,"type","array")
xml.UpdateChildContent "submitter|login","coupasam"
success = xml.UpdateAttrAt("tags",1,"type","array")
success = xml.UpdateAttrAt("taggings",1,"type","array")
xml.UpdateChildContent "contract-owner|login","coupasam"

' 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("POST","https://domain.com/contracts/",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 POST
	-H "Authorization: Bearer <access_token>"
	-d '<?xml version="1.0" encoding="UTF-8"?>
<contract>
    <name>Test API Contract 159753</name>
    <number>159753</number>
    <type>Equipment Lease</type>
    <version type="integer">1</version>
    <start-date type="dateTime">2021-12-20T00:00:00+05:30</start-date>
    <end-date type="dateTime">2022-12-20T00:00:00+05:30</end-date>
    <status>draft</status>
    <minimum-value type="decimal">100.00</minimum-value>
    <maximum-value type="decimal">2000.00</maximum-value>
    <stop-spend-based-on-max-value>Yes</stop-spend-based-on-max-value>
    <terms>Annual</terms>
    <savings-pct>10</savings-pct>
    <supplier-invoiceable type="boolean">true</supplier-invoiceable>
    <is-default type="boolean">true</is-default>
    <preferred nil="true"/>
    <min-commit type="decimal">0.00</min-commit>
    <max-commit type="decimal">0.00</max-commit>
    <supplier-account></supplier-account>
    <use-order-windows type="boolean">false</use-order-windows>
    <order-window-tz>Asia/Kolkata</order-window-tz>
    <requisition-message></requisition-message>
    <po-message></po-message>
    <legal-agreement-url nil="true"/>
    <current-approval nil="true"/>
    <used-for-buying type="boolean">true</used-for-buying>
    <strict-invoicing-rules type="boolean">false</strict-invoicing-rules>
    <term-type nil="true"/>
    <auto-extend-end-date-for-renewal type="boolean">false</auto-extend-end-date-for-renewal>
    <terminated type="boolean">false</terminated>
    <termination-notice nil="true"/>
    <termination-notice-length-unit nil="true"/>
    <termination-notice-length-value nil="true"/>
    <consent nil="true"/>
    <no-of-renewals nil="true"/>
    <renewal-length-unit nil="true"/>
    <renewal-length-value nil="true"/>
    <length-of-notice-unit nil="true"/>
    <length-of-notice-value nil="true"/>
    <source-id nil="true"/>
    <source-type nil="true"/>
    <source nil="true"/>
    <amended-contract-type nil="true"/>
    <quote-response-id nil="true"/>
    <description></description>
    <execution-date nil="true"/>
    <supplier>
        <number>123456</number>
    </supplier>
    <currency>
        <code>USD</code>
    </currency>
    <content-groups type="array">
        <content-group>
            <name>Everyone</name>
        </content-group>
    </content-groups>
    <reason-insight-events type="array"/>
    <schedule>
        <day0>anytime</day0>
        <day1>anytime</day1>
        <day2>anytime</day2>
        <day3>anytime</day3>
        <day4>anytime</day4>
        <day5>anytime</day5>
        <day6>anytime</day6>
    </schedule>
    <contract-terms type="array"/>
    <submitter>
        <login>coupasam</login>
    </submitter>
    <tags type="array"/>
    <taggings type="array"/>
    <contract-owner>
        <login>coupasam</login>
    </contract-owner>
</contract>'
https://domain.com/contracts/

Postman Collection Item JSON

{
  "name": "Create a Contract",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<contract>\n    <name>Test API Contract 159753</name>\n    <number>159753</number>\n    <type>Equipment Lease</type>\n    <version type=\"integer\">1</version>\n    <start-date type=\"dateTime\">2021-12-20T00:00:00+05:30</start-date>\n    <end-date type=\"dateTime\">2022-12-20T00:00:00+05:30</end-date>\n    <status>draft</status>\n    <minimum-value type=\"decimal\">100.00</minimum-value>\n    <maximum-value type=\"decimal\">2000.00</maximum-value>\n    <stop-spend-based-on-max-value>Yes</stop-spend-based-on-max-value>\n    <terms>Annual</terms>\n    <savings-pct>10</savings-pct>\n    <supplier-invoiceable type=\"boolean\">true</supplier-invoiceable>\n    <is-default type=\"boolean\">true</is-default>\n    <preferred nil=\"true\"/>\n    <min-commit type=\"decimal\">0.00</min-commit>\n    <max-commit type=\"decimal\">0.00</max-commit>\n    <supplier-account></supplier-account>\n    <use-order-windows type=\"boolean\">false</use-order-windows>\n    <order-window-tz>Asia/Kolkata</order-window-tz>\n    <requisition-message></requisition-message>\n    <po-message></po-message>\n    <legal-agreement-url nil=\"true\"/>\n    <current-approval nil=\"true\"/>\n    <used-for-buying type=\"boolean\">true</used-for-buying>\n    <strict-invoicing-rules type=\"boolean\">false</strict-invoicing-rules>\n    <term-type nil=\"true\"/>\n    <auto-extend-end-date-for-renewal type=\"boolean\">false</auto-extend-end-date-for-renewal>\n    <terminated type=\"boolean\">false</terminated>\n    <termination-notice nil=\"true\"/>\n    <termination-notice-length-unit nil=\"true\"/>\n    <termination-notice-length-value nil=\"true\"/>\n    <consent nil=\"true\"/>\n    <no-of-renewals nil=\"true\"/>\n    <renewal-length-unit nil=\"true\"/>\n    <renewal-length-value nil=\"true\"/>\n    <length-of-notice-unit nil=\"true\"/>\n    <length-of-notice-value nil=\"true\"/>\n    <source-id nil=\"true\"/>\n    <source-type nil=\"true\"/>\n    <source nil=\"true\"/>\n    <amended-contract-type nil=\"true\"/>\n    <quote-response-id nil=\"true\"/>\n    <description></description>\n    <execution-date nil=\"true\"/>\n    <supplier>\n        <number>123456</number>\n    </supplier>\n    <currency>\n        <code>USD</code>\n    </currency>\n    <content-groups type=\"array\">\n        <content-group>\n            <name>Everyone</name>\n        </content-group>\n    </content-groups>\n    <reason-insight-events type=\"array\"/>\n    <schedule>\n        <day0>anytime</day0>\n        <day1>anytime</day1>\n        <day2>anytime</day2>\n        <day3>anytime</day3>\n        <day4>anytime</day4>\n        <day5>anytime</day5>\n        <day6>anytime</day6>\n    </schedule>\n    <contract-terms type=\"array\"/>\n    <submitter>\n        <login>coupasam</login>\n    </submitter>\n    <tags type=\"array\"/>\n    <taggings type=\"array\"/>\n    <contract-owner>\n        <login>coupasam</login>\n    </contract-owner>\n</contract>",
      "options": {
        "raw": {
          "language": "xml"
        }
      }
    },
    "url": {
      "raw": "{{URL}}/contracts/",
      "host": [
        "{{URL}}"
      ],
      "path": [
        "contracts",
        ""
      ]
    }
  },
  "response": [
  ]
}