Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Account_number: PWideChar;
City: PWideChar;
Country: PWideChar;
Created_at: PWideChar;
Currency_code: PWideChar;
Is_1099: Boolean;
Language: PWideChar;
Phone: PWideChar;
Postal_code: PWideChar;
Primary_contact_email: PWideChar;
Primary_contact_first_name: PWideChar;
Primary_contact_last_name: PWideChar;
Province: PWideChar;
Street: PWideChar;
Street2: PWideChar;
Updated_at: PWideChar;
Vendor_name: PWideChar;
Vendorid: Integer;
Vis_state: Integer;
Website: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "bill_vendor": {
// "vis_state": 1
// }
// }
json := CkJsonObject_Create();
CkJsonObject_UpdateInt(json,'bill_vendor.vis_state',1);
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
resp := CkHttp_PTextSb(http,'PUT','https://api.freshbooks.com/accounting/account/{{accountId}}/bill_vendors/bill_vendors/{{vendorId}}',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "bill_vendor": {
// "account_number": "23479",
// "city": "Palo Alto",
// "country": "United States",
// "created_at": "2020-10-09 15:50:10",
// "currency_code": "USD",
// "is_1099": false,
// "language": "en",
// "outstanding_balance": [
// ],
// "overdue_balance": [
// ],
// "phone": "4158331869",
// "postal_code": null,
// "primary_contact_email": "dmiller@apple.com",
// "primary_contact_first_name": "Dorothy",
// "primary_contact_last_name": "Miller",
// "province": "California",
// "street": "1 Infinite Loop",
// "street2": null,
// "tax_defaults": [
// ],
// "updated_at": "2020-10-09 15:52:30",
// "vendor_name": "Apple",
// "vendorid": 7,
// "vis_state": 1,
// "website": "apple.com"
// }
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Account_number := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.account_number');
City := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.city');
Country := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.country');
Created_at := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.created_at');
Currency_code := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.currency_code');
Is_1099 := CkJsonObject_BoolOf(jResp,'response.result.bill_vendor.is_1099');
Language := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.language');
Phone := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.phone');
Postal_code := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.postal_code');
Primary_contact_email := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.primary_contact_email');
Primary_contact_first_name := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.primary_contact_first_name');
Primary_contact_last_name := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.primary_contact_last_name');
Province := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.province');
Street := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.street');
Street2 := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.street2');
Updated_at := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.updated_at');
Vendor_name := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.vendor_name');
Vendorid := CkJsonObject_IntOf(jResp,'response.result.bill_vendor.vendorid');
Vis_state := CkJsonObject_IntOf(jResp,'response.result.bill_vendor.vis_state');
Website := CkJsonObject__stringOf(jResp,'response.result.bill_vendor.website');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'response.result.bill_vendor.outstanding_balance');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'response.result.bill_vendor.overdue_balance');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'response.result.bill_vendor.tax_defaults');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"bill_vendor": {
"vis_state": 1
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/bill_vendors/bill_vendors/{{vendorId}}
Postman Collection Item JSON
{
"name": "Delete Vendor",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"bill_vendor\": {\n \"vis_state\": 1\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/bill_vendors/bill_vendors/{{vendorId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"bill_vendors",
"bill_vendors",
"{{vendorId}}"
]
}
},
"response": [
{
"name": "Delete Vendor",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"bill_vendor\": {\n \"vis_state\": 1\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/bill_vendors/bill_vendors/{{vendorId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"bill_vendors",
"bill_vendors",
"{{vendorId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Date",
"value": "Fri, 09 Oct 2020 15:52:29 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gGWFpfPRAGDFQNShECWl1eXxNcD1UOQUBIBhtRSFUJBQFWUlMOCANQVgkPA1RKVlEcQAFWWQhVAwIAW1hSUgJRUg8VTQACVEBVOQ=="
},
{
"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": "599"
},
{
"key": "X-RateLimit-Reset",
"value": "1602258810"
},
{
"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 \"bill_vendor\": {\n \"account_number\": \"23479\",\n \"city\": \"Palo Alto\",\n \"country\": \"United States\",\n \"created_at\": \"2020-10-09 15:50:10\",\n \"currency_code\": \"USD\",\n \"is_1099\": false,\n \"language\": \"en\",\n \"outstanding_balance\": [],\n \"overdue_balance\": [],\n \"phone\": \"4158331869\",\n \"postal_code\": null,\n \"primary_contact_email\": \"dmiller@apple.com\",\n \"primary_contact_first_name\": \"Dorothy\",\n \"primary_contact_last_name\": \"Miller\",\n \"province\": \"California\",\n \"street\": \"1 Infinite Loop\",\n \"street2\": null,\n \"tax_defaults\": [],\n \"updated_at\": \"2020-10-09 15:52:30\",\n \"vendor_name\": \"Apple\",\n \"vendorid\": 7,\n \"vis_state\": 1,\n \"website\": \"apple.com\"\n }\n }\n }\n}"
}
]
}
