DataFlex / Razorpay APIs / Update an Invoice
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Handle hoJson
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vResp
Handle hoResp
String sTemp1
Integer iTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComBasicAuth Of hoHttp To True
Set ComLogin Of hoHttp To "username"
Set ComPassword Of hoHttp To "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"
// }
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateBool Of hoJson "partial_payment" True To iSuccess
Get ComUpdateString Of hoJson "customer.name" "Saurav Kumar" To iSuccess
Get ComUpdateString Of hoJson "customer.contact" "9123456789" To iSuccess
Get ComUpdateString Of hoJson "customer.email" "saurav.kumar@example.com" To iSuccess
Get ComUpdateString Of hoJson "line_items[0].name" "Crate of Red Herbs" To iSuccess
Get ComUpdateString Of hoJson "line_items[0].description" "Red Herbs from Resident Evil" To iSuccess
Get ComUpdateInt Of hoJson "line_items[0].amount" 50000 To iSuccess
Get ComUpdateString Of hoJson "line_items[0].currency" "INR" To iSuccess
Get ComUpdateInt Of hoJson "line_items[0].quantity" 5 To iSuccess
Get ComUpdateString Of hoJson "line_items[1].item_id" "{item_id}" To iSuccess
Get ComUpdateInt Of hoJson "sms_notify" 1 To iSuccess
Get ComUpdateInt Of hoJson "email_notify" 1 To iSuccess
Get ComUpdateString Of hoJson "draft" "1" To iSuccess
Get ComUpdateInt Of hoJson "date" 1588076279 To iSuccess
Get ComUpdateInt Of hoJson "expire_by" 1924991999 To iSuccess
Get ComUpdateString Of hoJson "receipt" "Receipt No. 1" To iSuccess
Get ComUpdateString Of hoJson "comment" "Fresh herbs mowed this morning" To iSuccess
Get ComUpdateString Of hoJson "terms" "No Returns; No Refunds" To iSuccess
Get ComUpdateString Of hoJson "notes.notes_key_1" "Beam me up Scotty." To iSuccess
Get ComUpdateString Of hoJson "notes.notes_key_2" "Engage" To iSuccess
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComPTextSb Of hoHttp "PATCH" "https://api.razorpay.com/v1/invoices/{inv_id}" vSbRequestBody "utf-8" "application/json" False False To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
Showln iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln sTemp1
Send Destroy of hoResp
End_Procedure
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": [
]
}
