DataFlex
DataFlex
PayPal Create Invoice
See more PayPal Examples
Creates a draft invoice.Chilkat DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Handle hoJsonToken
Handle hoSbAuth
Handle hoRest
Boolean iBAutoReconnect
Handle hoJson
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJsonResponse
String sTemp1
Integer iTemp1
Move False To iSuccess
// 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)
Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
If (Not(IsComObjectCreated(hoJsonToken))) Begin
Send CreateComObject of hoJsonToken
End
Get ComLoadFile Of hoJsonToken "qa_data/tokens/paypal.json" To iSuccess
// Build the Authorization request header field value.
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbAuth
If (Not(IsComObjectCreated(hoSbAuth))) Begin
Send CreateComObject of hoSbAuth
End
// token_type should be "Bearer"
Get ComStringOf Of hoJsonToken "token_type" To sTemp1
Get ComAppend Of hoSbAuth sTemp1 To iSuccess
Get ComAppend Of hoSbAuth " " To iSuccess
Get ComStringOf Of hoJsonToken "access_token" To sTemp1
Get ComAppend Of hoSbAuth sTemp1 To iSuccess
// 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.
Get Create (RefClass(cComChilkatRest)) To hoRest
If (Not(IsComObjectCreated(hoRest))) Begin
Send CreateComObject of hoRest
End
Move True To iBAutoReconnect
Get ComConnect Of hoRest "api.sandbox.paypal.com" 443 True iBAutoReconnect To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoRest To sTemp1
Showln sTemp1
Procedure_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..
// ----------------------------------------------------------------------------------------------
// First create a JSON invoice:
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Set ComEmitCompact Of hoJson To False
Get ComUpdateString Of hoJson "merchant_info.email" "frank-facilitator@example.com" To iSuccess
Get ComUpdateString Of hoJson "merchant_info.first_name" "Frank" To iSuccess
Get ComUpdateString Of hoJson "merchant_info.last_name" "Facilitator" To iSuccess
Get ComUpdateString Of hoJson "merchant_info.business_name" "Medical Professionals, LLC" To iSuccess
Get ComUpdateString Of hoJson "merchant_info.phone.country_code" "001" To iSuccess
Get ComUpdateString Of hoJson "merchant_info.phone.national_number" "5032141716" To iSuccess
Get ComUpdateString Of hoJson "merchant_info.address.line1" "1234 Main St." To iSuccess
Get ComUpdateString Of hoJson "merchant_info.address.city" "Portland" To iSuccess
Get ComUpdateString Of hoJson "merchant_info.address.state" "OR" To iSuccess
Get ComUpdateString Of hoJson "merchant_info.address.postal_code" "97217" To iSuccess
Get ComUpdateString Of hoJson "merchant_info.address.country_code" "US" To iSuccess
Get ComUpdateString Of hoJson "billing_info[0].email" "frank-buyer@somewhere.com" To iSuccess
Get ComUpdateString Of hoJson "items[0].name" "Sutures" To iSuccess
Get ComUpdateInt Of hoJson "items[0].quantity" 100 To iSuccess
Get ComUpdateString Of hoJson "items[0].unit_price.currency" "USD" To iSuccess
Get ComUpdateString Of hoJson "items[0].unit_price.value" "5" To iSuccess
Get ComUpdateString Of hoJson "note" "Medical Invoice 16 Jul, 2013 PST" To iSuccess
Get ComUpdateString Of hoJson "payment_term.term_type" "NET_45" To iSuccess
Get ComUpdateString Of hoJson "shipping_info.first_name" "Sally" To iSuccess
Get ComUpdateString Of hoJson "shipping_info.last_name" "Patient" To iSuccess
Get ComUpdateString Of hoJson "shipping_info.business_name" "Not applicable" To iSuccess
Get ComUpdateString Of hoJson "shipping_info.phone.country_code" "001" To iSuccess
Get ComUpdateString Of hoJson "shipping_info.phone.national_number" "5039871234" To iSuccess
Get ComUpdateString Of hoJson "shipping_info.address.line1" "1234 Broad St." To iSuccess
Get ComUpdateString Of hoJson "shipping_info.address.city" "Portland" To iSuccess
Get ComUpdateString Of hoJson "shipping_info.address.state" "OR" To iSuccess
Get ComUpdateString Of hoJson "shipping_info.address.postal_code" "97216" To iSuccess
Get ComUpdateString Of hoJson "shipping_info.address.country_code" "US" To iSuccess
Get ComEmit Of hoJson To sTemp1
Showln sTemp1
// 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 }'
Set ComEmitCompact Of hoJson To True
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get ComAddHeader Of hoRest "Content-Type" "application/json" To iSuccess
Get ComGetAsString Of hoSbAuth To sTemp1
Get ComAddHeader Of hoRest "Authorization" sTemp1 To iSuccess
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComFullRequestSb Of hoRest "POST" "/v1/invoicing/invoices" vSbRequestBody vSbResponseBody To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoRest To sTemp1
Showln sTemp1
Procedure_Return
End
// We should have some sort of JSON response. It could be successful, or an error.
Get Create (RefClass(cComChilkatJsonObject)) To hoJsonResponse
If (Not(IsComObjectCreated(hoJsonResponse))) Begin
Send CreateComObject of hoJsonResponse
End
Set ComEmitCompact Of hoJsonResponse To False
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJsonResponse vSbResponseBody To iSuccess
Get ComResponseStatusCode Of hoRest To iTemp1
Showln "Response Status Code = " iTemp1
// Did we get a 201 success response?
Get ComResponseStatusCode Of hoRest To iTemp1
If (iTemp1 <> 201) Begin
// Show the JSON response body
Get ComEmit Of hoJsonResponse To sTemp1
Showln sTemp1
Get ComLastRequestStartLine Of hoRest To sTemp1
Showln sTemp1
Get ComLastRequestHeader Of hoRest To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// Show a few parts of the JSON response
Get ComStringOf Of hoJsonResponse "id" To sTemp1
Showln "id: " sTemp1
Get ComStringOf Of hoJsonResponse "number" To sTemp1
Showln "number: " sTemp1
Get ComStringOf Of hoJsonResponse "template_id" To sTemp1
Showln "template_id: " sTemp1
Get ComStringOf Of hoJsonResponse "status" To sTemp1
Showln "status: " sTemp1
// Show the full JSON response.
Get ComEmit Of hoJsonResponse To sTemp1
Showln sTemp1
Showln "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"
// }
// ]
// }
//
End_Procedure