delphiAx / New FreshBooks / Update Estimate
Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
sbRequestBody: TChilkatStringBuilder;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
Accepted: Integer;
Accounting_systemid: WideString;
Address: WideString;
Amount: WideString;
Code: WideString;
City: WideString;
EstimateCode: WideString;
Country: WideString;
Create_date: WideString;
Created_at: WideString;
Currency_code: WideString;
Current_organization: WideString;
Customerid: Integer;
Description: WideString;
Discount_totalAmount: WideString;
Discount_totalCode: WideString;
Discount_value: WideString;
Display_status: WideString;
Estimate_number: WideString;
Estimateid: Integer;
Ext_archive: Integer;
Fname: WideString;
Id: Integer;
Invoiced: Integer;
Language: WideString;
Lname: WideString;
Notes: WideString;
Organization: WideString;
Ownerid: Integer;
Po_number: WideString;
Province: WideString;
Reply_status: WideString;
Require_client_signature: Integer;
Rich_proposal: Integer;
Sentid: Integer;
Status: Integer;
Street: WideString;
Street2: WideString;
Template: WideString;
Terms: WideString;
Ui_status: WideString;
Updated: WideString;
Vat_name: WideString;
Vat_number: WideString;
Vis_state: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := TChilkatHttp.Create(Self);
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "estimate": {
// "customerid": 123,
// "create_date": "2019-04-20"
// }
// }
json := TChilkatJsonObject.Create(Self);
json.UpdateInt('estimate.customerid',123);
json.UpdateString('estimate.create_date','2019-04-20');
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
http.SetRequestHeader('Content-Type','application/json');
sbRequestBody := TChilkatStringBuilder.Create(Self);
json.EmitSb(sbRequestBody.ControlInterface);
resp := http.PTextSb('PUT','https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}',sbRequestBody.ControlInterface,'utf-8','application/json',0,0);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "estimate": {
// "accepted": false,
// "accounting_systemid": "wkMd2g",
// "address": "",
// "amount": {
// "amount": "17628.00",
// "code": "USD"
// },
// "city": "",
// "code": "",
// "country": "Canada",
// "create_date": "2019-04-18",
// "created_at": "2019-04-18 09:42:52",
// "currency_code": "USD",
// "current_organization": "first company",
// "customerid": 31006,
// "description": "it's a computer hardware version 1",
// "discount_total": {
// "amount": "0.00",
// "code": "USD"
// },
// "discount_value": "0",
// "display_status": "draft",
// "estimate_number": "0000001",
// "estimateid": 1706,
// "ext_archive": 0,
// "fname": "Client",
// "id": 1706,
// "invoiced": false,
// "language": "en",
// "lname": "one",
// "notes": "This is an estimate for the computer",
// "organization": "first company",
// "ownerid": 1,
// "po_number": null,
// "province": "",
// "reply_status": null,
// "require_client_signature": false,
// "rich_proposal": false,
// "sentid": 1,
// "status": 1,
// "street": "",
// "street2": "",
// "template": "clean-grouped",
// "terms": "50% deposit upon acceptance, 50% on delivery of the computers.",
// "ui_status": "draft",
// "updated": "2019-04-18 09:42:52",
// "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
Accepted := jResp.BoolOf('response.result.estimate.accepted');
Accounting_systemid := jResp.StringOf('response.result.estimate.accounting_systemid');
Address := jResp.StringOf('response.result.estimate.address');
Amount := jResp.StringOf('response.result.estimate.amount.amount');
Code := jResp.StringOf('response.result.estimate.amount.code');
City := jResp.StringOf('response.result.estimate.city');
EstimateCode := jResp.StringOf('response.result.estimate.code');
Country := jResp.StringOf('response.result.estimate.country');
Create_date := jResp.StringOf('response.result.estimate.create_date');
Created_at := jResp.StringOf('response.result.estimate.created_at');
Currency_code := jResp.StringOf('response.result.estimate.currency_code');
Current_organization := jResp.StringOf('response.result.estimate.current_organization');
Customerid := jResp.IntOf('response.result.estimate.customerid');
Description := jResp.StringOf('response.result.estimate.description');
Discount_totalAmount := jResp.StringOf('response.result.estimate.discount_total.amount');
Discount_totalCode := jResp.StringOf('response.result.estimate.discount_total.code');
Discount_value := jResp.StringOf('response.result.estimate.discount_value');
Display_status := jResp.StringOf('response.result.estimate.display_status');
Estimate_number := jResp.StringOf('response.result.estimate.estimate_number');
Estimateid := jResp.IntOf('response.result.estimate.estimateid');
Ext_archive := jResp.IntOf('response.result.estimate.ext_archive');
Fname := jResp.StringOf('response.result.estimate.fname');
Id := jResp.IntOf('response.result.estimate.id');
Invoiced := jResp.BoolOf('response.result.estimate.invoiced');
Language := jResp.StringOf('response.result.estimate.language');
Lname := jResp.StringOf('response.result.estimate.lname');
Notes := jResp.StringOf('response.result.estimate.notes');
Organization := jResp.StringOf('response.result.estimate.organization');
Ownerid := jResp.IntOf('response.result.estimate.ownerid');
Po_number := jResp.StringOf('response.result.estimate.po_number');
Province := jResp.StringOf('response.result.estimate.province');
Reply_status := jResp.StringOf('response.result.estimate.reply_status');
Require_client_signature := jResp.BoolOf('response.result.estimate.require_client_signature');
Rich_proposal := jResp.BoolOf('response.result.estimate.rich_proposal');
Sentid := jResp.IntOf('response.result.estimate.sentid');
Status := jResp.IntOf('response.result.estimate.status');
Street := jResp.StringOf('response.result.estimate.street');
Street2 := jResp.StringOf('response.result.estimate.street2');
Template := jResp.StringOf('response.result.estimate.template');
Terms := jResp.StringOf('response.result.estimate.terms');
Ui_status := jResp.StringOf('response.result.estimate.ui_status');
Updated := jResp.StringOf('response.result.estimate.updated');
Vat_name := jResp.StringOf('response.result.estimate.vat_name');
Vat_number := jResp.StringOf('response.result.estimate.vat_number');
Vis_state := jResp.IntOf('response.result.estimate.vis_state');
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"estimate": {
"customerid": {{customerId}},
"create_date": "2019-04-20"
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}
Postman Collection Item JSON
{
"name": "Update Estimate",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"estimate\": {\n \"customerid\": {{customerId}},\n \"create_date\": \"2019-04-20\"\n }\n}"
},
"url": {
"raw": "api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"estimates",
"estimates",
"{{estimateId}}"
]
},
"description": "Updating an estimate with a 30% discount. "
},
"response": [
{
"name": "Update Estimate",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"estimate\": {\n \"customerid\": {{customerId}},\n \"create_date\": \"2019-04-20\"\n }\n}"
},
"url": {
"raw": "api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"estimates",
"estimates",
"{{estimateId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBQkJaDwcXB0NYXRFMUVlTRwAbTQFNA0xVBQ5UUlIJBwlVUlsDAQNVSBwHH0AHVQBTVlxbC1kAAAIGWwMJQx8EBVpEBDs="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:00:32 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": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Age",
"value": "0"
},
{
"key": "Age",
"value": "0"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:00:32 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 \"estimate\": {\n \"accepted\": false,\n \"accounting_systemid\": \"wkMd2g\",\n \"address\": \"\",\n \"amount\": {\n \"amount\": \"17628.00\",\n \"code\": \"USD\"\n },\n \"city\": \"\",\n \"code\": \"\",\n \"country\": \"Canada\",\n \"create_date\": \"2019-04-18\",\n \"created_at\": \"2019-04-18 09:42:52\",\n \"currency_code\": \"USD\",\n \"current_organization\": \"first company\",\n \"customerid\": 31006,\n \"description\": \"it's a computer hardware version 1\",\n \"discount_total\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"discount_value\": \"0\",\n \"display_status\": \"draft\",\n \"estimate_number\": \"0000001\",\n \"estimateid\": 1706,\n \"ext_archive\": 0,\n \"fname\": \"Client\",\n \"id\": 1706,\n \"invoiced\": false,\n \"language\": \"en\",\n \"lname\": \"one\",\n \"notes\": \"This is an estimate for the computer\",\n \"organization\": \"first company\",\n \"ownerid\": 1,\n \"po_number\": null,\n \"province\": \"\",\n \"reply_status\": null,\n \"require_client_signature\": false,\n \"rich_proposal\": false,\n \"sentid\": 1,\n \"status\": 1,\n \"street\": \"\",\n \"street2\": \"\",\n \"template\": \"clean-grouped\",\n \"terms\": \"50% deposit upon acceptance, 50% on delivery of the computers.\",\n \"ui_status\": \"draft\",\n \"updated\": \"2019-04-18 09:42:52\",\n \"vat_name\": null,\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
