Chilkat Online Tools

SQL Server / Razorpay APIs / Update an Invoice

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    EXEC sp_OASetProperty @http, 'BasicAuth', 1
    EXEC sp_OASetProperty @http, 'Login', 'username'
    EXEC sp_OASetProperty @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"
    --   }
    -- }

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'partial_payment', 1
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'customer.name', 'Saurav Kumar'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'customer.contact', '9123456789'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'customer.email', 'saurav.kumar@example.com'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'line_items[0].name', 'Crate of Red Herbs'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'line_items[0].description', 'Red Herbs from Resident Evil'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'line_items[0].amount', 50000
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'line_items[0].currency', 'INR'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'line_items[0].quantity', 5
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'line_items[1].item_id', '{item_id}'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'sms_notify', 1
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'email_notify', 1
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'draft', '1'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'date', 1588076279
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'expire_by', 1924991999
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'receipt', 'Receipt No. 1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'comment', 'Fresh herbs mowed this morning'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'terms', 'No Returns; No Refunds'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'notes.notes_key_1', 'Beam me up Scotty.'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'notes.notes_key_2', 'Engage'

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'

    DECLARE @sbRequestBody int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT

    EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PATCH', 'https://api.razorpay.com/v1/invoices/{inv_id}', @sbRequestBody, 'utf-8', 'application/json', 0, 0
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbRequestBody
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @sbRequestBody


END
GO

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