(SQL Server) PayPal - Show Invoice Details

Shows details for a PayPal invoice, by ID.

Chilkat ActiveX Downloads

ActiveX for 32-bit and 64-bit Windows

-- 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)
    -- Note: Requires Chilkat v9.5.0.64 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
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonToken OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int
    EXEC sp_OAMethod @jsonToken, 'LoadFile', @success OUT, 'qa_data/tokens/paypal.json'

    -- Build the Authorization request header field value.
    DECLARE @sbAuth int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    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
    -- Use "Chilkat_9_5_0.Rest" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Rest', @rest OUT

    DECLARE @bAutoReconnect int
    SELECT @bAutoReconnect = 1
    DECLARE @success int
    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..
    -- ----------------------------------------------------------------------------------------------

    EXEC sp_OAMethod @sbAuth, 'GetAsString', @sTmp0 OUT
    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Authorization', @sTmp0

    DECLARE @invoiceId nvarchar(4000)
    SELECT @invoiceId = 'INV2-XV4B-736P-PLVN-SZCE'

    DECLARE @sbPath int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    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 GET request and get the JSON response.
    DECLARE @sbJsonResponse int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbJsonResponse OUT

    EXEC sp_OAMethod @sbPath, 'GetAsString', @sTmp0 OUT
    EXEC sp_OAMethod @rest, 'FullRequestNoBodySb', @success OUT, 'GET', @sTmp0, @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 @sbPath
        EXEC @hr = sp_OADestroy @sbJsonResponse
        RETURN
      END

    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_OASetProperty @json, 'EmitCompact', 0
    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 @sbPath
        EXEC @hr = sp_OADestroy @sbJsonResponse
        EXEC @hr = sp_OADestroy @json
        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.'

    -- ---------------------------------------------------
    -- A sample response:

    -- 	{
    -- 	  "id": "INV2-XV4B-736P-PLVN-SZCE",
    -- 	  "number": "0002",
    -- 	  "template_id": "TEMP-8HS37702UW384535K",
    -- 	  "status": "DRAFT",
    -- 	  "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": 100.0,
    -- 	      "unit_price": {
    -- 	        "currency": "USD",
    -- 	        "value": "5.00"
    -- 	      }
    -- 	    }
    -- 	  ],
    -- 	  "invoice_date": "2016-11-15 PST",
    -- 	  "payment_term": {
    -- 	    "term_type": "NET_45",
    -- 	    "due_date": "2016-12-30 PST"
    -- 	  },
    -- 	  "tax_calculated_after_discount": false,
    -- 	  "tax_inclusive": false,
    -- 	  "note": "Medical Invoice 16 Jul, 2013 PST",
    -- 	  "total_amount": {
    -- 	    "currency": "USD",
    -- 	    "value": "500.00"
    -- 	  },
    -- 	  "metadata": {
    -- 	    "created_date": "2016-11-15 08:09:21 PST"
    -- 	  },
    -- 	  "links": [
    -- 	    {
    -- 	      "rel": "self",
    -- 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
    -- 	      "method": "GET"
    -- 	    },
    -- 	    {
    -- 	      "rel": "send",
    -- 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/send",
    -- 	      "method": "POST"
    -- 	    },
    -- 	    {
    -- 	      "rel": "update",
    -- 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/update",
    -- 	      "method": "PUT"
    -- 	    },
    -- 	    {
    -- 	      "rel": "delete",
    -- 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
    -- 	      "method": "DELETE"
    -- 	    }
    -- 	  ]
    -- 	}
    -- 

    EXEC @hr = sp_OADestroy @jsonToken
    EXEC @hr = sp_OADestroy @sbAuth
    EXEC @hr = sp_OADestroy @rest
    EXEC @hr = sp_OADestroy @sbPath
    EXEC @hr = sp_OADestroy @sbJsonResponse
    EXEC @hr = sp_OADestroy @json


END
GO