PowerBuilder
PowerBuilder
PayPal Create Invoice
See more PayPal Examples
Creates a draft invoice.Chilkat PowerBuilder Downloads
integer li_rc
integer li_Success
oleobject loo_JsonToken
oleobject loo_SbAuth
oleobject loo_Rest
integer li_BAutoReconnect
oleobject loo_Json
oleobject loo_SbRequestBody
oleobject loo_SbResponseBody
oleobject loo_JsonResponse
li_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)
loo_JsonToken = create oleobject
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")
if li_rc < 0 then
destroy loo_JsonToken
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_JsonToken.LoadFile("qa_data/tokens/paypal.json")
// Build the Authorization request header field value.
loo_SbAuth = create oleobject
li_rc = loo_SbAuth.ConnectToNewObject("Chilkat.StringBuilder")
// token_type should be "Bearer"
loo_SbAuth.Append(loo_JsonToken.StringOf("token_type"))
loo_SbAuth.Append(" ")
loo_SbAuth.Append(loo_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.
loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("api.sandbox.paypal.com",443,1,li_BAutoReconnect)
if li_Success <> 1 then
Write-Debug loo_Rest.LastErrorText
destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
return
end if
// ----------------------------------------------------------------------------------------------
// 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 a JSON invoice:
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.EmitCompact = 0
loo_Json.UpdateString("merchant_info.email","frank-facilitator@example.com")
loo_Json.UpdateString("merchant_info.first_name","Frank")
loo_Json.UpdateString("merchant_info.last_name","Facilitator")
loo_Json.UpdateString("merchant_info.business_name","Medical Professionals, LLC")
loo_Json.UpdateString("merchant_info.phone.country_code","001")
loo_Json.UpdateString("merchant_info.phone.national_number","5032141716")
loo_Json.UpdateString("merchant_info.address.line1","1234 Main St.")
loo_Json.UpdateString("merchant_info.address.city","Portland")
loo_Json.UpdateString("merchant_info.address.state","OR")
loo_Json.UpdateString("merchant_info.address.postal_code","97217")
loo_Json.UpdateString("merchant_info.address.country_code","US")
loo_Json.UpdateString("billing_info[0].email","frank-buyer@somewhere.com")
loo_Json.UpdateString("items[0].name","Sutures")
loo_Json.UpdateInt("items[0].quantity",100)
loo_Json.UpdateString("items[0].unit_price.currency","USD")
loo_Json.UpdateString("items[0].unit_price.value","5")
loo_Json.UpdateString("note","Medical Invoice 16 Jul, 2013 PST")
loo_Json.UpdateString("payment_term.term_type","NET_45")
loo_Json.UpdateString("shipping_info.first_name","Sally")
loo_Json.UpdateString("shipping_info.last_name","Patient")
loo_Json.UpdateString("shipping_info.business_name","Not applicable")
loo_Json.UpdateString("shipping_info.phone.country_code","001")
loo_Json.UpdateString("shipping_info.phone.national_number","5039871234")
loo_Json.UpdateString("shipping_info.address.line1","1234 Broad St.")
loo_Json.UpdateString("shipping_info.address.city","Portland")
loo_Json.UpdateString("shipping_info.address.state","OR")
loo_Json.UpdateString("shipping_info.address.postal_code","97216")
loo_Json.UpdateString("shipping_info.address.country_code","US")
Write-Debug loo_Json.Emit()
// The JSON invoice created by the above code:
// {
// "merchant_info": {
// "email": "frank-facilitator@example.com",
// "first_name": "Frank",
// "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": "frank-buyer@somewhere.com"
// }
// ],
// "items": [
// {
// "name": "Sutures",
// "quantity": 100,
// "unit_price": {
// "currency": "USD",
// "value": "5"
// }
// }
// ],
// "note": "Medical Invoice 16 Jul, 2013 PST",
// "payment_term": {
// "term_type": "NET_45"
// },
// "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"
// }
// }
// }
// Send the POST equivalent to this CURL command:
// curl -v -X POST https://api.sandbox.paypal.com/v1/invoicing/invoices/ \
// -H "Content-Type:application/json" \
// -H "Authorization: Bearer Access-Token" \
// -d '{ invoice JSON goes here }'
loo_Json.EmitCompact = 1
loo_SbRequestBody = create oleobject
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Rest.AddHeader("Content-Type","application/json")
loo_Rest.AddHeader("Authorization",loo_SbAuth.GetAsString())
loo_Json.EmitSb(loo_SbRequestBody)
li_Success = loo_Rest.FullRequestSb("POST","/v1/invoicing/invoices",loo_SbRequestBody,loo_SbResponseBody)
if li_Success <> 1 then
Write-Debug loo_Rest.LastErrorText
destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
return
end if
// We should have some sort of JSON response. It could be successful, or an error.
loo_JsonResponse = create oleobject
li_rc = loo_JsonResponse.ConnectToNewObject("Chilkat.JsonObject")
loo_JsonResponse.EmitCompact = 0
loo_JsonResponse.LoadSb(loo_SbResponseBody)
Write-Debug "Response Status Code = " + string(loo_Rest.ResponseStatusCode)
// Did we get a 201 success response?
if loo_Rest.ResponseStatusCode <> 201 then
// Show the JSON response body
Write-Debug loo_JsonResponse.Emit()
Write-Debug loo_Rest.LastRequestStartLine
Write-Debug loo_Rest.LastRequestHeader
Write-Debug "Failed."
destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_JsonResponse
return
end if
// Show a few parts of the JSON response
Write-Debug "id: " + loo_JsonResponse.StringOf("id")
Write-Debug "number: " + loo_JsonResponse.StringOf("number")
Write-Debug "template_id: " + loo_JsonResponse.StringOf("template_id")
Write-Debug "status: " + loo_JsonResponse.StringOf("status")
// Show the full JSON response.
Write-Debug loo_JsonResponse.Emit()
Write-Debug "Success."
// A successful response looks like this:
// {
// "id": "INV2-ZG2H-HKAW-PMWU-N6ZR",
// "number": "0001",
// "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 06:17:03 PST"
// },
// "links": [
// {
// "rel": "self",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR",
// "method": "GET"
// },
// {
// "rel": "send",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/send",
// "method": "POST"
// },
// {
// "rel": "update",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/update",
// "method": "PUT"
// },
// {
// "rel": "delete",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR",
// "method": "DELETE"
// }
// ]
// }
//
destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_JsonResponse