phpExt / New FreshBooks / Update Invoice Profile
Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new 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": {
// "frequency": "2w",
// "numberRecurring": 12
// }
// }
$json = new CkJsonObject();
$json->UpdateString('invoice_profile.frequency','2w');
$json->UpdateInt('invoice_profile.numberRecurring',12);
// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
$http->SetRequestHeader('Content-Type','application/json');
$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);
// resp is a CkHttpResponse
$resp = $http->PTextSb('PUT','https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// 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
$Accounting_systemid = $jResp->stringOf('response.result.invoice_profile.accounting_systemid');
$Address = $jResp->stringOf('response.result.invoice_profile.address');
$Amount = $jResp->stringOf('response.result.invoice_profile.amount.amount');
$Code = $jResp->stringOf('response.result.invoice_profile.amount.code');
$Auto_bill = $jResp->BoolOf('response.result.invoice_profile.auto_bill');
$Bill_gateway = $jResp->stringOf('response.result.invoice_profile.bill_gateway');
$City = $jResp->stringOf('response.result.invoice_profile.city');
$Invoice_profileCode = $jResp->stringOf('response.result.invoice_profile.code');
$Country = $jResp->stringOf('response.result.invoice_profile.country');
$Create_date = $jResp->stringOf('response.result.invoice_profile.create_date');
$Currency_code = $jResp->stringOf('response.result.invoice_profile.currency_code');
$Customerid = $jResp->IntOf('response.result.invoice_profile.customerid');
$Description = $jResp->stringOf('response.result.invoice_profile.description');
$Disable = $jResp->BoolOf('response.result.invoice_profile.disable');
$Discount_totalAmount = $jResp->stringOf('response.result.invoice_profile.discount_total.amount');
$Discount_totalCode = $jResp->stringOf('response.result.invoice_profile.discount_total.code');
$Discount_value = $jResp->stringOf('response.result.invoice_profile.discount_value');
$Due_offset_days = $jResp->IntOf('response.result.invoice_profile.due_offset_days');
$Ext_archive = $jResp->stringOf('response.result.invoice_profile.ext_archive');
$Fname = $jResp->stringOf('response.result.invoice_profile.fname');
$Frequency = $jResp->stringOf('response.result.invoice_profile.frequency');
$Id = $jResp->IntOf('response.result.invoice_profile.id');
$Include_unbilled_time = $jResp->BoolOf('response.result.invoice_profile.include_unbilled_time');
$Language = $jResp->stringOf('response.result.invoice_profile.language');
$Lname = $jResp->stringOf('response.result.invoice_profile.lname');
$Notes = $jResp->stringOf('response.result.invoice_profile.notes');
$NumberRecurring = $jResp->IntOf('response.result.invoice_profile.numberRecurring');
$Occurrences_to_date = $jResp->IntOf('response.result.invoice_profile.occurrences_to_date');
$Organization = $jResp->stringOf('response.result.invoice_profile.organization');
$Ownerid = $jResp->IntOf('response.result.invoice_profile.ownerid');
$Payment_details = $jResp->stringOf('response.result.invoice_profile.payment_details');
$Po_number = $jResp->stringOf('response.result.invoice_profile.po_number');
$Profileid = $jResp->IntOf('response.result.invoice_profile.profileid');
$Province = $jResp->stringOf('response.result.invoice_profile.province');
$Require_auto_bill = $jResp->BoolOf('response.result.invoice_profile.require_auto_bill');
$Retainer_id = $jResp->stringOf('response.result.invoice_profile.retainer_id');
$Send_email = $jResp->BoolOf('response.result.invoice_profile.send_email');
$Send_gmail = $jResp->BoolOf('response.result.invoice_profile.send_gmail');
$Street = $jResp->stringOf('response.result.invoice_profile.street');
$Street2 = $jResp->stringOf('response.result.invoice_profile.street2');
$Terms = $jResp->stringOf('response.result.invoice_profile.terms');
$Total_accrued_revenue = $jResp->stringOf('response.result.invoice_profile.total_accrued_revenue');
$Updated = $jResp->stringOf('response.result.invoice_profile.updated');
$Vat_name = $jResp->stringOf('response.result.invoice_profile.vat_name');
$Vat_number = $jResp->stringOf('response.result.invoice_profile.vat_number');
$Vis_state = $jResp->IntOf('response.result.invoice_profile.vis_state');
?>
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}"
}
]
}
