SQL Server
SQL Server
PayPal - Update Invoice
See more PayPal Examples
Update a PayPal invoice.Note: This example requires Chilkat v9.5.0.65 or greater.
See also PayPal Update Invoice REST API Reference
Chilkat SQL Server Downloads
-- 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)
DECLARE @success int
SELECT @success = 0
-- Note: Requires Chilkat v9.5.0.65 or greater.
-- This requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
-- Load our previously obtained access token. (see PayPal OAuth2 Access Token)
DECLARE @jsonToken int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonToken OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
EXEC sp_OAMethod @jsonToken, 'LoadFile', @success OUT, 'qa_data/tokens/paypal.json'
-- Build the Authorization request header field value.
DECLARE @sbAuth int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbAuth OUT
-- token_type should be "Bearer"
EXEC sp_OAMethod @jsonToken, 'StringOf', @sTmp0 OUT, 'token_type'
EXEC sp_OAMethod @sbAuth, 'Append', @success OUT, @sTmp0
EXEC sp_OAMethod @sbAuth, 'Append', @success OUT, ' '
EXEC sp_OAMethod @jsonToken, 'StringOf', @sTmp0 OUT, 'access_token'
EXEC sp_OAMethod @sbAuth, 'Append', @success OUT, @sTmp0
-- Make the initial connection.
-- A single REST object, once connected, can be used for many PayPal REST API calls.
-- The auto-reconnect indicates that if the already-established HTTPS connection is closed,
-- then it will be automatically re-established as needed.
DECLARE @rest int
EXEC @hr = sp_OACreate 'Chilkat.Rest', @rest OUT
DECLARE @bAutoReconnect int
SELECT @bAutoReconnect = 1
EXEC sp_OAMethod @rest, 'Connect', @success OUT, 'api.sandbox.paypal.com', 443, 1, @bAutoReconnect
IF @success <> 1
BEGIN
EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @jsonToken
EXEC @hr = sp_OADestroy @sbAuth
EXEC @hr = sp_OADestroy @rest
RETURN
END
-- ----------------------------------------------------------------------------------------------
-- The code above this comment could be placed inside a function/subroutine within the application
-- because the connection does not need to be made for every request. Once the connection is made
-- the app may send many requests..
-- ----------------------------------------------------------------------------------------------
-- First create the JSON with updated information:
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OASetProperty @json, 'EmitCompact', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'merchant_info.email', 'smith-facilitator@chilkatsoft.com'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'merchant_info.first_name', 'Joe'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'merchant_info.last_name', 'Facilitator'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'merchant_info.business_name', 'Medical Professionals, LLC'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'merchant_info.phone.country_code', '001'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'merchant_info.phone.national_number', '5032141716'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'merchant_info.address.line1', '1234 Main St.'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'merchant_info.address.city', 'Portland'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'merchant_info.address.state', 'OR'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'merchant_info.address.postal_code', '97217'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'merchant_info.address.country_code', 'US'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'billing_info[0].email', 'smith-buyer@chilkatsoft.com'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'shipping_info.first_name', 'Sally'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'shipping_info.last_name', 'Patient'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'shipping_info.business_name', 'Not applicable'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'shipping_info.phone.country_code', '001'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'shipping_info.phone.national_number', '5039871234'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'shipping_info.address.line1', '1234 Broad St.'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'shipping_info.address.city', 'Portland'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'shipping_info.address.state', 'OR'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'shipping_info.address.postal_code', '97216'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'shipping_info.address.country_code', 'US'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'items[0].name', 'Sutures'
-- We are updating the quantity from 100.0 to 200.0
-- Note: The UpdateNumber method is added in v9.5.0.65
EXEC sp_OAMethod @json, 'UpdateNumber', @success OUT, 'items[0].quantity', '200.0'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'items[0].unit_price.currency', 'USD'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'items[0].unit_price.value', '5.00'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payment_term.term_type', 'NET_45'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payment_term.due_date', '2016-12-30 PST'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'note', 'Medical Invoice 16 Jul, 2013 PST'
-- The JSON created by the above code is this:
-- {
-- "merchant_info": {
-- "email": "smith-facilitator@chilkatsoft.com",
-- "first_name": "Joe",
-- "last_name": "Facilitator",
-- "business_name": "Medical Professionals, LLC",
-- "phone": {
-- "country_code": "001",
-- "national_number": "5032141716"
-- },
-- "address": {
-- "line1": "1234 Main St.",
-- "city": "Portland",
-- "state": "OR",
-- "postal_code": "97217",
-- "country_code": "US"
-- }
-- },
-- "billing_info": [
-- {
-- "email": "smith-buyer@chilkatsoft.com"
-- }
-- ],
-- "shipping_info": {
-- "first_name": "Sally",
-- "last_name": "Patient",
-- "business_name": "Not applicable",
-- "phone": {
-- "country_code": "001",
-- "national_number": "5039871234"
-- },
-- "address": {
-- "line1": "1234 Broad St.",
-- "city": "Portland",
-- "state": "OR",
-- "postal_code": "97216",
-- "country_code": "US"
-- }
-- },
-- "items": [
-- {
-- "name": "Sutures",
-- "quantity": 200.0,
-- "unit_price": {
-- "currency": "USD",
-- "value": "5.00"
-- }
-- }
-- ],
-- "payment_term": {
-- "term_type": "NET_45",
-- "due_date": "2016-12-30 PST"
-- },
-- "note": "Medical Invoice 16 Jul, 2013 PST"
-- }
EXEC sp_OAMethod @sbAuth, 'GetAsString', @sTmp0 OUT
EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Authorization', @sTmp0
EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Content-Type', 'application/json'
DECLARE @invoiceId nvarchar(4000)
SELECT @invoiceId = 'INV2-XV4B-736P-PLVN-SZCE'
DECLARE @sbPath int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbPath OUT
EXEC sp_OAMethod @sbPath, 'Append', @success OUT, '/v1/invoicing/invoices/'
EXEC sp_OAMethod @sbPath, 'Append', @success OUT, @invoiceId
-- Send the PUT request containign the JSON in the request body, and get the JSON response.
DECLARE @sbJsonRequest int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbJsonRequest OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbJsonRequest
DECLARE @sbJsonResponse int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbJsonResponse OUT
EXEC sp_OAMethod @sbPath, 'GetAsString', @sTmp0 OUT
EXEC sp_OAMethod @rest, 'FullRequestSb', @success OUT, 'PUT', @sTmp0, @sbJsonRequest, @sbJsonResponse
IF @success <> 1
BEGIN
EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @jsonToken
EXEC @hr = sp_OADestroy @sbAuth
EXEC @hr = sp_OADestroy @rest
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbPath
EXEC @hr = sp_OADestroy @sbJsonRequest
EXEC @hr = sp_OADestroy @sbJsonResponse
RETURN
END
EXEC sp_OAMethod @json, 'LoadSb', @success OUT, @sbJsonResponse
EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
PRINT 'Response Status Code = ' + @iTmp0
-- Did we get a 200 success response?
EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
IF @iTmp0 <> 200
BEGIN
EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @jsonToken
EXEC @hr = sp_OADestroy @sbAuth
EXEC @hr = sp_OADestroy @rest
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbPath
EXEC @hr = sp_OADestroy @sbJsonRequest
EXEC @hr = sp_OADestroy @sbJsonResponse
RETURN
END
-- Sample response JSON is shown below.
-- Get some information..
EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'merchant_info.email'
PRINT 'email: ' + @sTmp0
EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'merchant_info.business_name'
PRINT 'business_name: ' + @sTmp0
DECLARE @numItems int
EXEC sp_OAMethod @json, 'SizeOfArray', @numItems OUT, 'items'
DECLARE @i int
SELECT @i = 0
WHILE @i < @numItems
BEGIN
EXEC sp_OASetProperty @json, 'I', @i
EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'items[i].name'
PRINT 'item name: ' + @sTmp0
EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'items[i].quantity'
PRINT 'item quantity: ' + @sTmp0
EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'items[i].unit_price.currency'
PRINT 'item currency: ' + @sTmp0
EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'items[i].unit_price.value'
PRINT 'item value: ' + @sTmp0
PRINT '----'
SELECT @i = @i + 1
END
PRINT 'Success.'
EXEC @hr = sp_OADestroy @jsonToken
EXEC @hr = sp_OADestroy @sbAuth
EXEC @hr = sp_OADestroy @rest
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbPath
EXEC @hr = sp_OADestroy @sbJsonRequest
EXEC @hr = sp_OADestroy @sbJsonResponse
END
GO