(Swift 2) PayPal List Merchant Invoices

List PayPal invoices.

See also PayPal List Invoices 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.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.StringOf("token_type"))
    sbAuth.Append(" ")
    sbAuth.Append(jsonToken.StringOf("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..
    // ----------------------------------------------------------------------------------------------

    rest.AddHeader("Authorization", value: sbAuth.GetAsString())
    rest.AddQueryParam("page", value: "0")
    rest.AddQueryParam("page_size", value: "20")
    rest.AddQueryParam("total_count_required", value: "true")

    // Send the GET request and get the JSON response.
    let sbJsonResponse = CkoStringBuilder()
    success = rest.FullRequestNoBodySb("GET", uriPath: "/v1/invoicing/invoices", sb: sbJsonResponse)
    if success != true {
        print("\(rest.LastErrorText)")
        return
    }

    let json = CkoJsonObject()
    json.EmitCompact = false
    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.

    // Iterate over each invoice and get some information from each..
    var numInvoices: Int = json.SizeOfArray("invoices").intValue
    var i: Int = 0
    while i < numInvoices {
        json.I = i
        print("Invoice ID: \(json.StringOf("invoices[i].id"))")
        print("Invoice Number: \(json.StringOf("invoices[i].number"))")
        print("Invoice Status: \(json.StringOf("invoices[i].status"))")
        print("Shipping First Name: \(json.StringOf("invoices[i].shipping_info.first_name"))")
        var j: Int = 0
        var numBillingInfo: Int = json.SizeOfArray("invoices[i].billing_info").intValue
        while j < numBillingInfo {
            json.J = j
            print("billing_info email: \(json.StringOf("invoices[i].billing_info[j].email"))")
            j = j + 1
        }

        var numLinks: Int = json.SizeOfArray("invoices[i].links").intValue
        j = 0
        while j < numLinks {
            json.J = j
            print("link: \(json.StringOf("invoices[i].links[j].href"))")
            j = j + 1
        }

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

    print("Success.")

    // 	{ 
    // 	  "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"
    // 	        }
    // 	      ]
    // 	    }
    // 	  ],
    // 	  "links": [
    // 	    { 
    // 	      "rel": "self",
    // 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices?page=0&page_size=20&total_count_required=true",
    // 	      "method": "GET"
    // 	    }
    // 	  ]
    // 	}
    // 

}