delphiAx / Razorpay APIs / Update an Invoice
Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
sbRequestBody: TChilkatStringBuilder;
resp: IChilkatHttpResponse;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := TChilkatHttp.Create(Self);
http.BasicAuth := 1;
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.
// {
// "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 := TChilkatJsonObject.Create(Self);
json.UpdateBool('partial_payment',1);
json.UpdateString('customer.name','Saurav Kumar');
json.UpdateString('customer.contact','9123456789');
json.UpdateString('customer.email','saurav.kumar@example.com');
json.UpdateString('line_items[0].name','Crate of Red Herbs');
json.UpdateString('line_items[0].description','Red Herbs from Resident Evil');
json.UpdateInt('line_items[0].amount',50000);
json.UpdateString('line_items[0].currency','INR');
json.UpdateInt('line_items[0].quantity',5);
json.UpdateString('line_items[1].item_id','{item_id}');
json.UpdateInt('sms_notify',1);
json.UpdateInt('email_notify',1);
json.UpdateString('draft','1');
json.UpdateInt('date',1588076279);
json.UpdateInt('expire_by',1924991999);
json.UpdateString('receipt','Receipt No. 1');
json.UpdateString('comment','Fresh herbs mowed this morning');
json.UpdateString('terms','No Returns; No Refunds');
json.UpdateString('notes.notes_key_1','Beam me up Scotty.');
json.UpdateString('notes.notes_key_2','Engage');
http.SetRequestHeader('Content-Type','application/json');
sbRequestBody := TChilkatStringBuilder.Create(Self);
json.EmitSb(sbRequestBody.ControlInterface);
resp := http.PTextSb('PATCH','https://api.razorpay.com/v1/invoices/{inv_id}',sbRequestBody.ControlInterface,'utf-8','application/json',0,0);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
Memo1.Lines.Add(IntToStr(resp.StatusCode));
Memo1.Lines.Add(resp.BodyStr);
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": [
]
}