lianja / New FreshBooks / Create Single Invoice Profile
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// 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,
// "create_date": "2019-04-25",
// "frequency": "m",
// "numberRecurring": 3,
// "lines": [
// {
// "name": "Test Item",
// "qty": "1",
// "unit_cost": {
// "amount": "27.00"
// }
// }
// ]
// }
// }
loJson = createobject("CkJsonObject")
loJson.UpdateInt("invoice_profile.customerid",123)
loJson.UpdateString("invoice_profile.create_date","2019-04-25")
loJson.UpdateString("invoice_profile.frequency","m")
loJson.UpdateInt("invoice_profile.numberRecurring",3)
loJson.UpdateString("invoice_profile.lines[0].name","Test Item")
loJson.UpdateString("invoice_profile.lines[0].qty","1")
loJson.UpdateString("invoice_profile.lines[0].unit_cost.amount","27.00")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.PostJson3("https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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": "m",
// "id": 488,
// "include_unbilled_time": false,
// "language": "en",
// "lname": "one",
// "notes": "",
// "numberRecurring": 3,
// "occurrences_to_date": 0,
// "organization": "first company",
// "ownerid": 1,
// "payment_details": "",
// "po_number": null,
// "profileid": 488,
// "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:17:14",
// "vat_name": "",
// "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
lcAccounting_systemid = loJResp.StringOf("response.result.invoice_profile.accounting_systemid")
lcAddress = loJResp.StringOf("response.result.invoice_profile.address")
lcAmount = loJResp.StringOf("response.result.invoice_profile.amount.amount")
lcCode = loJResp.StringOf("response.result.invoice_profile.amount.code")
llAuto_bill = loJResp.BoolOf("response.result.invoice_profile.auto_bill")
lcBill_gateway = loJResp.StringOf("response.result.invoice_profile.bill_gateway")
lcCity = loJResp.StringOf("response.result.invoice_profile.city")
lcInvoice_profileCode = loJResp.StringOf("response.result.invoice_profile.code")
lcCountry = loJResp.StringOf("response.result.invoice_profile.country")
lcCreate_date = loJResp.StringOf("response.result.invoice_profile.create_date")
lcCurrency_code = loJResp.StringOf("response.result.invoice_profile.currency_code")
lnCustomerid = loJResp.IntOf("response.result.invoice_profile.customerid")
lcDescription = loJResp.StringOf("response.result.invoice_profile.description")
llDisable = loJResp.BoolOf("response.result.invoice_profile.disable")
lcDiscount_totalAmount = loJResp.StringOf("response.result.invoice_profile.discount_total.amount")
lcDiscount_totalCode = loJResp.StringOf("response.result.invoice_profile.discount_total.code")
lcDiscount_value = loJResp.StringOf("response.result.invoice_profile.discount_value")
lnDue_offset_days = loJResp.IntOf("response.result.invoice_profile.due_offset_days")
lcExt_archive = loJResp.StringOf("response.result.invoice_profile.ext_archive")
lcFname = loJResp.StringOf("response.result.invoice_profile.fname")
lcFrequency = loJResp.StringOf("response.result.invoice_profile.frequency")
lnId = loJResp.IntOf("response.result.invoice_profile.id")
llInclude_unbilled_time = loJResp.BoolOf("response.result.invoice_profile.include_unbilled_time")
lcLanguage = loJResp.StringOf("response.result.invoice_profile.language")
lcLname = loJResp.StringOf("response.result.invoice_profile.lname")
lcNotes = loJResp.StringOf("response.result.invoice_profile.notes")
lnNumberRecurring = loJResp.IntOf("response.result.invoice_profile.numberRecurring")
lnOccurrences_to_date = loJResp.IntOf("response.result.invoice_profile.occurrences_to_date")
lcOrganization = loJResp.StringOf("response.result.invoice_profile.organization")
lnOwnerid = loJResp.IntOf("response.result.invoice_profile.ownerid")
lcPayment_details = loJResp.StringOf("response.result.invoice_profile.payment_details")
lcPo_number = loJResp.StringOf("response.result.invoice_profile.po_number")
lnProfileid = loJResp.IntOf("response.result.invoice_profile.profileid")
lcProvince = loJResp.StringOf("response.result.invoice_profile.province")
llRequire_auto_bill = loJResp.BoolOf("response.result.invoice_profile.require_auto_bill")
lcRetainer_id = loJResp.StringOf("response.result.invoice_profile.retainer_id")
llSend_email = loJResp.BoolOf("response.result.invoice_profile.send_email")
llSend_gmail = loJResp.BoolOf("response.result.invoice_profile.send_gmail")
lcStreet = loJResp.StringOf("response.result.invoice_profile.street")
lcStreet2 = loJResp.StringOf("response.result.invoice_profile.street2")
lcTerms = loJResp.StringOf("response.result.invoice_profile.terms")
lcTotal_accrued_revenue = loJResp.StringOf("response.result.invoice_profile.total_accrued_revenue")
lcUpdated = loJResp.StringOf("response.result.invoice_profile.updated")
lcVat_name = loJResp.StringOf("response.result.invoice_profile.vat_name")
lcVat_number = loJResp.StringOf("response.result.invoice_profile.vat_number")
lnVis_state = loJResp.IntOf("response.result.invoice_profile.vis_state")
release loHttp
release loJson
release loSbResponseBody
release loJResp
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"invoice_profile": {
"customerid": {{customerId}},
"create_date": "2019-04-25",
"frequency": "m",
"numberRecurring": 3,
"lines": [
{
"name": "Test Item",
"qty": "1",
"unit_cost": {
"amount": "27.00"
}
}
]
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles
Postman Collection Item JSON
{
"name": "Create Single Invoice Profile",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody);",
"pm.environment.set(\"customerId\", jsonData.response.result.invoice_profile[0].customerid);"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"invoice_profile\": {\n \"customerid\": {{customerId}},\n \"create_date\": \"2019-04-25\",\n \"frequency\": \"m\", \n \"numberRecurring\": 3,\n \"lines\": [\n {\n \"name\": \"Test Item\",\n \"qty\": \"1\",\n \"unit_cost\": {\n \"amount\": \"27.00\"\n }\n }\n ]\n }\n }\n"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoice_profiles",
"invoice_profiles"
]
},
"description": "Creates a monthly recurring invoice that sends 3 invoices in total."
},
"response": [
{
"name": "Create Single Invoice Profile - Invalid Date",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"invoice_profile\": {\n \"customerid\": {{customerId}},\n \"create_date\": \"2019-04-20\",\n \"frequency\": \"m\", \n \"numberRecurring\": 3\n }\n }"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoice_profiles",
"invoice_profiles"
]
}
},
"status": "UNPROCESSABLE ENTITY",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGPUAQVwRRVFFBCQxXF14IUAcURFgHDw9dQBJIUU4HHwZXUAIPC1ZRWlYGUw5UAQEGHgJWAU0TUgEAAgYGU1IFCgVVU1EGAhMbAAVdRVY/"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Content-Length",
"value": "303"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:16:19 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": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"errors\": [\n {\n \"errno\": 16003,\n \"field\": \"create_date\",\n \"message\": \"'Create Date' is an invalid value: The date for a new recurring profile must be today or later.\",\n \"object\": \"invoice_profile\",\n \"value\": \"2019-04-20\"\n }\n ]\n }\n}"
},
{
"name": "Create Single Invoice Profile",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"invoice_profile\": {\n \"customerid\": {{customerId}},\n \"create_date\": \"2019-04-25\",\n \"frequency\": \"m\", \n \"numberRecurring\": 3\n }\n }"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoice_profiles",
"invoice_profiles"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGPUAQVwRRVFFBCQxXF14IUAcURFgHDw9dQBJIUU4HHwZfXAICBlRQUlMGUQtRCAgMHgJWAU0TVARRBlVWVV5VDVcEAQQGBBMbAAVdRVY/"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:17:14 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:17:14 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\": \"m\",\n \"id\": 488,\n \"include_unbilled_time\": false,\n \"language\": \"en\",\n \"lname\": \"one\",\n \"notes\": \"\",\n \"numberRecurring\": 3,\n \"occurrences_to_date\": 0,\n \"organization\": \"first company\",\n \"ownerid\": 1,\n \"payment_details\": \"\",\n \"po_number\": null,\n \"profileid\": 488,\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:17:14\",\n \"vat_name\": \"\",\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
