(Perl) PayPal Search for Invoices

Search PayPal invoices.

See also SearchInvoices

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

# 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)
$jsonToken = chilkat::CkJsonObject->new();
$jsonToken->LoadFile("qa_data/tokens/paypal.json");

# Build the Authorization request header field value.
$sbAuth = chilkat::CkStringBuilder->new();
# token_type should be "Bearer"
$sbAuth->Append($jsonToken->stringOf("token_type"));
$sbAuth->Append(" ");
$sbAuth->Append($jsonToken->stringOf("access_token"));

# 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.
$rest = chilkat::CkRest->new();
$bAutoReconnect = 1;
$success = $rest->Connect("api.sandbox.paypal.com",443,1,$bAutoReconnect);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

# ----------------------------------------------------------------------------------------------
# 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
$json = chilkat::CkJsonObject->new();
$json->put_EmitCompact(0);
$json->AppendString("start_invoice_date","2016-01-01 PST");
$json->AppendString("end_invoice_date","2016-11-16 PST");
$json->AppendInt("page",0);
$json->AppendInt("page_size",10);
$json->AppendBool("total_count_required",1);

print $json->emit() . "\r\n";

# 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 }'

$json->put_EmitCompact(1);
$sbRequestBody = chilkat::CkStringBuilder->new();
$sbResponseBody = chilkat::CkStringBuilder->new();

$rest->AddHeader("Content-Type","application/json");
$rest->AddHeader("Authorization",$sbAuth->getAsString());
$json->EmitSb($sbRequestBody);

$success = $rest->FullRequestSb("POST","/v1/invoicing/search",$sbRequestBody,$sbResponseBody);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

# We should have some sort of JSON response.  It could be successful, or an error.
$jsonResponse = chilkat::CkJsonObject->new();
$jsonResponse->put_EmitCompact(0);
$jsonResponse->LoadSb($sbResponseBody);

print "Response Status Code = " . $rest->get_ResponseStatusCode() . "\r\n";

# Did we get a 200 success response?
if ($rest->get_ResponseStatusCode() != 200) {
    # Show the JSON response body
    print $jsonResponse->emit() . "\r\n";
    print "Failed." . "\r\n";
    exit;
}

# Sample response JSON is shown below.

# Iterate over each invoice and get some information from each..
$numInvoices = $jsonResponse->SizeOfArray("invoices");
$i = 0;
while ($i < $numInvoices) {
    $jsonResponse->put_I($i);
    print "Invoice ID: " . $jsonResponse->stringOf("invoices[i].id") . "\r\n";
    print "Shipping First Name: " . $jsonResponse->stringOf("invoices[i].shipping_info.first_name") . "\r\n";
    $j = 0;
    $numBillingInfo = $jsonResponse->SizeOfArray("invoices[i].billing_info");
    while ($j < $numBillingInfo) {
        $jsonResponse->put_J($j);
        print "billing_info email: " . $jsonResponse->stringOf("invoices[i].billing_info[j].email") . "\r\n";
        $j = $j + 1;
    }

    $numLinks = $jsonResponse->SizeOfArray("invoices[i].links");
    $j = 0;
    while ($j < $numLinks) {
        $jsonResponse->put_J($j);
        print "link: " . $jsonResponse->stringOf("invoices[i].links[j].href") . "\r\n";
        $j = $j + 1;
    }

    print "----" . "\r\n";
    $i = $i + 1;
}

print "Success." . "\r\n";

# 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"
#         }
#       ]
#     }
#   ]
# }
#