(PureBasic) PayPal - Show Invoice Details

Shows details for a PayPal invoice, by ID.

See also PayPal Show Invoice Details 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.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)
    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..
    ; ----------------------------------------------------------------------------------------------

    CkRest::ckAddHeader(rest,"Authorization",CkStringBuilder::ckGetAsString(sbAuth))

    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 GET request and get the JSON response.
    sbJsonResponse.i = CkStringBuilder::ckCreate()
    If sbJsonResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

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

    CkJsonObject::setCkEmitCompact(json, 0)
    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)
        CkStringBuilder::ckDispose(sbPath)
        CkStringBuilder::ckDispose(sbJsonResponse)
        CkJsonObject::ckDispose(json)
        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."

    ; ---------------------------------------------------
    ; A sample response:

    ; 	{
    ; 	  "id": "INV2-XV4B-736P-PLVN-SZCE",
    ; 	  "number": "0002",
    ; 	  "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 08:09:21 PST"
    ; 	  },
    ; 	  "links": [
    ; 	    {
    ; 	      "rel": "self",
    ; 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
    ; 	      "method": "GET"
    ; 	    },
    ; 	    {
    ; 	      "rel": "send",
    ; 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/send",
    ; 	      "method": "POST"
    ; 	    },
    ; 	    {
    ; 	      "rel": "update",
    ; 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/update",
    ; 	      "method": "PUT"
    ; 	    },
    ; 	    {
    ; 	      "rel": "delete",
    ; 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
    ; 	      "method": "DELETE"
    ; 	    }
    ; 	  ]
    ; 	}
    ; 


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


    ProcedureReturn
EndProcedure