Chilkat Online Tools

delphiDll / Razorpay APIs / Update an Invoice

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'username');
CkHttp_putPassword(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 := CkJsonObject_Create();
CkJsonObject_UpdateBool(json,'partial_payment',True);
CkJsonObject_UpdateString(json,'customer.name','Saurav Kumar');
CkJsonObject_UpdateString(json,'customer.contact','9123456789');
CkJsonObject_UpdateString(json,'customer.email','saurav.kumar@example.com');
CkJsonObject_UpdateString(json,'line_items[0].name','Crate of Red Herbs');
CkJsonObject_UpdateString(json,'line_items[0].description','Red Herbs from Resident Evil');
CkJsonObject_UpdateInt(json,'line_items[0].amount',50000);
CkJsonObject_UpdateString(json,'line_items[0].currency','INR');
CkJsonObject_UpdateInt(json,'line_items[0].quantity',5);
CkJsonObject_UpdateString(json,'line_items[1].item_id','{item_id}');
CkJsonObject_UpdateInt(json,'sms_notify',1);
CkJsonObject_UpdateInt(json,'email_notify',1);
CkJsonObject_UpdateString(json,'draft','1');
CkJsonObject_UpdateInt(json,'date',1588076279);
CkJsonObject_UpdateInt(json,'expire_by',1924991999);
CkJsonObject_UpdateString(json,'receipt','Receipt No. 1');
CkJsonObject_UpdateString(json,'comment','Fresh herbs mowed this morning');
CkJsonObject_UpdateString(json,'terms','No Returns; No Refunds');
CkJsonObject_UpdateString(json,'notes.notes_key_1','Beam me up Scotty.');
CkJsonObject_UpdateString(json,'notes.notes_key_2','Engage');

CkHttp_SetRequestHeader(http,'Content-Type','application/json');

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);

resp := CkHttp_PTextSb(http,'PATCH','https://api.razorpay.com/v1/invoices/{inv_id}',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);

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