Chilkat Online Tools

Swift3 / New FreshBooks / Update Invoice Profile

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

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

    // The following JSON is sent in the request body.

    // {
    //   "invoice_profile": {
    //     "frequency": "2w",
    //     "numberRecurring": 12
    //   }
    // }

    let json = CkoJsonObject()!
    json.update("invoice_profile.frequency", value: "2w")
    json.updateInt("invoice_profile.numberRecurring", value: 12)

    // Adds the "Authorization: Bearer <access_token>" header.
    http.authToken = "<access_token>"
    http.setRequestHeader("Content-Type", value: "application/json")

    let sbRequestBody = CkoStringBuilder()!
    json.emitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.pTextSb("PUT", url: "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "response": {
    //     "result": {
    //       "invoice_profile": {
    //         "accounting_systemid": "wkMd2g",
    //         "address": "",
    //         "amount": {
    //           "amount": "0.00",
    //           "code": "USD"
    //         },
    //         "auto_bill": false,
    //         "bill_gateway": null,
    //         "city": "",
    //         "code": "",
    //         "country": "Canada",
    //         "create_date": "2019-04-25",
    //         "currency_code": "USD",
    //         "customerid": 31006,
    //         "description": "",
    //         "disable": false,
    //         "discount_total": {
    //           "amount": "0.00",
    //           "code": "USD"
    //         },
    //         "discount_value": "0",
    //         "due_offset_days": 0,
    //         "ext_archive": null,
    //         "fname": "Nicolas",
    //         "frequency": "2w",
    //         "id": 456,
    //         "include_unbilled_time": false,
    //         "language": "en",
    //         "lname": "one",
    //         "notes": "",
    //         "numberRecurring": 12,
    //         "occurrences_to_date": 0,
    //         "organization": "first company",
    //         "ownerid": 1,
    //         "payment_details": "",
    //         "po_number": null,
    //         "profileid": 456,
    //         "province": "",
    //         "require_auto_bill": false,
    //         "retainer_id": null,
    //         "send_email": true,
    //         "send_gmail": false,
    //         "street": "",
    //         "street2": "",
    //         "terms": null,
    //         "total_accrued_revenue": null,
    //         "updated": "2019-04-24 14:18:27",
    //         "vat_name": null,
    //         "vat_number": "",
    //         "vis_state": 0
    //       }
    //     }
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var Accounting_systemid: String? = jResp.string(of: "response.result.invoice_profile.accounting_systemid")
    var Address: String? = jResp.string(of: "response.result.invoice_profile.address")
    var Amount: String? = jResp.string(of: "response.result.invoice_profile.amount.amount")
    var Code: String? = jResp.string(of: "response.result.invoice_profile.amount.code")
    var Auto_bill: Bool = jResp.bool(of: "response.result.invoice_profile.auto_bill")
    var Bill_gateway: String? = jResp.string(of: "response.result.invoice_profile.bill_gateway")
    var City: String? = jResp.string(of: "response.result.invoice_profile.city")
    var Invoice_profileCode: String? = jResp.string(of: "response.result.invoice_profile.code")
    var Country: String? = jResp.string(of: "response.result.invoice_profile.country")
    var Create_date: String? = jResp.string(of: "response.result.invoice_profile.create_date")
    var Currency_code: String? = jResp.string(of: "response.result.invoice_profile.currency_code")
    var Customerid: Int = jResp.int(of: "response.result.invoice_profile.customerid").intValue
    var Description: String? = jResp.string(of: "response.result.invoice_profile.description")
    var Disable: Bool = jResp.bool(of: "response.result.invoice_profile.disable")
    var Discount_totalAmount: String? = jResp.string(of: "response.result.invoice_profile.discount_total.amount")
    var Discount_totalCode: String? = jResp.string(of: "response.result.invoice_profile.discount_total.code")
    var Discount_value: String? = jResp.string(of: "response.result.invoice_profile.discount_value")
    var Due_offset_days: Int = jResp.int(of: "response.result.invoice_profile.due_offset_days").intValue
    var Ext_archive: String? = jResp.string(of: "response.result.invoice_profile.ext_archive")
    var Fname: String? = jResp.string(of: "response.result.invoice_profile.fname")
    var Frequency: String? = jResp.string(of: "response.result.invoice_profile.frequency")
    var Id: Int = jResp.int(of: "response.result.invoice_profile.id").intValue
    var Include_unbilled_time: Bool = jResp.bool(of: "response.result.invoice_profile.include_unbilled_time")
    var Language: String? = jResp.string(of: "response.result.invoice_profile.language")
    var Lname: String? = jResp.string(of: "response.result.invoice_profile.lname")
    var Notes: String? = jResp.string(of: "response.result.invoice_profile.notes")
    var NumberRecurring: Int = jResp.int(of: "response.result.invoice_profile.numberRecurring").intValue
    var Occurrences_to_date: Int = jResp.int(of: "response.result.invoice_profile.occurrences_to_date").intValue
    var Organization: String? = jResp.string(of: "response.result.invoice_profile.organization")
    var Ownerid: Int = jResp.int(of: "response.result.invoice_profile.ownerid").intValue
    var Payment_details: String? = jResp.string(of: "response.result.invoice_profile.payment_details")
    var Po_number: String? = jResp.string(of: "response.result.invoice_profile.po_number")
    var Profileid: Int = jResp.int(of: "response.result.invoice_profile.profileid").intValue
    var Province: String? = jResp.string(of: "response.result.invoice_profile.province")
    var Require_auto_bill: Bool = jResp.bool(of: "response.result.invoice_profile.require_auto_bill")
    var Retainer_id: String? = jResp.string(of: "response.result.invoice_profile.retainer_id")
    var Send_email: Bool = jResp.bool(of: "response.result.invoice_profile.send_email")
    var Send_gmail: Bool = jResp.bool(of: "response.result.invoice_profile.send_gmail")
    var Street: String? = jResp.string(of: "response.result.invoice_profile.street")
    var Street2: String? = jResp.string(of: "response.result.invoice_profile.street2")
    var Terms: String? = jResp.string(of: "response.result.invoice_profile.terms")
    var Total_accrued_revenue: String? = jResp.string(of: "response.result.invoice_profile.total_accrued_revenue")
    var Updated: String? = jResp.string(of: "response.result.invoice_profile.updated")
    var Vat_name: String? = jResp.string(of: "response.result.invoice_profile.vat_name")
    var Vat_number: String? = jResp.string(of: "response.result.invoice_profile.vat_number")
    var Vis_state: Int = jResp.int(of: "response.result.invoice_profile.vis_state").intValue

}

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "invoice_profile": {
    "frequency": "2w",
    "numberRecurring": 12
  }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}

Postman Collection Item JSON

{
  "name": "Update Invoice Profile",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"invoice_profile\": {\n    \"frequency\": \"2w\",\n    \"numberRecurring\": 12\n  }\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "invoice_profiles",
        "invoice_profiles",
        "{{invoiceProfileId}}"
      ]
    },
    "description": "Update invoice profile to two weeks and increase the number of remaining invoices to 10.\n\n"
  },
  "response": [
    {
      "name": "Update Invoice Profile",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"invoice_profile\": {\n    \"frequency\": \"2w\",\n    \"numberRecurring\": 12\n  }\n}"
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "invoice_profiles",
            "invoice_profiles",
            "{{invoiceProfileId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGPUAQVwRRVFFBCQxXF14IUAcURFgHDw9dERxUTVIZAA5SUAAABlBUWlUJVQtUCwsYBQpJGwcJAwFRUVMAUFdWWVUIB1BAG1dWChdUaw=="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:18:27 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Date",
          "value": "Wed, 24 Apr 2019 18:18:27 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17369-MDW"
        },
        {
          "key": "X-Cache",
          "value": "MISS"
        },
        {
          "key": "X-Cache-Hits",
          "value": "0"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Country",
          "value": "CA"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains; preload"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"response\": {\n        \"result\": {\n            \"invoice_profile\": {\n                \"accounting_systemid\": \"wkMd2g\",\n                \"address\": \"\",\n                \"amount\": {\n                    \"amount\": \"0.00\",\n                    \"code\": \"USD\"\n                },\n                \"auto_bill\": false,\n                \"bill_gateway\": null,\n                \"city\": \"\",\n                \"code\": \"\",\n                \"country\": \"Canada\",\n                \"create_date\": \"2019-04-25\",\n                \"currency_code\": \"USD\",\n                \"customerid\": 31006,\n                \"description\": \"\",\n                \"disable\": false,\n                \"discount_total\": {\n                    \"amount\": \"0.00\",\n                    \"code\": \"USD\"\n                },\n                \"discount_value\": \"0\",\n                \"due_offset_days\": 0,\n                \"ext_archive\": null,\n                \"fname\": \"Nicolas\",\n                \"frequency\": \"2w\",\n                \"id\": 456,\n                \"include_unbilled_time\": false,\n                \"language\": \"en\",\n                \"lname\": \"one\",\n                \"notes\": \"\",\n                \"numberRecurring\": 12,\n                \"occurrences_to_date\": 0,\n                \"organization\": \"first company\",\n                \"ownerid\": 1,\n                \"payment_details\": \"\",\n                \"po_number\": null,\n                \"profileid\": 456,\n                \"province\": \"\",\n                \"require_auto_bill\": false,\n                \"retainer_id\": null,\n                \"send_email\": true,\n                \"send_gmail\": false,\n                \"street\": \"\",\n                \"street2\": \"\",\n                \"terms\": null,\n                \"total_accrued_revenue\": null,\n                \"updated\": \"2019-04-24 14:18:27\",\n                \"vat_name\": null,\n                \"vat_number\": \"\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}