Tcl
Tcl
PayPal Create Invoice
See more PayPal Examples
Creates a draft invoice.Chilkat Tcl Downloads
load ./chilkat.dll
set 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)
set jsonToken [new_CkJsonObject]
CkJsonObject_LoadFile $jsonToken "qa_data/tokens/paypal.json"
# Build the Authorization request header field value.
set sbAuth [new_CkStringBuilder]
# token_type should be "Bearer"
CkStringBuilder_Append $sbAuth [CkJsonObject_stringOf $jsonToken "token_type"]
CkStringBuilder_Append $sbAuth " "
CkStringBuilder_Append $sbAuth [CkJsonObject_stringOf $jsonToken "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.
set rest [new_CkRest]
set bAutoReconnect 1
set success [CkRest_Connect $rest "api.sandbox.paypal.com" 443 1 $bAutoReconnect]
if {$success != 1} then {
puts [CkRest_lastErrorText $rest]
delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
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..
# ----------------------------------------------------------------------------------------------
# First create a JSON invoice:
set json [new_CkJsonObject]
CkJsonObject_put_EmitCompact $json 0
CkJsonObject_UpdateString $json "merchant_info.email" "frank-facilitator@example.com"
CkJsonObject_UpdateString $json "merchant_info.first_name" "Frank"
CkJsonObject_UpdateString $json "merchant_info.last_name" "Facilitator"
CkJsonObject_UpdateString $json "merchant_info.business_name" "Medical Professionals, LLC"
CkJsonObject_UpdateString $json "merchant_info.phone.country_code" "001"
CkJsonObject_UpdateString $json "merchant_info.phone.national_number" "5032141716"
CkJsonObject_UpdateString $json "merchant_info.address.line1" "1234 Main St."
CkJsonObject_UpdateString $json "merchant_info.address.city" "Portland"
CkJsonObject_UpdateString $json "merchant_info.address.state" "OR"
CkJsonObject_UpdateString $json "merchant_info.address.postal_code" "97217"
CkJsonObject_UpdateString $json "merchant_info.address.country_code" "US"
CkJsonObject_UpdateString $json "billing_info[0].email" "frank-buyer@somewhere.com"
CkJsonObject_UpdateString $json "items[0].name" "Sutures"
CkJsonObject_UpdateInt $json "items[0].quantity" 100
CkJsonObject_UpdateString $json "items[0].unit_price.currency" "USD"
CkJsonObject_UpdateString $json "items[0].unit_price.value" "5"
CkJsonObject_UpdateString $json "note" "Medical Invoice 16 Jul, 2013 PST"
CkJsonObject_UpdateString $json "payment_term.term_type" "NET_45"
CkJsonObject_UpdateString $json "shipping_info.first_name" "Sally"
CkJsonObject_UpdateString $json "shipping_info.last_name" "Patient"
CkJsonObject_UpdateString $json "shipping_info.business_name" "Not applicable"
CkJsonObject_UpdateString $json "shipping_info.phone.country_code" "001"
CkJsonObject_UpdateString $json "shipping_info.phone.national_number" "5039871234"
CkJsonObject_UpdateString $json "shipping_info.address.line1" "1234 Broad St."
CkJsonObject_UpdateString $json "shipping_info.address.city" "Portland"
CkJsonObject_UpdateString $json "shipping_info.address.state" "OR"
CkJsonObject_UpdateString $json "shipping_info.address.postal_code" "97216"
CkJsonObject_UpdateString $json "shipping_info.address.country_code" "US"
puts [CkJsonObject_emit $json]
# 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 }'
CkJsonObject_put_EmitCompact $json 1
set sbRequestBody [new_CkStringBuilder]
set sbResponseBody [new_CkStringBuilder]
CkRest_AddHeader $rest "Content-Type" "application/json"
CkRest_AddHeader $rest "Authorization" [CkStringBuilder_getAsString $sbAuth]
CkJsonObject_EmitSb $json $sbRequestBody
set success [CkRest_FullRequestSb $rest "POST" "/v1/invoicing/invoices" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
puts [CkRest_lastErrorText $rest]
delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
exit
}
# We should have some sort of JSON response. It could be successful, or an error.
set jsonResponse [new_CkJsonObject]
CkJsonObject_put_EmitCompact $jsonResponse 0
CkJsonObject_LoadSb $jsonResponse $sbResponseBody
puts "Response Status Code = [CkRest_get_ResponseStatusCode $rest]"
# Did we get a 201 success response?
if {[CkRest_get_ResponseStatusCode $rest] != 201} then {
# Show the JSON response body
puts [CkJsonObject_emit $jsonResponse]
puts [CkRest_lastRequestStartLine $rest]
puts [CkRest_lastRequestHeader $rest]
puts "Failed."
delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jsonResponse
exit
}
# Show a few parts of the JSON response
puts "id: [CkJsonObject_stringOf $jsonResponse id]"
puts "number: [CkJsonObject_stringOf $jsonResponse number]"
puts "template_id: [CkJsonObject_stringOf $jsonResponse template_id]"
puts "status: [CkJsonObject_stringOf $jsonResponse status]"
# Show the full JSON response.
puts [CkJsonObject_emit $jsonResponse]
puts "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"
# }
# ]
# }
#
delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jsonResponse