(Swift 3,4,5...) 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 Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

func chilkatTest() {
    // 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)
    let jsonToken = CkoJsonObject()!
    jsonToken.loadFile("qa_data/tokens/paypal.json")

    // Build the Authorization request header field value.
    let sbAuth = CkoStringBuilder()!
    // token_type should be "Bearer"
    sbAuth.append(jsonToken.string(of: "token_type"))
    sbAuth.append(" ")
    sbAuth.append(jsonToken.string(of: "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.
    let rest = CkoRest()!
    var bAutoReconnect: Bool = true
    var success: Bool = rest.connect("api.sandbox.paypal.com", port: 443, tls: true, autoReconnect: bAutoReconnect)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    // ----------------------------------------------------------------------------------------------
    // 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:

    let json = CkoJsonObject()!
    json.emitCompact = false
    json.update("merchant_info.email", value: "smith-facilitator@chilkatsoft.com")
    json.update("merchant_info.first_name", value: "Joe")
    json.update("merchant_info.last_name", value: "Facilitator")
    json.update("merchant_info.business_name", value: "Medical Professionals, LLC")
    json.update("merchant_info.phone.country_code", value: "001")
    json.update("merchant_info.phone.national_number", value: "5032141716")
    json.update("merchant_info.address.line1", value: "1234 Main St.")
    json.update("merchant_info.address.city", value: "Portland")
    json.update("merchant_info.address.state", value: "OR")
    json.update("merchant_info.address.postal_code", value: "97217")
    json.update("merchant_info.address.country_code", value: "US")
    json.update("billing_info[0].email", value: "smith-buyer@chilkatsoft.com")
    json.update("shipping_info.first_name", value: "Sally")
    json.update("shipping_info.last_name", value: "Patient")
    json.update("shipping_info.business_name", value: "Not applicable")
    json.update("shipping_info.phone.country_code", value: "001")
    json.update("shipping_info.phone.national_number", value: "5039871234")
    json.update("shipping_info.address.line1", value: "1234 Broad St.")
    json.update("shipping_info.address.city", value: "Portland")
    json.update("shipping_info.address.state", value: "OR")
    json.update("shipping_info.address.postal_code", value: "97216")
    json.update("shipping_info.address.country_code", value: "US")
    json.update("items[0].name", value: "Sutures")
    // We are updating the quantity from 100.0 to 200.0
    // Note: The UpdateNumber method is added in v9.5.0.65
    json.updateNumber("items[0].quantity", numericStr: "200.0")
    json.update("items[0].unit_price.currency", value: "USD")
    json.update("items[0].unit_price.value", value: "5.00")
    json.update("payment_term.term_type", value: "NET_45")
    json.update("payment_term.due_date", value: "2016-12-30 PST")
    json.update("note", value: "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"
    // 	}

    rest.addHeader("Authorization", value: sbAuth.getAsString())
    rest.addHeader("Content-Type", value: "application/json")

    var invoiceId: String? = "INV2-XV4B-736P-PLVN-SZCE"

    let sbPath = CkoStringBuilder()!
    sbPath.append("/v1/invoicing/invoices/")
    sbPath.append(invoiceId)

    // Send the PUT request containign the JSON in the request body, and get the JSON response.
    let sbJsonRequest = CkoStringBuilder()!
    json.emitSb(sbJsonRequest)
    let sbJsonResponse = CkoStringBuilder()!
    success = rest.fullRequestSb("PUT", uriPath: sbPath.getAsString(), requestBody: sbJsonRequest, responseBody: sbJsonResponse)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    json.loadSb(sbJsonResponse)

    print("Response Status Code = \(rest.responseStatusCode.intValue)")

    // Did we get a 200 success response?
    if rest.responseStatusCode.intValue != 200 {
        print("\(json.emit()!)")
        print("Failed.")
        return
    }

    // Sample response JSON is shown below.

    // Get some information..
    print("email: \(json.string(of: "merchant_info.email")!)")
    print("business_name: \(json.string(of: "merchant_info.business_name")!)")

    var numItems: Int = json.size(ofArray: "items").intValue
    var i: Int = 0
    while i < numItems {
        json.i = i
        print("item name: \(json.string(of: "items[i].name")!)")
        print("item quantity: \(json.string(of: "items[i].quantity")!)")
        print("item currency: \(json.string(of: "items[i].unit_price.currency")!)")
        print("item value: \(json.string(of: "items[i].unit_price.value")!)")
        print("----")
        i = i + 1
    }

    print("Success.")

}