Swift

Xero Upload Attachment

See more Xero Examples

Demonstrates how to upload an attachment to Xero. Swift

func chilkatTest() {
    var success: Bool = false

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!

    // Important: Make sure your OAuth2 access token was obtained with the scope "accounting.attachments"
    // included in the list of scopes.

    let jsonToken = CkoJsonObject()!
    success = jsonToken.loadFile(path: "qa_data/tokens/xero-access-token.json")
    if success == false {
        print("\(jsonToken.lastErrorText!)")
        return
    }

    http.authToken = jsonToken.string(of: "access_token")

    // Replace the value here with an actual tenant ID obtained from this example:
    // Get Xero Tenant IDs
    http.setRequestHeader(name: "Xero-tenant-id", value: "83299b9e-5747-4a14-a18a-a6c94f824eb7")

    http.accept = "application/json"

    var url: String? = "https://api.xero.com/api.xro/2.0/{$Endpoint}/{$Guid}/Attachments/{$Filename}"

    // Endpoint can be Invoices, Receipts, CreditNotes, PurchaseOrders, etc.
    http.setUrlVar(name: "Endpoint", value: "Invoices")

    // Guid is the ID of the item, such as the InvoiceID.
    http.setUrlVar(name: "Guid", value: "0032f627-3156-4d30-9b1c-4d3b994dc921")

    // Filename is the filename of the attachment you are uploading.
    http.setUrlVar(name: "Filename", value: "penguins.jpg")

    // Load the file to be uploaded (from the local filesystem).
    let bd = CkoBinData()!
    success = bd.loadFile(path: "qa_data/jpg/penguins.jpg")
    if success == false {
        print("Failed to load attachment file.")
        return
    }

    // Indicate the content-type according to the file content type.
    // Common content-types are:   image/jpg, image/png, application/pdf, application/zip, application/msword
    // If you don't know, use application/octet-stream
    let resp = CkoHttpResponse()!
    success = http.httpBd(verb: "POST", url: url, bd: bd, contentType: "image/jpg", response: resp)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("Response Status Code: \(resp.statusCode.intValue)")

    let jsonResponse = CkoJsonObject()!
    jsonResponse.load(json: resp.bodyStr)
    jsonResponse.emitCompact = false
    print("\(jsonResponse.emit()!)")

    if resp.statusCode.intValue != 200 {
        print("Failed.")
        return
    }

    // A sample response:

    // Use this online tool to generate parsing code from sample JSON: 
    // Generate Parsing Code from JSON

    // {
    //   "Id": "35333c64-4449-457b-bf6a-1b64d538e3c7",
    //   "Status": "OK",
    //   "ProviderName": "Chilkat2222",
    //   "DateTimeUTC": "\/Date(1587212597758)\/",
    //   "Attachments": [
    //     {
    //       "AttachmentID": "daf106e2-8634-4349-bfcc-86c1df0793b2",
    //       "FileName": "penguins.jpg",
    //       "Url": "https://api.xero.com/api.xro/2.0/Invoices/0032f627-3156-4d30-9b1c-4d3b994dc921/Attachments/penguins.jpg",
    //       "MimeType": "image/jpg",
    //       "ContentLength": 777835
    //     }
    //   ]
    // }

}