PowerBuilder / New FreshBooks / Create Single Invoice Profile
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Accounting_systemid
string ls_Address
string ls_Amount
string ls_Code
integer li_Auto_bill
string ls_Bill_gateway
string ls_City
string ls_Invoice_profileCode
string ls_Country
string ls_Create_date
string ls_Currency_code
integer li_Customerid
string ls_Description
integer li_Disable
string ls_Discount_totalAmount
string ls_Discount_totalCode
string ls_Discount_value
integer li_Due_offset_days
string ls_Ext_archive
string ls_Fname
string ls_Frequency
integer li_Id
integer li_Include_unbilled_time
string ls_Language
string ls_Lname
string ls_Notes
integer li_NumberRecurring
integer li_Occurrences_to_date
string ls_Organization
integer li_Ownerid
string ls_Payment_details
string ls_Po_number
integer li_Profileid
string ls_Province
integer li_Require_auto_bill
string ls_Retainer_id
integer li_Send_email
integer li_Send_gmail
string ls_Street
string ls_Street2
string ls_Terms
string ls_Total_accrued_revenue
string ls_Updated
string ls_Vat_name
string ls_Vat_number
integer li_Vis_state
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// 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"
// }
// }
// ]
// }
// }
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_Json.UpdateInt("invoice_profile.customerid",123)
loo_Json.UpdateString("invoice_profile.create_date","2019-04-25")
loo_Json.UpdateString("invoice_profile.frequency","m")
loo_Json.UpdateInt("invoice_profile.numberRecurring",3)
loo_Json.UpdateString("invoice_profile.lines[0].name","Test Item")
loo_Json.UpdateString("invoice_profile.lines[0].qty","1")
loo_Json.UpdateString("invoice_profile.lines[0].unit_cost.amount","27.00")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Resp = loo_Http.PostJson3("https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// 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
ls_Accounting_systemid = loo_JResp.StringOf("response.result.invoice_profile.accounting_systemid")
ls_Address = loo_JResp.StringOf("response.result.invoice_profile.address")
ls_Amount = loo_JResp.StringOf("response.result.invoice_profile.amount.amount")
ls_Code = loo_JResp.StringOf("response.result.invoice_profile.amount.code")
li_Auto_bill = loo_JResp.BoolOf("response.result.invoice_profile.auto_bill")
ls_Bill_gateway = loo_JResp.StringOf("response.result.invoice_profile.bill_gateway")
ls_City = loo_JResp.StringOf("response.result.invoice_profile.city")
ls_Invoice_profileCode = loo_JResp.StringOf("response.result.invoice_profile.code")
ls_Country = loo_JResp.StringOf("response.result.invoice_profile.country")
ls_Create_date = loo_JResp.StringOf("response.result.invoice_profile.create_date")
ls_Currency_code = loo_JResp.StringOf("response.result.invoice_profile.currency_code")
li_Customerid = loo_JResp.IntOf("response.result.invoice_profile.customerid")
ls_Description = loo_JResp.StringOf("response.result.invoice_profile.description")
li_Disable = loo_JResp.BoolOf("response.result.invoice_profile.disable")
ls_Discount_totalAmount = loo_JResp.StringOf("response.result.invoice_profile.discount_total.amount")
ls_Discount_totalCode = loo_JResp.StringOf("response.result.invoice_profile.discount_total.code")
ls_Discount_value = loo_JResp.StringOf("response.result.invoice_profile.discount_value")
li_Due_offset_days = loo_JResp.IntOf("response.result.invoice_profile.due_offset_days")
ls_Ext_archive = loo_JResp.StringOf("response.result.invoice_profile.ext_archive")
ls_Fname = loo_JResp.StringOf("response.result.invoice_profile.fname")
ls_Frequency = loo_JResp.StringOf("response.result.invoice_profile.frequency")
li_Id = loo_JResp.IntOf("response.result.invoice_profile.id")
li_Include_unbilled_time = loo_JResp.BoolOf("response.result.invoice_profile.include_unbilled_time")
ls_Language = loo_JResp.StringOf("response.result.invoice_profile.language")
ls_Lname = loo_JResp.StringOf("response.result.invoice_profile.lname")
ls_Notes = loo_JResp.StringOf("response.result.invoice_profile.notes")
li_NumberRecurring = loo_JResp.IntOf("response.result.invoice_profile.numberRecurring")
li_Occurrences_to_date = loo_JResp.IntOf("response.result.invoice_profile.occurrences_to_date")
ls_Organization = loo_JResp.StringOf("response.result.invoice_profile.organization")
li_Ownerid = loo_JResp.IntOf("response.result.invoice_profile.ownerid")
ls_Payment_details = loo_JResp.StringOf("response.result.invoice_profile.payment_details")
ls_Po_number = loo_JResp.StringOf("response.result.invoice_profile.po_number")
li_Profileid = loo_JResp.IntOf("response.result.invoice_profile.profileid")
ls_Province = loo_JResp.StringOf("response.result.invoice_profile.province")
li_Require_auto_bill = loo_JResp.BoolOf("response.result.invoice_profile.require_auto_bill")
ls_Retainer_id = loo_JResp.StringOf("response.result.invoice_profile.retainer_id")
li_Send_email = loo_JResp.BoolOf("response.result.invoice_profile.send_email")
li_Send_gmail = loo_JResp.BoolOf("response.result.invoice_profile.send_gmail")
ls_Street = loo_JResp.StringOf("response.result.invoice_profile.street")
ls_Street2 = loo_JResp.StringOf("response.result.invoice_profile.street2")
ls_Terms = loo_JResp.StringOf("response.result.invoice_profile.terms")
ls_Total_accrued_revenue = loo_JResp.StringOf("response.result.invoice_profile.total_accrued_revenue")
ls_Updated = loo_JResp.StringOf("response.result.invoice_profile.updated")
ls_Vat_name = loo_JResp.StringOf("response.result.invoice_profile.vat_name")
ls_Vat_number = loo_JResp.StringOf("response.result.invoice_profile.vat_number")
li_Vis_state = loo_JResp.IntOf("response.result.invoice_profile.vis_state")
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
