Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
sbRequestBody: TChilkatStringBuilder;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
Accounting_systemid: WideString;
Amount: WideString;
Code: WideString;
City: WideString;
Clientid: Integer;
Credit_noteCode: WideString;
Country: WideString;
Create_date: WideString;
Credit_number: WideString;
Credit_type: WideString;
Creditid: Integer;
Currency_code: WideString;
Current_organization: WideString;
Description: WideString;
Display_status: WideString;
Dispute_status: WideString;
Ext_archive: Integer;
Fname: WideString;
Id: Integer;
Language: WideString;
Last_order_status: WideString;
Lname: WideString;
Notes: WideString;
Organization: WideString;
PaidAmount: WideString;
PaidCode: WideString;
Payment_status: WideString;
Province: WideString;
Sentid: Integer;
Status: WideString;
Street: WideString;
Street2: WideString;
Template: WideString;
Terms: 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.
// {
// "credit_note": {
// "vis_state": 1
// }
// }
json := TChilkatJsonObject.Create(Self);
json.UpdateInt('credit_note.vis_state',1);
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
sbRequestBody := TChilkatStringBuilder.Create(Self);
json.EmitSb(sbRequestBody.ControlInterface);
resp := http.PTextSb('PUT','https://api.freshbooks.com/accounting/account/{{accountId}}/credit_notes/credit_notes/{{creditId}}',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": {
// "credit_note": {
// "accounting_systemid": "E86Qp",
// "amount": {
// "amount": "150.00",
// "code": "CAD"
// },
// "city": "",
// "clientid": 599843,
// "code": "",
// "country": "",
// "create_date": "2020-07-31",
// "credit_number": "0000069",
// "credit_type": "goodwill",
// "creditid": 30947,
// "currency_code": "CAD",
// "current_organization": "Squarespace",
// "description": "Goodwill Credit",
// "display_status": "created",
// "dispute_status": null,
// "ext_archive": 0,
// "fname": "",
// "id": 30947,
// "language": "en",
// "last_order_status": null,
// "lname": "",
// "notes": "Free $150 voucher",
// "organization": "Squarespace",
// "paid": {
// "amount": "150.00",
// "code": "CAD"
// },
// "payment_status": "paid",
// "province": "",
// "sentid": 1,
// "status": "created",
// "street": "",
// "street2": "",
// "template": "clean-grouped",
// "terms": "Will be applied to future invoice",
// "vat_name": "",
// "vat_number": "",
// "vis_state": 1
// }
// }
// }
// }
// 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.credit_note.accounting_systemid');
Amount := jResp.StringOf('response.result.credit_note.amount.amount');
Code := jResp.StringOf('response.result.credit_note.amount.code');
City := jResp.StringOf('response.result.credit_note.city');
Clientid := jResp.IntOf('response.result.credit_note.clientid');
Credit_noteCode := jResp.StringOf('response.result.credit_note.code');
Country := jResp.StringOf('response.result.credit_note.country');
Create_date := jResp.StringOf('response.result.credit_note.create_date');
Credit_number := jResp.StringOf('response.result.credit_note.credit_number');
Credit_type := jResp.StringOf('response.result.credit_note.credit_type');
Creditid := jResp.IntOf('response.result.credit_note.creditid');
Currency_code := jResp.StringOf('response.result.credit_note.currency_code');
Current_organization := jResp.StringOf('response.result.credit_note.current_organization');
Description := jResp.StringOf('response.result.credit_note.description');
Display_status := jResp.StringOf('response.result.credit_note.display_status');
Dispute_status := jResp.StringOf('response.result.credit_note.dispute_status');
Ext_archive := jResp.IntOf('response.result.credit_note.ext_archive');
Fname := jResp.StringOf('response.result.credit_note.fname');
Id := jResp.IntOf('response.result.credit_note.id');
Language := jResp.StringOf('response.result.credit_note.language');
Last_order_status := jResp.StringOf('response.result.credit_note.last_order_status');
Lname := jResp.StringOf('response.result.credit_note.lname');
Notes := jResp.StringOf('response.result.credit_note.notes');
Organization := jResp.StringOf('response.result.credit_note.organization');
PaidAmount := jResp.StringOf('response.result.credit_note.paid.amount');
PaidCode := jResp.StringOf('response.result.credit_note.paid.code');
Payment_status := jResp.StringOf('response.result.credit_note.payment_status');
Province := jResp.StringOf('response.result.credit_note.province');
Sentid := jResp.IntOf('response.result.credit_note.sentid');
Status := jResp.StringOf('response.result.credit_note.status');
Street := jResp.StringOf('response.result.credit_note.street');
Street2 := jResp.StringOf('response.result.credit_note.street2');
Template := jResp.StringOf('response.result.credit_note.template');
Terms := jResp.StringOf('response.result.credit_note.terms');
Vat_name := jResp.StringOf('response.result.credit_note.vat_name');
Vat_number := jResp.StringOf('response.result.credit_note.vat_number');
Vis_state := jResp.IntOf('response.result.credit_note.vis_state');
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"credit_note": {
"vis_state": 1
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/credit_notes/credit_notes/{{creditId}}
Postman Collection Item JSON
{
"name": "Delete Credit",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"credit_note\": {\n \"vis_state\": 1\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/credit_notes/credit_notes/{{creditId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"credit_notes",
"credit_notes",
"{{creditId}}"
]
}
},
"response": [
{
"name": "Delete Credit",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"credit_note\": {\n \"vis_state\": 1\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/credit_notes/credit_notes/{{creditId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"credit_notes",
"credit_notes",
"{{creditId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Date",
"value": "Fri, 11 Sep 2020 14:41:22 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gHQ1NXCxI8DF8WXRECW0ZXVwxND14VVkBIBhtRSFALCwZUV1ECBgJRUAUAAVtKV1ccQAAGDlsEBVYECwAGAAsBUwYVTQACVEBVOQ=="
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Content-Security-Policy",
"value": "default-src 'self'"
},
{
"key": "X-Content-Security-Policy",
"value": "default-src 'self'"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31556926; includeSubDomains; preload"
},
{
"key": "Referrer-Policy",
"value": "strict-origin-when-cross-origin"
},
{
"key": "X-RateLimit-Limit",
"value": "600"
},
{
"key": "X-RateLimit-Remaining",
"value": "595"
},
{
"key": "X-RateLimit-Reset",
"value": "1599835343"
},
{
"key": "Retry-After",
"value": "60"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Alt-Svc",
"value": "h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"result\": {\n \"credit_note\": {\n \"accounting_systemid\": \"E86Qp\",\n \"amount\": {\n \"amount\": \"150.00\",\n \"code\": \"CAD\"\n },\n \"city\": \"\",\n \"clientid\": 599843,\n \"code\": \"\",\n \"country\": \"\",\n \"create_date\": \"2020-07-31\",\n \"credit_number\": \"0000069\",\n \"credit_type\": \"goodwill\",\n \"creditid\": 30947,\n \"currency_code\": \"CAD\",\n \"current_organization\": \"Squarespace\",\n \"description\": \"Goodwill Credit\",\n \"display_status\": \"created\",\n \"dispute_status\": null,\n \"ext_archive\": 0,\n \"fname\": \"\",\n \"id\": 30947,\n \"language\": \"en\",\n \"last_order_status\": null,\n \"lname\": \"\",\n \"notes\": \"Free $150 voucher\",\n \"organization\": \"Squarespace\",\n \"paid\": {\n \"amount\": \"150.00\",\n \"code\": \"CAD\"\n },\n \"payment_status\": \"paid\",\n \"province\": \"\",\n \"sentid\": 1,\n \"status\": \"created\",\n \"street\": \"\",\n \"street2\": \"\",\n \"template\": \"clean-grouped\",\n \"terms\": \"Will be applied to future invoice\",\n \"vat_name\": \"\",\n \"vat_number\": \"\",\n \"vis_state\": 1\n }\n }\n }\n}"
}
]
}
