Chilkat Online Tools

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

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

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

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

    // Adds the "Authorization: Bearer <access_token>" header.
    http.authToken = "<access_token>"

    let sbRequestBody = CkoStringBuilder()!
    xml.getSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.pTextSb("POST", url: "https://domain.com/contracts/", textData: sbRequestBody, charset: "utf-8", contentType: "application/xml", md5: false, gzip: false)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("\(resp!.statusCode.intValue)")
    print("\(resp!.bodyStr!)")
    resp = nil

}

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