Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loXml
LOCAL loSbRequestBody
LOCAL loResp
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* 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>
*
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Xml')
loXml = CreateObject('Chilkat.Xml')
loXml.Tag = "contract"
loXml.UpdateChildContent("name","Test API Contract 159753")
loXml.UpdateChildContentInt("number",159753)
loXml.UpdateChildContent("type","Equipment Lease")
loXml.UpdateAttrAt("version",1,"type","integer")
loXml.UpdateChildContentInt("version",1)
loXml.UpdateAttrAt("start-date",1,"type","dateTime")
loXml.UpdateChildContent("start-date","2021-12-20T00:00:00+05:30")
loXml.UpdateAttrAt("end-date",1,"type","dateTime")
loXml.UpdateChildContent("end-date","2022-12-20T00:00:00+05:30")
loXml.UpdateChildContent("status","draft")
loXml.UpdateAttrAt("minimum-value",1,"type","decimal")
loXml.UpdateChildContent("minimum-value","100.00")
loXml.UpdateAttrAt("maximum-value",1,"type","decimal")
loXml.UpdateChildContent("maximum-value","2000.00")
loXml.UpdateChildContent("stop-spend-based-on-max-value","Yes")
loXml.UpdateChildContent("terms","Annual")
loXml.UpdateChildContentInt("savings-pct",10)
loXml.UpdateAttrAt("supplier-invoiceable",1,"type","boolean")
loXml.UpdateChildContent("supplier-invoiceable","true")
loXml.UpdateAttrAt("is-default",1,"type","boolean")
loXml.UpdateChildContent("is-default","true")
loXml.UpdateAttrAt("preferred",1,"nil","true")
loXml.UpdateAttrAt("min-commit",1,"type","decimal")
loXml.UpdateChildContent("min-commit","0.00")
loXml.UpdateAttrAt("max-commit",1,"type","decimal")
loXml.UpdateChildContent("max-commit","0.00")
loXml.UpdateChildContent("supplier-account","")
loXml.UpdateAttrAt("use-order-windows",1,"type","boolean")
loXml.UpdateChildContent("use-order-windows","false")
loXml.UpdateChildContent("order-window-tz","Asia/Kolkata")
loXml.UpdateChildContent("requisition-message","")
loXml.UpdateChildContent("po-message","")
loXml.UpdateAttrAt("legal-agreement-url",1,"nil","true")
loXml.UpdateAttrAt("current-approval",1,"nil","true")
loXml.UpdateAttrAt("used-for-buying",1,"type","boolean")
loXml.UpdateChildContent("used-for-buying","true")
loXml.UpdateAttrAt("strict-invoicing-rules",1,"type","boolean")
loXml.UpdateChildContent("strict-invoicing-rules","false")
loXml.UpdateAttrAt("term-type",1,"nil","true")
loXml.UpdateAttrAt("auto-extend-end-date-for-renewal",1,"type","boolean")
loXml.UpdateChildContent("auto-extend-end-date-for-renewal","false")
loXml.UpdateAttrAt("terminated",1,"type","boolean")
loXml.UpdateChildContent("terminated","false")
loXml.UpdateAttrAt("termination-notice",1,"nil","true")
loXml.UpdateAttrAt("termination-notice-length-unit",1,"nil","true")
loXml.UpdateAttrAt("termination-notice-length-value",1,"nil","true")
loXml.UpdateAttrAt("consent",1,"nil","true")
loXml.UpdateAttrAt("no-of-renewals",1,"nil","true")
loXml.UpdateAttrAt("renewal-length-unit",1,"nil","true")
loXml.UpdateAttrAt("renewal-length-value",1,"nil","true")
loXml.UpdateAttrAt("length-of-notice-unit",1,"nil","true")
loXml.UpdateAttrAt("length-of-notice-value",1,"nil","true")
loXml.UpdateAttrAt("source-id",1,"nil","true")
loXml.UpdateAttrAt("source-type",1,"nil","true")
loXml.UpdateAttrAt("source",1,"nil","true")
loXml.UpdateAttrAt("amended-contract-type",1,"nil","true")
loXml.UpdateAttrAt("quote-response-id",1,"nil","true")
loXml.UpdateChildContent("description","")
loXml.UpdateAttrAt("execution-date",1,"nil","true")
loXml.UpdateChildContentInt("supplier|number",123456)
loXml.UpdateChildContent("currency|code","USD")
loXml.UpdateAttrAt("content-groups",1,"type","array")
loXml.UpdateChildContent("content-groups|content-group|name","Everyone")
loXml.UpdateAttrAt("reason-insight-events",1,"type","array")
loXml.UpdateChildContent("schedule|day0","anytime")
loXml.UpdateChildContent("schedule|day1","anytime")
loXml.UpdateChildContent("schedule|day2","anytime")
loXml.UpdateChildContent("schedule|day3","anytime")
loXml.UpdateChildContent("schedule|day4","anytime")
loXml.UpdateChildContent("schedule|day5","anytime")
loXml.UpdateChildContent("schedule|day6","anytime")
loXml.UpdateAttrAt("contract-terms",1,"type","array")
loXml.UpdateChildContent("submitter|login","coupasam")
loXml.UpdateAttrAt("tags",1,"type","array")
loXml.UpdateAttrAt("taggings",1,"type","array")
loXml.UpdateChildContent("contract-owner|login","coupasam")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loXml.GetXmlSb(loSbRequestBody)
loResp = loHttp.PTextSb("POST","https://domain.com/contracts/",loSbRequestBody,"utf-8","application/xml",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loXml
RELEASE loSbRequestBody
CANCEL
ENDIF
? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp
RELEASE loHttp
RELEASE loXml
RELEASE loSbRequestBody
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": [
]
}
