(Lianja) PayPal Create Invoice

See more PayPal Examples

Creates a draft invoice.

For more information, see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_create

Chilkat Lianja Extension Download Chilkat Lianja Extension

// 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)
loJsonToken = createobject("CkJsonObject")
loJsonToken.LoadFile("qa_data/tokens/paypal.json")

// Build the Authorization request header field value.
loSbAuth = createobject("CkStringBuilder")
// token_type should be "Bearer"
loSbAuth.Append(loJsonToken.StringOf("token_type"))
loSbAuth.Append(" ")
loSbAuth.Append(loJsonToken.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.
loRest = createobject("CkRest")
llBAutoReconnect = .T.
llSuccess = loRest.Connect("api.sandbox.paypal.com",443,.T.,llBAutoReconnect)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loSbAuth
    release loRest
    return
endif

// ----------------------------------------------------------------------------------------------
// 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:
loJson = createobject("CkJsonObject")
loJson.EmitCompact = .F.
loJson.UpdateString("merchant_info.email","frank-facilitator@example.com")
loJson.UpdateString("merchant_info.first_name","Frank")
loJson.UpdateString("merchant_info.last_name","Facilitator")
loJson.UpdateString("merchant_info.business_name","Medical Professionals, LLC")
loJson.UpdateString("merchant_info.phone.country_code","001")
loJson.UpdateString("merchant_info.phone.national_number","5032141716")
loJson.UpdateString("merchant_info.address.line1","1234 Main St.")
loJson.UpdateString("merchant_info.address.city","Portland")
loJson.UpdateString("merchant_info.address.state","OR")
loJson.UpdateString("merchant_info.address.postal_code","97217")
loJson.UpdateString("merchant_info.address.country_code","US")
loJson.UpdateString("billing_info[0].email","frank-buyer@somewhere.com")
loJson.UpdateString("items[0].name","Sutures")
loJson.UpdateInt("items[0].quantity",100)
loJson.UpdateString("items[0].unit_price.currency","USD")
loJson.UpdateString("items[0].unit_price.value","5")
loJson.UpdateString("note","Medical Invoice 16 Jul, 2013 PST")
loJson.UpdateString("payment_term.term_type","NET_45")
loJson.UpdateString("shipping_info.first_name","Sally")
loJson.UpdateString("shipping_info.last_name","Patient")
loJson.UpdateString("shipping_info.business_name","Not applicable")
loJson.UpdateString("shipping_info.phone.country_code","001")
loJson.UpdateString("shipping_info.phone.national_number","5039871234")
loJson.UpdateString("shipping_info.address.line1","1234 Broad St.")
loJson.UpdateString("shipping_info.address.city","Portland")
loJson.UpdateString("shipping_info.address.state","OR")
loJson.UpdateString("shipping_info.address.postal_code","97216")
loJson.UpdateString("shipping_info.address.country_code","US")

? loJson.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 }'

loJson.EmitCompact = .T.
loSbRequestBody = createobject("CkStringBuilder")
loSbResponseBody = createobject("CkStringBuilder")

loRest.AddHeader("Content-Type","application/json")
loRest.AddHeader("Authorization",loSbAuth.GetAsString())
loJson.EmitSb(loSbRequestBody)

llSuccess = loRest.FullRequestSb("POST","/v1/invoicing/invoices",loSbRequestBody,loSbResponseBody)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loSbAuth
    release loRest
    release loJson
    release loSbRequestBody
    release loSbResponseBody
    return
endif

// We should have some sort of JSON response.  It could be successful, or an error.
loJsonResponse = createobject("CkJsonObject")
loJsonResponse.EmitCompact = .F.
loJsonResponse.LoadSb(loSbResponseBody)

? "Response Status Code = " + str(loRest.ResponseStatusCode)

// Did we get a 201 success response?
if (loRest.ResponseStatusCode <> 201) then
    // Show the JSON response body
    ? loJsonResponse.Emit()

    ? loRest.LastRequestStartLine
    ? loRest.LastRequestHeader
    ? "Failed."
    release loJsonToken
    release loSbAuth
    release loRest
    release loJson
    release loSbRequestBody
    release loSbResponseBody
    release loJsonResponse
    return
endif

// Show a few parts of the JSON response
? "id: " + loJsonResponse.StringOf("id")
? "number: " + loJsonResponse.StringOf("number")
? "template_id: " + loJsonResponse.StringOf("template_id")
? "status: " + loJsonResponse.StringOf("status")

// Show the full JSON response.
? loJsonResponse.Emit()
? "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"
// 	    }
// 	  ]
// 	}
// 


release loJsonToken
release loSbAuth
release loRest
release loJson
release loSbRequestBody
release loSbResponseBody
release loJsonResponse