(PureBasic) PayPal - Update Invoice

Update a PayPal invoice.

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

See also PayPal Update Invoice REST API Reference

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    ; 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)
    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/paypal.json")

    ; Build the Authorization request header field value.
    sbAuth.i = CkStringBuilder::ckCreate()
    If sbAuth.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; token_type should be "Bearer"
    CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(jsonToken,"token_type"))
    CkStringBuilder::ckAppend(sbAuth," ")
    CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(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.
    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    bAutoReconnect.i = 1
    success.i = CkRest::ckConnect(rest,"api.sandbox.paypal.com",443,1,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkStringBuilder::ckDispose(sbAuth)
        CkRest::ckDispose(rest)
        ProcedureReturn
    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 the JSON with updated information:

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(json, 0)
    CkJsonObject::ckUpdateString(json,"merchant_info.email","smith-facilitator@chilkatsoft.com")
    CkJsonObject::ckUpdateString(json,"merchant_info.first_name","Joe")
    CkJsonObject::ckUpdateString(json,"merchant_info.last_name","Facilitator")
    CkJsonObject::ckUpdateString(json,"merchant_info.business_name","Medical Professionals, LLC")
    CkJsonObject::ckUpdateString(json,"merchant_info.phone.country_code","001")
    CkJsonObject::ckUpdateString(json,"merchant_info.phone.national_number","5032141716")
    CkJsonObject::ckUpdateString(json,"merchant_info.address.line1","1234 Main St.")
    CkJsonObject::ckUpdateString(json,"merchant_info.address.city","Portland")
    CkJsonObject::ckUpdateString(json,"merchant_info.address.state","OR")
    CkJsonObject::ckUpdateString(json,"merchant_info.address.postal_code","97217")
    CkJsonObject::ckUpdateString(json,"merchant_info.address.country_code","US")
    CkJsonObject::ckUpdateString(json,"billing_info[0].email","smith-buyer@chilkatsoft.com")
    CkJsonObject::ckUpdateString(json,"shipping_info.first_name","Sally")
    CkJsonObject::ckUpdateString(json,"shipping_info.last_name","Patient")
    CkJsonObject::ckUpdateString(json,"shipping_info.business_name","Not applicable")
    CkJsonObject::ckUpdateString(json,"shipping_info.phone.country_code","001")
    CkJsonObject::ckUpdateString(json,"shipping_info.phone.national_number","5039871234")
    CkJsonObject::ckUpdateString(json,"shipping_info.address.line1","1234 Broad St.")
    CkJsonObject::ckUpdateString(json,"shipping_info.address.city","Portland")
    CkJsonObject::ckUpdateString(json,"shipping_info.address.state","OR")
    CkJsonObject::ckUpdateString(json,"shipping_info.address.postal_code","97216")
    CkJsonObject::ckUpdateString(json,"shipping_info.address.country_code","US")
    CkJsonObject::ckUpdateString(json,"items[0].name","Sutures")
    ; We are updating the quantity from 100.0 to 200.0
    ; Note: The UpdateNumber method is added in v9.5.0.65
    CkJsonObject::ckUpdateNumber(json,"items[0].quantity","200.0")
    CkJsonObject::ckUpdateString(json,"items[0].unit_price.currency","USD")
    CkJsonObject::ckUpdateString(json,"items[0].unit_price.value","5.00")
    CkJsonObject::ckUpdateString(json,"payment_term.term_type","NET_45")
    CkJsonObject::ckUpdateString(json,"payment_term.due_date","2016-12-30 PST")
    CkJsonObject::ckUpdateString(json,"note","Medical Invoice 16 Jul, 2013 PST")

    ; The JSON created by the above code is this:

    ; 	{ 
    ; 	  "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": 200.0,
    ; 	      "unit_price": { 
    ; 	        "currency": "USD",
    ; 	        "value": "5.00"
    ; 	      }
    ; 	    }
    ; 	  ],
    ; 	  "payment_term": { 
    ; 	    "term_type": "NET_45",
    ; 	    "due_date": "2016-12-30 PST"
    ; 	  },
    ; 	  "note": "Medical Invoice 16 Jul, 2013 PST"
    ; 	}

    CkRest::ckAddHeader(rest,"Authorization",CkStringBuilder::ckGetAsString(sbAuth))
    CkRest::ckAddHeader(rest,"Content-Type","application/json")

    invoiceId.s = "INV2-XV4B-736P-PLVN-SZCE"

    sbPath.i = CkStringBuilder::ckCreate()
    If sbPath.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbPath,"/v1/invoicing/invoices/")
    CkStringBuilder::ckAppend(sbPath,invoiceId)

    ; Send the PUT request containign the JSON in the request body, and get the JSON response.
    sbJsonRequest.i = CkStringBuilder::ckCreate()
    If sbJsonRequest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbJsonRequest)
    sbJsonResponse.i = CkStringBuilder::ckCreate()
    If sbJsonResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestSb(rest,"PUT",CkStringBuilder::ckGetAsString(sbPath),sbJsonRequest,sbJsonResponse)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkStringBuilder::ckDispose(sbAuth)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbPath)
        CkStringBuilder::ckDispose(sbJsonRequest)
        CkStringBuilder::ckDispose(sbJsonResponse)
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(json,sbJsonResponse)

    Debug "Response Status Code = " + Str(CkRest::ckResponseStatusCode(rest))

    ; Did we get a 200 success response?
    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug CkJsonObject::ckEmit(json)
        Debug "Failed."
        CkJsonObject::ckDispose(jsonToken)
        CkStringBuilder::ckDispose(sbAuth)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbPath)
        CkStringBuilder::ckDispose(sbJsonRequest)
        CkStringBuilder::ckDispose(sbJsonResponse)
        ProcedureReturn
    EndIf

    ; Sample response JSON is shown below.

    ; Get some information..
    Debug "email: " + CkJsonObject::ckStringOf(json,"merchant_info.email")
    Debug "business_name: " + CkJsonObject::ckStringOf(json,"merchant_info.business_name")

    numItems.i = CkJsonObject::ckSizeOfArray(json,"items")
    i.i = 0
    While i < numItems
        CkJsonObject::setCkI(json, i)
        Debug "item name: " + CkJsonObject::ckStringOf(json,"items[i].name")
        Debug "item quantity: " + CkJsonObject::ckStringOf(json,"items[i].quantity")
        Debug "item currency: " + CkJsonObject::ckStringOf(json,"items[i].unit_price.currency")
        Debug "item value: " + CkJsonObject::ckStringOf(json,"items[i].unit_price.value")
        Debug "----"
        i = i + 1
    Wend

    Debug "Success."


    CkJsonObject::ckDispose(jsonToken)
    CkStringBuilder::ckDispose(sbAuth)
    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbPath)
    CkStringBuilder::ckDispose(sbJsonRequest)
    CkStringBuilder::ckDispose(sbJsonResponse)


    ProcedureReturn
EndProcedure