SQL Server
SQL Server
PayPal Search for Invoices
See more PayPal Examples
Search PayPal invoices.See also SearchInvoices
Chilkat SQL Server Downloads
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
DECLARE @sTmp0 nvarchar(4000)
DECLARE @success int
SELECT @success = 0
-- 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
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..
-- ----------------------------------------------------------------------------------------------
-- Create JSON to specify the search
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OASetProperty @json, 'EmitCompact', 0
EXEC sp_OAMethod @json, 'AppendString', @success OUT, 'start_invoice_date', '2016-01-01 PST'
EXEC sp_OAMethod @json, 'AppendString', @success OUT, 'end_invoice_date', '2016-11-16 PST'
EXEC sp_OAMethod @json, 'AppendInt', @success OUT, 'page', 0
EXEC sp_OAMethod @json, 'AppendInt', @success OUT, 'page_size', 10
EXEC sp_OAMethod @json, 'AppendBool', @success OUT, 'total_count_required', 1
EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
PRINT @sTmp0
-- The JSON by the above code:
-- {
-- "start_invoice_date": "2016-01-01 PST",
-- "end_invoice_date": "2016-11-16 PST",
-- "page": 0,
-- "page_size": 10,
-- "total_count_required": true
-- }
-- Send the POST equivalent to this CURL command:
-- curl -v -X POST https://api.sandbox.paypal.com/v1/invoicing/search/ \
-- -H "Content-Type:application/json" \
-- -H "Authorization: Bearer Access-Token" \
-- -d '{ invoice JSON goes here }'
EXEC sp_OASetProperty @json, 'EmitCompact', 1
DECLARE @sbRequestBody int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Content-Type', 'application/json'
EXEC sp_OAMethod @sbAuth, 'GetAsString', @sTmp0 OUT
EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Authorization', @sTmp0
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
EXEC sp_OAMethod @rest, 'FullRequestSb', @success OUT, 'POST', '/v1/invoicing/search', @sbRequestBody, @sbResponseBody
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 @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
-- We should have some sort of JSON response. It could be successful, or an error.
DECLARE @jsonResponse int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonResponse OUT
EXEC sp_OASetProperty @jsonResponse, 'EmitCompact', 0
EXEC sp_OAMethod @jsonResponse, 'LoadSb', @success OUT, @sbResponseBody
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
-- Show the JSON response body
EXEC sp_OAMethod @jsonResponse, '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 @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jsonResponse
RETURN
END
-- Sample response JSON is shown below.
-- Iterate over each invoice and get some information from each..
DECLARE @numInvoices int
EXEC sp_OAMethod @jsonResponse, 'SizeOfArray', @numInvoices OUT, 'invoices'
DECLARE @i int
SELECT @i = 0
WHILE @i < @numInvoices
BEGIN
EXEC sp_OASetProperty @jsonResponse, 'I', @i
EXEC sp_OAMethod @jsonResponse, 'StringOf', @sTmp0 OUT, 'invoices[i].id'
PRINT 'Invoice ID: ' + @sTmp0
EXEC sp_OAMethod @jsonResponse, 'StringOf', @sTmp0 OUT, 'invoices[i].shipping_info.first_name'
PRINT 'Shipping First Name: ' + @sTmp0
DECLARE @j int
SELECT @j = 0
DECLARE @numBillingInfo int
EXEC sp_OAMethod @jsonResponse, 'SizeOfArray', @numBillingInfo OUT, 'invoices[i].billing_info'
WHILE @j < @numBillingInfo
BEGIN
EXEC sp_OASetProperty @jsonResponse, 'J', @j
EXEC sp_OAMethod @jsonResponse, 'StringOf', @sTmp0 OUT, 'invoices[i].billing_info[j].email'
PRINT 'billing_info email: ' + @sTmp0
SELECT @j = @j + 1
END
DECLARE @numLinks int
EXEC sp_OAMethod @jsonResponse, 'SizeOfArray', @numLinks OUT, 'invoices[i].links'
SELECT @j = 0
WHILE @j < @numLinks
BEGIN
EXEC sp_OASetProperty @jsonResponse, 'J', @j
EXEC sp_OAMethod @jsonResponse, 'StringOf', @sTmp0 OUT, 'invoices[i].links[j].href'
PRINT 'link: ' + @sTmp0
SELECT @j = @j + 1
END
PRINT '----'
SELECT @i = @i + 1
END
PRINT 'Success.'
-- A successful response looks like this:
-- {
-- "total_count": 2,
-- "invoices": [
-- {
-- "id": "INV2-XV4B-736P-PLVN-SZCE",
-- "number": "0002",
-- "status": "DRAFT",
-- "merchant_info": {
-- "email": "smith-facilitator@chilkatsoft.com"
-- },
-- "billing_info": [
-- {
-- "email": "smith-buyer@chilkatsoft.com"
-- }
-- ],
-- "shipping_info": {
-- "email": "smith-buyer@chilkatsoft.com",
-- "first_name": "Sally",
-- "last_name": "Patient",
-- "business_name": "Not applicable"
-- },
-- "invoice_date": "2016-11-15 PST",
-- "payment_term": {
-- "due_date": "2016-12-30 PST"
-- },
-- "note": "Medical Invoice 16 Jul, 2013 PST",
-- "total_amount": {
-- "currency": "USD",
-- "value": "500.00"
-- },
-- "metadata": {
-- "created_date": "2016-11-15 08:09:21 PST"
-- },
-- "paid_amount": {
-- "paypal": {
-- "currency": "USD",
-- "value": "0.00"
-- },
-- "other": {
-- "currency": "USD",
-- "value": "0.00"
-- }
-- },
-- "refunded_amount": {
-- "paypal": {
-- "currency": "USD",
-- "value": "0.00"
-- },
-- "other": {
-- "currency": "USD",
-- "value": "0.00"
-- }
-- },
-- "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"
-- }
-- ]
-- },
-- {
-- "id": "INV2-ZG2H-HKAW-PMWU-N6ZR",
-- "number": "0001",
-- "status": "SENT",
-- "merchant_info": {
-- "email": "smith-facilitator@chilkatsoft.com"
-- },
-- "billing_info": [
-- {
-- "email": "smith-buyer@chilkatsoft.com"
-- }
-- ],
-- "shipping_info": {
-- "email": "smith-buyer@chilkatsoft.com",
-- "first_name": "Sally",
-- "last_name": "Patient",
-- "business_name": "Not applicable"
-- },
-- "invoice_date": "2016-11-15 PST",
-- "payment_term": {
-- "due_date": "2016-12-30 PST"
-- },
-- "note": "Medical Invoice 16 Jul, 2013 PST",
-- "total_amount": {
-- "currency": "USD",
-- "value": "500.00"
-- },
-- "metadata": {
-- "created_date": "2016-11-15 06:17:03 PST",
-- "payer_view_url": "https://www.sandbox.paypal.com/cgi_bin/webscr?cmd=_pay-inv&viewtype=altview&id=INV2-ZG2H-HKAW-PMWU-N6ZR"
-- },
-- "paid_amount": {
-- "paypal": {
-- "currency": "USD",
-- "value": "0.00"
-- },
-- "other": {
-- "currency": "USD",
-- "value": "0.00"
-- }
-- },
-- "refunded_amount": {
-- "paypal": {
-- "currency": "USD",
-- "value": "0.00"
-- },
-- "other": {
-- "currency": "USD",
-- "value": "0.00"
-- }
-- },
-- "links": [
-- {
-- "rel": "self",
-- "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR",
-- "method": "GET"
-- },
-- {
-- "rel": "update",
-- "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/update",
-- "method": "PUT"
-- },
-- {
-- "rel": "cancel",
-- "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/remind",
-- "method": "POST"
-- },
-- {
-- "rel": "remind",
-- "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/cancel",
-- "method": "POST"
-- },
-- {
-- "rel": "record-payment",
-- "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/record-payment",
-- "method": "POST"
-- },
-- {
-- "rel": "qr-code",
-- "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/qr-code",
-- "method": "GET"
-- }
-- ]
-- }
-- ]
-- }
--
EXEC @hr = sp_OADestroy @jsonToken
EXEC @hr = sp_OADestroy @sbAuth
EXEC @hr = sp_OADestroy @rest
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jsonResponse
END
GO