PureBasic / Razorpay APIs / Update an Invoice
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "username")
CkHttp::setCkPassword(http, "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.
; {
; "partial_payment": true,
; "customer": {
; "name": "Saurav Kumar",
; "contact": "9123456789",
; "email": "saurav.kumar@example.com"
; },
; "line_items": [
; {
; "name": "Crate of Red Herbs",
; "description": "Red Herbs from Resident Evil",
; "amount": 50000,
; "currency": "INR",
; "quantity": 5
; },
; {
; "item_id": "{item_id}"
; }
; ],
; "sms_notify": 1,
; "email_notify": 1,
; "draft": "1",
; "date": 1588076279,
; "expire_by": 1924991999,
; "receipt": "Receipt No. 1",
; "comment": "Fresh herbs mowed this morning",
; "terms": "No Returns; No Refunds",
; "notes": {
; "notes_key_1": "Beam me up Scotty.",
; "notes_key_2": "Engage"
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateBool(json,"partial_payment",1)
CkJsonObject::ckUpdateString(json,"customer.name","Saurav Kumar")
CkJsonObject::ckUpdateString(json,"customer.contact","9123456789")
CkJsonObject::ckUpdateString(json,"customer.email","saurav.kumar@example.com")
CkJsonObject::ckUpdateString(json,"line_items[0].name","Crate of Red Herbs")
CkJsonObject::ckUpdateString(json,"line_items[0].description","Red Herbs from Resident Evil")
CkJsonObject::ckUpdateInt(json,"line_items[0].amount",50000)
CkJsonObject::ckUpdateString(json,"line_items[0].currency","INR")
CkJsonObject::ckUpdateInt(json,"line_items[0].quantity",5)
CkJsonObject::ckUpdateString(json,"line_items[1].item_id","{item_id}")
CkJsonObject::ckUpdateInt(json,"sms_notify",1)
CkJsonObject::ckUpdateInt(json,"email_notify",1)
CkJsonObject::ckUpdateString(json,"draft","1")
CkJsonObject::ckUpdateInt(json,"date",1588076279)
CkJsonObject::ckUpdateInt(json,"expire_by",1924991999)
CkJsonObject::ckUpdateString(json,"receipt","Receipt No. 1")
CkJsonObject::ckUpdateString(json,"comment","Fresh herbs mowed this morning")
CkJsonObject::ckUpdateString(json,"terms","No Returns; No Refunds")
CkJsonObject::ckUpdateString(json,"notes.notes_key_1","Beam me up Scotty.")
CkJsonObject::ckUpdateString(json,"notes.notes_key_2","Engage")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PATCH","https://api.razorpay.com/v1/invoices/{inv_id}",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndProcedure
Curl Command
curl -X PATCH
-u 'username:password'
-H "Content-Type: application/json"
-d '{
"partial_payment": true,
"customer": {
"name": "Saurav Kumar",
"contact": "9123456789",
"email": "saurav.kumar@example.com"
},
"line_items": [
{
"name": "Crate of Red Herbs",
"description": "Red Herbs from Resident Evil",
"amount": 50000,
"currency": "INR",
"quantity": 5
},
{
"item_id": "{item_id}"
}
],
"sms_notify": 1,
"email_notify": 1,
"draft": "1",
"date": 1588076279,
"expire_by": 1924991999,
"receipt": "Receipt No. 1",
"comment": "Fresh herbs mowed this morning",
"terms": "No Returns; No Refunds",
"notes": {
"notes_key_1": "Beam me up Scotty.",
"notes_key_2": "Engage"
}
}'
https://api.razorpay.com/v1/invoices/{inv_id}
Postman Collection Item JSON
{
"name": "Update an Invoice",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"partial_payment\": true,\n \"customer\": {\n \"name\": \"Saurav Kumar\",\n \"contact\": \"9123456789\",\n \"email\": \"saurav.kumar@example.com\"\n },\n \"line_items\": [\n {\n \"name\": \"Crate of Red Herbs\",\n \"description\": \"Red Herbs from Resident Evil\",\n \"amount\": 50000,\n \"currency\": \"INR\",\n \"quantity\": 5\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 herbs mowed this morning\",\n \"terms\": \"No Returns; No Refunds\",\n \"notes\": {\n \"notes_key_1\": \"Beam me up Scotty.\",\n \"notes_key_2\": \"Engage\"\n }\n}"
},
"url": {
"raw": "https://api.razorpay.com/v1/invoices/{inv_id}",
"protocol": "https",
"host": [
"api",
"razorpay",
"com"
],
"path": [
"v1",
"invoices",
"{inv_id}"
],
"query": [
{
"key": "count",
"value": "10",
"disabled": true
},
{
"key": "skip",
"value": "10",
"disabled": true
}
]
},
"description": "Update an invoice using this API.\n\nKnow more about the <a href=\"https://razorpay.com/docs/api/invoices/#update-an-invoice\" target=\"_blank\">Update an Invoice API</a>."
},
"response": [
]
}