Tcl

PayPal - Generate Invoice Number

See more PayPal Examples

Generates the next invoice number that is available to the user.

Note: This example requires Chilkat v9.5.0.65 or greater.

Tcl

load ./chilkat.dll

set success 0

# Note: Requires Chilkat v9.5.0.65 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..
# ----------------------------------------------------------------------------------------------

# Clear the REST object of any headers or query params from previous requests.
CkRest_ClearAllHeaders $rest
CkRest_ClearAllQueryParams $rest

CkRest_AddHeader $rest "Authorization" [CkStringBuilder_getAsString $sbAuth]

# Send the POST request with an emtpy body and get the JSON response.
set sbJsonRequest [new_CkStringBuilder]

set sbJsonResponse [new_CkStringBuilder]

set success [CkRest_FullRequestSb $rest "POST" "/v1/invoicing/invoices/next-invoice-number" $sbJsonRequest $sbJsonResponse]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    delete_CkStringBuilder $sbJsonRequest
    delete_CkStringBuilder $sbJsonResponse
    exit
}

set json [new_CkJsonObject]

CkJsonObject_put_EmitCompact $json 0
CkJsonObject_LoadSb $json $sbJsonResponse

puts "Response Status Code = [CkRest_get_ResponseStatusCode $rest]"

# Did we get a 200 success response?
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    puts [CkJsonObject_emit $json]
    puts "Failed."
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    delete_CkStringBuilder $sbJsonRequest
    delete_CkStringBuilder $sbJsonResponse
    delete_CkJsonObject $json
    exit
}

# Sample JSON response is shown below.
puts [CkJsonObject_emit $json]
puts "----------------------"
puts "Next invoice number: [CkJsonObject_stringOf $json number]"
puts "success"

# ------------------------------------------------
# A sample JSON response:

# 	{ 
# 	  "number": "0003"
# 	}

delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
delete_CkStringBuilder $sbJsonRequest
delete_CkStringBuilder $sbJsonResponse
delete_CkJsonObject $json