(Swift 3,4,5...) PayPal Search for Invoices

Search PayPal invoices.

See also SearchInvoices

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.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)
    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..
    // ----------------------------------------------------------------------------------------------

    // Create JSON to specify the search
    let json = CkoJsonObject()!
    json.emitCompact = false
    json.append("start_invoice_date", value: "2016-01-01 PST")
    json.append("end_invoice_date", value: "2016-11-16 PST")
    json.appendInt("page", value: 0)
    json.appendInt("page_size", value: 10)
    json.appendBool("total_count_required", value: true)

    print("\(json.emit()!)")

    // The JSON by the above code:

    // 	{
    // 	  "start_invoice_date": "2016-01-01 PST",
    // 	  "end_invoice_date": "2016-11-16 PST",
    // 	  "page": 0,
    // 	  "page_size": 10,
    // 	  "total_count_required": true
    // 	}

    // Send the POST equivalent to this CURL command:

    // 	curl -v -X POST https://api.sandbox.paypal.com/v1/invoicing/search/ \
    // 	-H "Content-Type:application/json" \
    // 	-H "Authorization: Bearer Access-Token" \
    // 	-d '{ invoice JSON goes here }'

    json.emitCompact = true
    let sbRequestBody = CkoStringBuilder()!
    let sbResponseBody = CkoStringBuilder()!

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

    success = rest.fullRequestSb("POST", uriPath: "/v1/invoicing/search", requestBody: sbRequestBody, responseBody: sbResponseBody)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    // We should have some sort of JSON response.  It could be successful, or an error.
    let jsonResponse = CkoJsonObject()!
    jsonResponse.emitCompact = false
    jsonResponse.loadSb(sbResponseBody)

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

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

    // Sample response JSON is shown below.

    // Iterate over each invoice and get some information from each..
    var numInvoices: Int = jsonResponse.size(ofArray: "invoices").intValue
    var i: Int = 0
    while i < numInvoices {
        jsonResponse.i = i
        print("Invoice ID: \(jsonResponse.string(of: "invoices[i].id")!)")
        print("Shipping First Name: \(jsonResponse.string(of: "invoices[i].shipping_info.first_name")!)")
        var j: Int = 0
        var numBillingInfo: Int = jsonResponse.size(ofArray: "invoices[i].billing_info").intValue
        while j < numBillingInfo {
            jsonResponse.j = j
            print("billing_info email: \(jsonResponse.string(of: "invoices[i].billing_info[j].email")!)")
            j = j + 1
        }

        var numLinks: Int = jsonResponse.size(ofArray: "invoices[i].links").intValue
        j = 0
        while j < numLinks {
            jsonResponse.j = j
            print("link: \(jsonResponse.string(of: "invoices[i].links[j].href")!)")
            j = j + 1
        }

        print("----")
        i = i + 1
    }

    print("Success.")

    // A successful response looks like this:

    // { 
    //   "total_count": 2,
    //   "invoices": [
    //     { 
    //       "id": "INV2-XV4B-736P-PLVN-SZCE",
    //       "number": "0002",
    //       "status": "DRAFT",
    //       "merchant_info": { 
    //         "email": "smith-facilitator@chilkatsoft.com"
    //       },
    //       "billing_info": [
    //         { 
    //           "email": "smith-buyer@chilkatsoft.com"
    //         }
    //       ],
    //       "shipping_info": { 
    //         "email": "smith-buyer@chilkatsoft.com",
    //         "first_name": "Sally",
    //         "last_name": "Patient",
    //         "business_name": "Not applicable"
    //       },
    //       "invoice_date": "2016-11-15 PST",
    //       "payment_term": { 
    //         "due_date": "2016-12-30 PST"
    //       },
    //       "note": "Medical Invoice 16 Jul, 2013 PST",
    //       "total_amount": { 
    //         "currency": "USD",
    //         "value": "500.00"
    //       },
    //       "metadata": { 
    //         "created_date": "2016-11-15 08:09:21 PST"
    //       },
    //       "paid_amount": { 
    //         "paypal": { 
    //           "currency": "USD",
    //           "value": "0.00"
    //         },
    //         "other": { 
    //           "currency": "USD",
    //           "value": "0.00"
    //         }
    //       },
    //       "refunded_amount": { 
    //         "paypal": { 
    //           "currency": "USD",
    //           "value": "0.00"
    //         },
    //         "other": { 
    //           "currency": "USD",
    //           "value": "0.00"
    //         }
    //       },
    //       "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"
    //         }
    //       ]
    //     },
    //     { 
    //       "id": "INV2-ZG2H-HKAW-PMWU-N6ZR",
    //       "number": "0001",
    //       "status": "SENT",
    //       "merchant_info": { 
    //         "email": "smith-facilitator@chilkatsoft.com"
    //       },
    //       "billing_info": [
    //         { 
    //           "email": "smith-buyer@chilkatsoft.com"
    //         }
    //       ],
    //       "shipping_info": { 
    //         "email": "smith-buyer@chilkatsoft.com",
    //         "first_name": "Sally",
    //         "last_name": "Patient",
    //         "business_name": "Not applicable"
    //       },
    //       "invoice_date": "2016-11-15 PST",
    //       "payment_term": { 
    //         "due_date": "2016-12-30 PST"
    //       },
    //       "note": "Medical Invoice 16 Jul, 2013 PST",
    //       "total_amount": { 
    //         "currency": "USD",
    //         "value": "500.00"
    //       },
    //       "metadata": { 
    //         "created_date": "2016-11-15 06:17:03 PST",
    //         "payer_view_url": "https://www.sandbox.paypal.com/cgi_bin/webscr?cmd=_pay-inv&viewtype=altview&id=INV2-ZG2H-HKAW-PMWU-N6ZR"
    //       },
    //       "paid_amount": { 
    //         "paypal": { 
    //           "currency": "USD",
    //           "value": "0.00"
    //         },
    //         "other": { 
    //           "currency": "USD",
    //           "value": "0.00"
    //         }
    //       },
    //       "refunded_amount": { 
    //         "paypal": { 
    //           "currency": "USD",
    //           "value": "0.00"
    //         },
    //         "other": { 
    //           "currency": "USD",
    //           "value": "0.00"
    //         }
    //       },
    //       "links": [
    //         { 
    //           "rel": "self",
    //           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR",
    //           "method": "GET"
    //         },
    //         { 
    //           "rel": "update",
    //           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/update",
    //           "method": "PUT"
    //         },
    //         { 
    //           "rel": "cancel",
    //           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/remind",
    //           "method": "POST"
    //         },
    //         { 
    //           "rel": "remind",
    //           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/cancel",
    //           "method": "POST"
    //         },
    //         { 
    //           "rel": "record-payment",
    //           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/record-payment",
    //           "method": "POST"
    //         },
    //         { 
    //           "rel": "qr-code",
    //           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/qr-code",
    //           "method": "GET"
    //         }
    //       ]
    //     }
    //   ]
    // }
    // 

}