Chilkat Online Tools

Swift3 / New FreshBooks / Create Single Invoice Profile w/ Time Entry Holder

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": {
    //     "customerid": 123,
    //     "frequency": "m",
    //     "profileid": null,
    //     "disable": false,
    //     "due_offset_days": 30,
    //     "numberRecurring": 0,
    //     "send_email": true,
    //     "include_unbilled_time": true,
    //     "project_format": {
    //       "group_by": "service",
    //       "method": "detailed",
    //       "show_tname": true,
    //       "show_pname": true,
    //       "show_staff": true,
    //       "show_date": true,
    //       "show_notes": true,
    //       "show_total_hours": false
    //     },
    //     "skip_generation": false,
    //     "retainer_id": null,
    //     "require_auto_bill": false,
    //     "create_date": "2019-07-15",
    //     "currency_code": "CAD",
    //     "discount_value": 0,
    //     "template": "clean-grouped",
    //     "terms": "Show me the money",
    //     "allowed_gatewayids": [
    //       26
    //     ],
    //     "late_fee": {
    //       "compounded_taxes": false,
    //       "days": 30,
    //       "enabled": false,
    //       "first_tax_name": "HST",
    //       "first_tax_percent": 13,
    //       "repeat": false,
    //       "second_tax_name": null,
    //       "second_tax_percent": null,
    //       "type": "percent",
    //       "value": 10
    //     },
    //     "late_reminders": [
    //     ],
    //     "lines": [
    //       {
    //         "amount": {
    //           "amount": "0",
    //           "code": "CAD"
    //         },
    //         "description": null,
    //         "expenseid": null,
    //         "taxName1": null,
    //         "taxAmount1": 0,
    //         "name": null,
    //         "qty": 1,
    //         "taxName2": null,
    //         "taxAmount2": 0,
    //         "type": 5,
    //         "unit_cost": {
    //           "amount": "0",
    //           "code": "CAD"
    //         },
    //         "profileid": null
    //       }
    //     ]
    //   }
    // }

    let json = CkoJsonObject()!
    json.updateInt("invoice_profile.customerid", value: 123)
    json.update("invoice_profile.frequency", value: "m")
    json.updateNull("invoice_profile.profileid")
    json.updateBool("invoice_profile.disable", value: false)
    json.updateInt("invoice_profile.due_offset_days", value: 30)
    json.updateInt("invoice_profile.numberRecurring", value: 0)
    json.updateBool("invoice_profile.send_email", value: true)
    json.updateBool("invoice_profile.include_unbilled_time", value: true)
    json.update("invoice_profile.project_format.group_by", value: "service")
    json.update("invoice_profile.project_format.method", value: "detailed")
    json.updateBool("invoice_profile.project_format.show_tname", value: true)
    json.updateBool("invoice_profile.project_format.show_pname", value: true)
    json.updateBool("invoice_profile.project_format.show_staff", value: true)
    json.updateBool("invoice_profile.project_format.show_date", value: true)
    json.updateBool("invoice_profile.project_format.show_notes", value: true)
    json.updateBool("invoice_profile.project_format.show_total_hours", value: false)
    json.updateBool("invoice_profile.skip_generation", value: false)
    json.updateNull("invoice_profile.retainer_id")
    json.updateBool("invoice_profile.require_auto_bill", value: false)
    json.update("invoice_profile.create_date", value: "2019-07-15")
    json.update("invoice_profile.currency_code", value: "CAD")
    json.updateInt("invoice_profile.discount_value", value: 0)
    json.update("invoice_profile.template", value: "clean-grouped")
    json.update("invoice_profile.terms", value: "Show me the money")
    json.updateInt("invoice_profile.allowed_gatewayids[0]", value: 26)
    json.updateBool("invoice_profile.late_fee.compounded_taxes", value: false)
    json.updateInt("invoice_profile.late_fee.days", value: 30)
    json.updateBool("invoice_profile.late_fee.enabled", value: false)
    json.update("invoice_profile.late_fee.first_tax_name", value: "HST")
    json.updateInt("invoice_profile.late_fee.first_tax_percent", value: 13)
    json.updateBool("invoice_profile.late_fee.repeat", value: false)
    json.updateNull("invoice_profile.late_fee.second_tax_name")
    json.updateNull("invoice_profile.late_fee.second_tax_percent")
    json.update("invoice_profile.late_fee.type", value: "percent")
    json.updateInt("invoice_profile.late_fee.value", value: 10)
    json.updateNewArray("invoice_profile.late_reminders")
    json.update("invoice_profile.lines[0].amount.amount", value: "0")
    json.update("invoice_profile.lines[0].amount.code", value: "CAD")
    json.updateNull("invoice_profile.lines[0].description")
    json.updateNull("invoice_profile.lines[0].expenseid")
    json.updateNull("invoice_profile.lines[0].taxName1")
    json.updateInt("invoice_profile.lines[0].taxAmount1", value: 0)
    json.updateNull("invoice_profile.lines[0].name")
    json.updateInt("invoice_profile.lines[0].qty", value: 1)
    json.updateNull("invoice_profile.lines[0].taxName2")
    json.updateInt("invoice_profile.lines[0].taxAmount2", value: 0)
    json.updateInt("invoice_profile.lines[0].type", value: 5)
    json.update("invoice_profile.lines[0].unit_cost.amount", value: "0")
    json.update("invoice_profile.lines[0].unit_cost.code", value: "CAD")
    json.updateNull("invoice_profile.lines[0].profileid")

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

    var resp: CkoHttpResponse? = http.postJson3("https://api.freshbooks.com/accounting/account/{{accountid}}/invoice_profiles/invoice_profiles?include[]=allowed_gateways,contacts,late_fee,late_reminders,lines,presentation,system,tracking,project_format,total_accrued_revenue&include%5B%5D=allowed_gateways,contacts,late_fee,late_reminders,lines,presentation,system,tracking,project_format,total_accrued_revenue", contentType: "application/json", json: json)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("\(resp!.statusCode.intValue)")
    print("\(resp!.bodyStr!)")
    resp = nil

}

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "invoice_profile":
  {
    "customerid": {{customerid}},
    "frequency":"m",
    "profileid":null,
    "disable":false,
    "due_offset_days":30,
    "numberRecurring":0,
    "send_email":true,
    "include_unbilled_time":true,
    "project_format":
    {
      "group_by":"service",
      "method":"detailed",
      "show_tname":true,
      "show_pname":true,
      "show_staff":true,
      "show_date":true,
      "show_notes":true,
      "show_total_hours":false
    },
    "skip_generation":false,
    "retainer_id":null,
    "require_auto_bill":false,
    "create_date":"2019-07-15",
    "currency_code":"CAD",
    "discount_value":0,
    "template":"clean-grouped",
    "terms": "Show me the money",
    "allowed_gatewayids":[26],
    "late_fee":
    {
      "compounded_taxes":false,
      "days":30,
      "enabled":false,
      "first_tax_name": "HST",
      "first_tax_percent": 13,
      "repeat":false,
      "second_tax_name":null,
      "second_tax_percent":null,
      "type":"percent",
      "value":10}
      ,"late_reminders":[],
      "lines":
      [{
        "amount":
        {
          "amount":"0",
          "code":"CAD"
        },
        "description":null,
        "expenseid":null,
        "taxName1":null,
        "taxAmount1":0,
        "name":null,
        "qty":1,
        "taxName2":null,
        "taxAmount2":0,
        "type":5,
        "unit_cost":
        {
          "amount":"0",
          "code":"CAD"
        },
        "profileid":null
      }]
  }
}'
https://api.freshbooks.com/accounting/account/{{accountid}}/invoice_profiles/invoice_profiles?include[]=allowed_gateways,contacts,late_fee,late_reminders,lines,presentation,system,tracking,project_format,total_accrued_revenue&include%5B%5D=allowed_gateways,contacts,late_fee,late_reminders,lines,presentation,system,tracking,project_format,total_accrued_revenue

Postman Collection Item JSON

{
  "name": "Create Single Invoice Profile w/ Time Entry Holder ",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"invoice_profile\":\n  {\n    \"customerid\": {{customerid}},\n    \"frequency\":\"m\",\n    \"profileid\":null,\n    \"disable\":false,\n    \"due_offset_days\":30,\n    \"numberRecurring\":0,\n    \"send_email\":true,\n    \"include_unbilled_time\":true,\n    \"project_format\":\n    {\n      \"group_by\":\"service\",\n      \"method\":\"detailed\",\n      \"show_tname\":true,\n      \"show_pname\":true,\n      \"show_staff\":true,\n      \"show_date\":true,\n      \"show_notes\":true,\n      \"show_total_hours\":false\n    },\n    \"skip_generation\":false,\n    \"retainer_id\":null,\n    \"require_auto_bill\":false,\n    \"create_date\":\"2019-07-15\",\n    \"currency_code\":\"CAD\",\n    \"discount_value\":0,\n    \"template\":\"clean-grouped\",\n    \"terms\": \"Show me the money\",\n    \"allowed_gatewayids\":[26],\n    \"late_fee\":\n    {\n      \"compounded_taxes\":false,\n      \"days\":30,\n      \"enabled\":false,\n      \"first_tax_name\": \"HST\",\n      \"first_tax_percent\": 13,\n      \"repeat\":false,\n      \"second_tax_name\":null,\n      \"second_tax_percent\":null,\n      \"type\":\"percent\",\n      \"value\":10}\n      ,\"late_reminders\":[],\n      \"lines\":\n      [{\n        \"amount\":\n        {\n          \"amount\":\"0\",\n          \"code\":\"CAD\"\n        },\n        \"description\":null,\n        \"expenseid\":null,\n        \"taxName1\":null,\n        \"taxAmount1\":0,\n        \"name\":null,\n        \"qty\":1,\n        \"taxName2\":null,\n        \"taxAmount2\":0,\n        \"type\":5,\n        \"unit_cost\":\n        {\n          \"amount\":\"0\",\n          \"code\":\"CAD\"\n        },\n        \"profileid\":null\n      }]\n  }\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountid}}/invoice_profiles/invoice_profiles?include[]=allowed_gateways,contacts,late_fee,late_reminders,lines,presentation,system,tracking,project_format,total_accrued_revenue&include%5B%5D=allowed_gateways,contacts,late_fee,late_reminders,lines,presentation,system,tracking,project_format,total_accrued_revenue",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountid}}",
        "invoice_profiles",
        "invoice_profiles"
      ],
      "query": [
        {
          "key": "include[]",
          "value": "allowed_gateways,contacts,late_fee,late_reminders,lines,presentation,system,tracking,project_format,total_accrued_revenue"
        },
        {
          "key": "include%5B%5D",
          "value": "allowed_gateways,contacts,late_fee,late_reminders,lines,presentation,system,tracking,project_format,total_accrued_revenue"
        }
      ]
    },
    "description": "This will create an invoice profile that will pull unbilled time entries for your client on to the invoice that is generated"
  },
  "response": [
  ]
}