Chilkat Online Tools

Swift / Razorpay APIs / Create an Invoice

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

    http.BasicAuth = true
    http.Login = "username"
    http.Password = "password"

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "type": "invoice",
    //   "description": "Domestic invoice for Gaurav Kumar.",
    //   "partial_payment": true,
    //   "customer": {
    //     "name": "Gaurav Kumar",
    //     "contact": "9876543210",
    //     "email": "gaurav.kumar@example.com",
    //     "billing_address": {
    //       "line1": "Ground FLoor, Millennium Tower, 1st Avenue",
    //       "line2": "1st Avenue",
    //       "zipcode": "560001",
    //       "city": "Bangalore",
    //       "state": "Karnataka",
    //       "country": "India"
    //     },
    //     "shipping_address": {
    //       "line1": "3rd FLoor, Nakamura Tower, Bomaye Boulevard",
    //       "line2": "Baker Street",
    //       "zipcode": "560001",
    //       "city": "Bangalore",
    //       "state": "Karnataka",
    //       "country": "in"
    //     }
    //   },
    //   "line_items": [
    //     {
    //       "name": "Crate of sea weed",
    //       "description": "Crate of sea weed.",
    //       "amount": 20000,
    //       "currency": "INR",
    //       "quantity": 1
    //     },
    //     {
    //       "item_id": "{item_id}"
    //     }
    //   ],
    //   "sms_notify": 1,
    //   "email_notify": 1,
    //   "draft": "1",
    //   "date": 1588076279,
    //   "expire_by": 1924991999,
    //   "receipt": "Receipt No. 1",
    //   "comment": "Fresh sea weed mowed this morning",
    //   "terms": "No Returns; No Refunds",
    //   "notes": {
    //     "notes_key_1": "Tea, Earl Grey, Hot",
    //     "notes_key_2": "Tea, Earl Grey… decaf."
    //   }
    // }

    let json = CkoJsonObject()
    json.UpdateString("type", value: "invoice")
    json.UpdateString("description", value: "Domestic invoice for Gaurav Kumar.")
    json.UpdateBool("partial_payment", value: true)
    json.UpdateString("customer.name", value: "Gaurav Kumar")
    json.UpdateString("customer.contact", value: "9876543210")
    json.UpdateString("customer.email", value: "gaurav.kumar@example.com")
    json.UpdateString("customer.billing_address.line1", value: "Ground FLoor, Millennium Tower, 1st Avenue")
    json.UpdateString("customer.billing_address.line2", value: "1st Avenue")
    json.UpdateString("customer.billing_address.zipcode", value: "560001")
    json.UpdateString("customer.billing_address.city", value: "Bangalore")
    json.UpdateString("customer.billing_address.state", value: "Karnataka")
    json.UpdateString("customer.billing_address.country", value: "India")
    json.UpdateString("customer.shipping_address.line1", value: "3rd FLoor, Nakamura Tower, Bomaye Boulevard")
    json.UpdateString("customer.shipping_address.line2", value: "Baker Street")
    json.UpdateString("customer.shipping_address.zipcode", value: "560001")
    json.UpdateString("customer.shipping_address.city", value: "Bangalore")
    json.UpdateString("customer.shipping_address.state", value: "Karnataka")
    json.UpdateString("customer.shipping_address.country", value: "in")
    json.UpdateString("line_items[0].name", value: "Crate of sea weed")
    json.UpdateString("line_items[0].description", value: "Crate of sea weed.")
    json.UpdateInt("line_items[0].amount", value: 20000)
    json.UpdateString("line_items[0].currency", value: "INR")
    json.UpdateInt("line_items[0].quantity", value: 1)
    json.UpdateString("line_items[1].item_id", value: "{item_id}")
    json.UpdateInt("sms_notify", value: 1)
    json.UpdateInt("email_notify", value: 1)
    json.UpdateString("draft", value: "1")
    json.UpdateInt("date", value: 1588076279)
    json.UpdateInt("expire_by", value: 1924991999)
    json.UpdateString("receipt", value: "Receipt No. 1")
    json.UpdateString("comment", value: "Fresh sea weed mowed this morning")
    json.UpdateString("terms", value: "No Returns; No Refunds")
    json.UpdateString("notes.notes_key_1", value: "Tea, Earl Grey, Hot")
    json.UpdateString("notes.notes_key_2", value: "Tea, Earl Grey… decaf.")

    http.SetRequestHeader("Content-Type", value: "application/json")

    var resp: CkoHttpResponse? = http.PostJson3("https://api.razorpay.com/v1/invoices", contentType: "application/json", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    print("\(resp!.StatusCode.intValue)")
    print("\(resp!.BodyStr)")
    resp = nil

}

Curl Command

curl -X POST
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "type": "invoice",
    "description": "Domestic invoice for Gaurav Kumar.",
    "partial_payment": true,
    "customer": {
        "name": "Gaurav Kumar",
        "contact": "9876543210",
        "email": "gaurav.kumar@example.com",
        "billing_address": {
            "line1": "Ground FLoor, Millennium Tower, 1st Avenue",
            "line2": "1st Avenue",
            "zipcode": "560001",
            "city": "Bangalore",
            "state": "Karnataka",
            "country": "India"
        },
        "shipping_address": {
            "line1": "3rd FLoor, Nakamura Tower, Bomaye Boulevard",
            "line2": "Baker Street",
            "zipcode": "560001",
            "city": "Bangalore",
            "state": "Karnataka",
            "country": "in"
        }
    },
    "line_items": [
        {
            "name": "Crate of sea weed",
            "description": "Crate of sea weed.",
            "amount": 20000,
            "currency": "INR",
            "quantity": 1
        },
        {
            "item_id": "{item_id}"
        }
    ],
    "sms_notify": 1,
    "email_notify": 1,
    "draft": "1",
    "date": 1588076279,
    "expire_by": 1924991999,
    "receipt": "Receipt No. 1",
    "comment": "Fresh sea weed mowed this morning",
    "terms": "No Returns; No Refunds",
    "notes": {
        "notes_key_1": "Tea, Earl Grey, Hot",
        "notes_key_2": "Tea, Earl Grey… decaf."
    }
}'
https://api.razorpay.com/v1/invoices

Postman Collection Item JSON

{
  "name": "Create an Invoice",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"type\": \"invoice\",\n    \"description\": \"Domestic invoice for Gaurav Kumar.\",\n    \"partial_payment\": true,\n    \"customer\": {\n        \"name\": \"Gaurav Kumar\",\n        \"contact\": \"9876543210\",\n        \"email\": \"gaurav.kumar@example.com\",\n        \"billing_address\": {\n            \"line1\": \"Ground FLoor, Millennium Tower, 1st Avenue\",\n            \"line2\": \"1st Avenue\",\n            \"zipcode\": \"560001\",\n            \"city\": \"Bangalore\",\n            \"state\": \"Karnataka\",\n            \"country\": \"India\"\n        },\n        \"shipping_address\": {\n            \"line1\": \"3rd FLoor, Nakamura Tower, Bomaye Boulevard\",\n            \"line2\": \"Baker Street\",\n            \"zipcode\": \"560001\",\n            \"city\": \"Bangalore\",\n            \"state\": \"Karnataka\",\n            \"country\": \"in\"\n        }\n    },\n    \"line_items\": [\n        {\n            \"name\": \"Crate of sea weed\",\n            \"description\": \"Crate of sea weed.\",\n            \"amount\": 20000,\n            \"currency\": \"INR\",\n            \"quantity\": 1\n        },\n        {\n            \"item_id\": \"{item_id}\"\n        }\n    ],\n    \"sms_notify\": 1,\n    \"email_notify\": 1,\n    \"draft\": \"1\",\n    \"date\": 1588076279,\n    \"expire_by\": 1924991999,\n    \"receipt\": \"Receipt No. 1\",\n    \"comment\": \"Fresh sea weed mowed this morning\",\n    \"terms\": \"No Returns; No Refunds\",\n    \"notes\": {\n        \"notes_key_1\": \"Tea, Earl Grey, Hot\",\n        \"notes_key_2\": \"Tea, Earl Grey… decaf.\"\n    }\n}"
    },
    "url": {
      "raw": "https://api.razorpay.com/v1/invoices",
      "protocol": "https",
      "host": [
        "api",
        "razorpay",
        "com"
      ],
      "path": [
        "v1",
        "invoices"
      ],
      "query": [
        {
          "key": "count",
          "value": "10",
          "disabled": true
        },
        {
          "key": "skip",
          "value": "10",
          "disabled": true
        }
      ]
    },
    "description": "Create an Invoice using the Create an Invoice API.\n\nSome points to note. You can:\n- Create a blank invoice (with no details at all) in draft state.\n- Update it with necessary information.\n- Issue it at a later time with the Issue Invoice API. Only after the invoice is issued, you will get a short URL. Also, only after the invoice is issued, it can be sent to customers and the corresponding payment can be made against it.\n- Use <a href=\"https://razorpay.com/docs/api/items/\" target=\"_blank\">Items APIs</a> to create items which you can later use as a template to create line items in an invoice.\n\nKnow more about the <a href=\"https://razorpay.com/docs/api/invoices/#create-an-invoice\" target=\"_blank\">Create an Invoice API</a>."
  },
  "response": [
  ]
}