Xojo Plugin
Xojo Plugin
PayPal Create Invoice
See more PayPal Examples
Creates a draft invoice.Chilkat Xojo Plugin Downloads
Dim success As Boolean
success = False
// 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)
Dim jsonToken As New Chilkat.JsonObject
success = jsonToken.LoadFile("qa_data/tokens/paypal.json")
// Build the Authorization request header field value.
Dim sbAuth As New Chilkat.StringBuilder
// token_type should be "Bearer"
success = sbAuth.Append(jsonToken.StringOf("token_type"))
success = sbAuth.Append(" ")
success = 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.
Dim rest As New Chilkat.Rest
Dim bAutoReconnect As Boolean
bAutoReconnect = True
success = rest.Connect("api.sandbox.paypal.com",443,True,bAutoReconnect)
If (success <> True) Then
System.DebugLog(rest.LastErrorText)
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:
Dim json As New Chilkat.JsonObject
json.EmitCompact = False
success = json.UpdateString("merchant_info.email","frank-facilitator@example.com")
success = json.UpdateString("merchant_info.first_name","Frank")
success = json.UpdateString("merchant_info.last_name","Facilitator")
success = json.UpdateString("merchant_info.business_name","Medical Professionals, LLC")
success = json.UpdateString("merchant_info.phone.country_code","001")
success = json.UpdateString("merchant_info.phone.national_number","5032141716")
success = json.UpdateString("merchant_info.address.line1","1234 Main St.")
success = json.UpdateString("merchant_info.address.city","Portland")
success = json.UpdateString("merchant_info.address.state","OR")
success = json.UpdateString("merchant_info.address.postal_code","97217")
success = json.UpdateString("merchant_info.address.country_code","US")
success = json.UpdateString("billing_info[0].email","frank-buyer@somewhere.com")
success = json.UpdateString("items[0].name","Sutures")
success = json.UpdateInt("items[0].quantity",100)
success = json.UpdateString("items[0].unit_price.currency","USD")
success = json.UpdateString("items[0].unit_price.value","5")
success = json.UpdateString("note","Medical Invoice 16 Jul, 2013 PST")
success = json.UpdateString("payment_term.term_type","NET_45")
success = json.UpdateString("shipping_info.first_name","Sally")
success = json.UpdateString("shipping_info.last_name","Patient")
success = json.UpdateString("shipping_info.business_name","Not applicable")
success = json.UpdateString("shipping_info.phone.country_code","001")
success = json.UpdateString("shipping_info.phone.national_number","5039871234")
success = json.UpdateString("shipping_info.address.line1","1234 Broad St.")
success = json.UpdateString("shipping_info.address.city","Portland")
success = json.UpdateString("shipping_info.address.state","OR")
success = json.UpdateString("shipping_info.address.postal_code","97216")
success = json.UpdateString("shipping_info.address.country_code","US")
System.DebugLog(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 }'
json.EmitCompact = True
Dim sbRequestBody As New Chilkat.StringBuilder
Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.AddHeader("Content-Type","application/json")
success = rest.AddHeader("Authorization",sbAuth.GetAsString())
success = json.EmitSb(sbRequestBody)
success = rest.FullRequestSb("POST","/v1/invoicing/invoices",sbRequestBody,sbResponseBody)
If (success <> True) Then
System.DebugLog(rest.LastErrorText)
Return
End If
// We should have some sort of JSON response. It could be successful, or an error.
Dim jsonResponse As New Chilkat.JsonObject
jsonResponse.EmitCompact = False
success = jsonResponse.LoadSb(sbResponseBody)
System.DebugLog("Response Status Code = " + Str(rest.ResponseStatusCode))
// Did we get a 201 success response?
If (rest.ResponseStatusCode <> 201) Then
// Show the JSON response body
System.DebugLog(jsonResponse.Emit())
System.DebugLog(rest.LastRequestStartLine)
System.DebugLog(rest.LastRequestHeader)
System.DebugLog("Failed.")
Return
End If
// Show a few parts of the JSON response
System.DebugLog("id: " + jsonResponse.StringOf("id"))
System.DebugLog("number: " + jsonResponse.StringOf("number"))
System.DebugLog("template_id: " + jsonResponse.StringOf("template_id"))
System.DebugLog("status: " + jsonResponse.StringOf("status"))
// Show the full JSON response.
System.DebugLog(jsonResponse.Emit())
System.DebugLog("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"
// }
// ]
// }
//