Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
// 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": {
// "vis_state": 1
// }
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateInt: @"bill.vis_state" value: [NSNumber numberWithInt: 1]];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];
CkoHttpResponse *resp = [http PTextSb: @"PUT" url: @"https://api.freshbooks.com/accounting/account/{{accountId}}/bills/bills/{{billId}}" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "bill": {
// "amount": {
// "amount": "5.00",
// "code": "CAD"
// },
// "attachment": null,
// "bill_number": null,
// "bill_payments": [
// ],
// "created_at": "2020-10-07 21:33:27",
// "currency_code": "CAD",
// "due_date": "2020-11-06",
// "due_offset_days": 30,
// "id": 3,
// "issue_date": "2020-10-07",
// "language": "en",
// "lines": [
// {
// "amount": {
// "amount": "5.00",
// "code": "CAD"
// },
// "category": {
// "category": "Advertising",
// "categoryid": 65688,
// "created_at": "2016-11-17 14:22:35",
// "id": 65688,
// "is_cogs": true,
// "is_editable": false,
// "parentid": null,
// "updated_at": "2020-08-14 12:52:33",
// "vis_state": 0
// },
// "description": "Food",
// "id": 5,
// "list_index": 1,
// "quantity": "1",
// "tax_amount1": null,
// "tax_amount2": null,
// "tax_authorityid1": null,
// "tax_authorityid2": null,
// "tax_name1": null,
// "tax_name2": null,
// "tax_percent1": null,
// "tax_percent2": null,
// "total_amount": {
// "amount": "5.00",
// "code": "CAD"
// },
// "unit_cost": {
// "amount": "5.00",
// "code": "CAD"
// }
// },
// {
// "amount": {
// "amount": "0.00",
// "code": "CAD"
// },
// "category": {
// "category": "Advertising",
// "categoryid": 65688,
// "created_at": "2016-11-17 14:22:35",
// "id": 65688,
// "is_cogs": true,
// "is_editable": false,
// "parentid": null,
// "updated_at": "2020-08-14 12:52:33",
// "vis_state": 0
// },
// "description": null,
// "id": 7,
// "list_index": 2,
// "quantity": "1",
// "tax_amount1": null,
// "tax_amount2": null,
// "tax_authorityid1": null,
// "tax_authorityid2": null,
// "tax_name1": null,
// "tax_name2": null,
// "tax_percent1": null,
// "tax_percent2": null,
// "total_amount": {
// "amount": "0.00",
// "code": "CAD"
// },
// "unit_cost": {
// "amount": "0.00",
// "code": "CAD"
// }
// }
// ],
// "outstanding": {
// "amount": "5.00",
// "code": "CAD"
// },
// "overall_category": "Advertising",
// "overall_description": "Food",
// "paid": {
// "amount": "0.00",
// "code": "CAD"
// },
// "status": "unpaid",
// "tax_amount": {
// "amount": "0.00",
// "code": "CAD"
// },
// "total_amount": {
// "amount": "5.00",
// "code": "CAD"
// },
// "updated_at": "2020-10-09 15:41:35",
// "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
NSString *amountAmount = 0;
NSString *amountCode = 0;
NSString *Category = 0;
int Categoryid;
NSString *categoryCreated_at = 0;
int categoryId;
BOOL Is_cogs;
BOOL Is_editable;
NSString *Parentid = 0;
NSString *categoryUpdated_at = 0;
int categoryVis_state;
NSString *description = 0;
int id;
int list_index;
NSString *quantity = 0;
NSString *tax_amount1 = 0;
NSString *tax_amount2 = 0;
NSString *tax_authorityid1 = 0;
NSString *tax_authorityid2 = 0;
NSString *tax_name1 = 0;
NSString *tax_name2 = 0;
NSString *tax_percent1 = 0;
NSString *tax_percent2 = 0;
NSString *total_amountAmount = 0;
NSString *total_amountCode = 0;
NSString *unit_costAmount = 0;
NSString *unit_costCode = 0;
NSString *Amount = [jResp StringOf: @"response.result.bill.amount.amount"];
NSString *Code = [jResp StringOf: @"response.result.bill.amount.code"];
NSString *Attachment = [jResp StringOf: @"response.result.bill.attachment"];
NSString *Bill_number = [jResp StringOf: @"response.result.bill.bill_number"];
NSString *Created_at = [jResp StringOf: @"response.result.bill.created_at"];
NSString *Currency_code = [jResp StringOf: @"response.result.bill.currency_code"];
NSString *Due_date = [jResp StringOf: @"response.result.bill.due_date"];
int Due_offset_days = [[jResp IntOf: @"response.result.bill.due_offset_days"] intValue];
int Id = [[jResp IntOf: @"response.result.bill.id"] intValue];
NSString *Issue_date = [jResp StringOf: @"response.result.bill.issue_date"];
NSString *Language = [jResp StringOf: @"response.result.bill.language"];
NSString *OutstandingAmount = [jResp StringOf: @"response.result.bill.outstanding.amount"];
NSString *OutstandingCode = [jResp StringOf: @"response.result.bill.outstanding.code"];
NSString *Overall_category = [jResp StringOf: @"response.result.bill.overall_category"];
NSString *Overall_description = [jResp StringOf: @"response.result.bill.overall_description"];
NSString *PaidAmount = [jResp StringOf: @"response.result.bill.paid.amount"];
NSString *PaidCode = [jResp StringOf: @"response.result.bill.paid.code"];
NSString *Status = [jResp StringOf: @"response.result.bill.status"];
NSString *Tax_amountAmount = [jResp StringOf: @"response.result.bill.tax_amount.amount"];
NSString *Tax_amountCode = [jResp StringOf: @"response.result.bill.tax_amount.code"];
NSString *Total_amountAmount = [jResp StringOf: @"response.result.bill.total_amount.amount"];
NSString *Total_amountCode = [jResp StringOf: @"response.result.bill.total_amount.code"];
NSString *Updated_at = [jResp StringOf: @"response.result.bill.updated_at"];
int Vis_state = [[jResp IntOf: @"response.result.bill.vis_state"] intValue];
int i = 0;
int count_i = [[jResp SizeOfArray: @"response.result.bill.bill_payments"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
i = i + 1;
}
i = 0;
count_i = [[jResp SizeOfArray: @"response.result.bill.lines"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
amountAmount = [jResp StringOf: @"response.result.bill.lines[i].amount.amount"];
amountCode = [jResp StringOf: @"response.result.bill.lines[i].amount.code"];
Category = [jResp StringOf: @"response.result.bill.lines[i].category.category"];
Categoryid = [[jResp IntOf: @"response.result.bill.lines[i].category.categoryid"] intValue];
categoryCreated_at = [jResp StringOf: @"response.result.bill.lines[i].category.created_at"];
categoryId = [[jResp IntOf: @"response.result.bill.lines[i].category.id"] intValue];
Is_cogs = [jResp BoolOf: @"response.result.bill.lines[i].category.is_cogs"];
Is_editable = [jResp BoolOf: @"response.result.bill.lines[i].category.is_editable"];
Parentid = [jResp StringOf: @"response.result.bill.lines[i].category.parentid"];
categoryUpdated_at = [jResp StringOf: @"response.result.bill.lines[i].category.updated_at"];
categoryVis_state = [[jResp IntOf: @"response.result.bill.lines[i].category.vis_state"] intValue];
description = [jResp StringOf: @"response.result.bill.lines[i].description"];
id = [[jResp IntOf: @"response.result.bill.lines[i].id"] intValue];
list_index = [[jResp IntOf: @"response.result.bill.lines[i].list_index"] intValue];
quantity = [jResp StringOf: @"response.result.bill.lines[i].quantity"];
tax_amount1 = [jResp StringOf: @"response.result.bill.lines[i].tax_amount1"];
tax_amount2 = [jResp StringOf: @"response.result.bill.lines[i].tax_amount2"];
tax_authorityid1 = [jResp StringOf: @"response.result.bill.lines[i].tax_authorityid1"];
tax_authorityid2 = [jResp StringOf: @"response.result.bill.lines[i].tax_authorityid2"];
tax_name1 = [jResp StringOf: @"response.result.bill.lines[i].tax_name1"];
tax_name2 = [jResp StringOf: @"response.result.bill.lines[i].tax_name2"];
tax_percent1 = [jResp StringOf: @"response.result.bill.lines[i].tax_percent1"];
tax_percent2 = [jResp StringOf: @"response.result.bill.lines[i].tax_percent2"];
total_amountAmount = [jResp StringOf: @"response.result.bill.lines[i].total_amount.amount"];
total_amountCode = [jResp StringOf: @"response.result.bill.lines[i].total_amount.code"];
unit_costAmount = [jResp StringOf: @"response.result.bill.lines[i].unit_cost.amount"];
unit_costCode = [jResp StringOf: @"response.result.bill.lines[i].unit_cost.code"];
i = i + 1;
}
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"bill": {
"vis_state": 1
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/bills/bills/{{billId}}
Postman Collection Item JSON
{
"name": "Delete Bill",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"bill\": {\n \"vis_state\": 1\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/bills/bills/{{billId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"bills",
"bills",
"{{billId}}"
]
}
},
"response": [
{
"name": "Delete Bill",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"bill\": {\n \"vis_state\": 1\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/bills/bills/{{billId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"bills",
"bills",
"{{billId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Date",
"value": "Fri, 09 Oct 2020 15:41:35 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gGWFpfEVwBC1wOGk4IFAQcAFEJUQRSA1pVAwZTUlYJAgdIVVQbEwRfUAMGBgRUWlAIUwBQXAAWHlUEVRJUPA=="
},
{
"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": "1602258156"
},
{
"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\": {\n \"amount\": {\n \"amount\": \"5.00\",\n \"code\": \"CAD\"\n },\n \"attachment\": null,\n \"bill_number\": null,\n \"bill_payments\": [],\n \"created_at\": \"2020-10-07 21:33:27\",\n \"currency_code\": \"CAD\",\n \"due_date\": \"2020-11-06\",\n \"due_offset_days\": 30,\n \"id\": 3,\n \"issue_date\": \"2020-10-07\",\n \"language\": \"en\",\n \"lines\": [\n {\n \"amount\": {\n \"amount\": \"5.00\",\n \"code\": \"CAD\"\n },\n \"category\": {\n \"category\": \"Advertising\",\n \"categoryid\": 65688,\n \"created_at\": \"2016-11-17 14:22:35\",\n \"id\": 65688,\n \"is_cogs\": true,\n \"is_editable\": false,\n \"parentid\": null,\n \"updated_at\": \"2020-08-14 12:52:33\",\n \"vis_state\": 0\n },\n \"description\": \"Food\",\n \"id\": 5,\n \"list_index\": 1,\n \"quantity\": \"1\",\n \"tax_amount1\": null,\n \"tax_amount2\": null,\n \"tax_authorityid1\": null,\n \"tax_authorityid2\": null,\n \"tax_name1\": null,\n \"tax_name2\": null,\n \"tax_percent1\": null,\n \"tax_percent2\": null,\n \"total_amount\": {\n \"amount\": \"5.00\",\n \"code\": \"CAD\"\n },\n \"unit_cost\": {\n \"amount\": \"5.00\",\n \"code\": \"CAD\"\n }\n },\n {\n \"amount\": {\n \"amount\": \"0.00\",\n \"code\": \"CAD\"\n },\n \"category\": {\n \"category\": \"Advertising\",\n \"categoryid\": 65688,\n \"created_at\": \"2016-11-17 14:22:35\",\n \"id\": 65688,\n \"is_cogs\": true,\n \"is_editable\": false,\n \"parentid\": null,\n \"updated_at\": \"2020-08-14 12:52:33\",\n \"vis_state\": 0\n },\n \"description\": null,\n \"id\": 7,\n \"list_index\": 2,\n \"quantity\": \"1\",\n \"tax_amount1\": null,\n \"tax_amount2\": null,\n \"tax_authorityid1\": null,\n \"tax_authorityid2\": null,\n \"tax_name1\": null,\n \"tax_name2\": null,\n \"tax_percent1\": null,\n \"tax_percent2\": null,\n \"total_amount\": {\n \"amount\": \"0.00\",\n \"code\": \"CAD\"\n },\n \"unit_cost\": {\n \"amount\": \"0.00\",\n \"code\": \"CAD\"\n }\n }\n ],\n \"outstanding\": {\n \"amount\": \"5.00\",\n \"code\": \"CAD\"\n },\n \"overall_category\": \"Advertising\",\n \"overall_description\": \"Food\",\n \"paid\": {\n \"amount\": \"0.00\",\n \"code\": \"CAD\"\n },\n \"status\": \"unpaid\",\n \"tax_amount\": {\n \"amount\": \"0.00\",\n \"code\": \"CAD\"\n },\n \"total_amount\": {\n \"amount\": \"5.00\",\n \"code\": \"CAD\"\n },\n \"updated_at\": \"2020-10-09 15:41:35\",\n \"vis_state\": 1\n }\n }\n }\n}"
}
]
}
