Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.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;
CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"search[date_min]" value: @"2021-10-09"];
[queryParams UpdateString: @"search[date_max]" value: @"search[date_min]"];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://api.freshbooks.com/accounting/account/5pyBd/bills/bills" json: queryParams];
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_vendors": [
// {
// "account_number": "8394858982590",
// "city": null,
// "country": null,
// "created_at": "2020-10-06 14:20:20",
// "currency_code": "CAD",
// "is_1099": false,
// "language": "en",
// "outstanding_balance": [
// {
// "amount": {
// "amount": "5.00",
// "code": "CAD"
// }
// }
// ],
// "overdue_balance": [
// ],
// "phone": "8335970553",
// "postal_code": null,
// "primary_contact_email": "hdavid@freshbooks.com",
// "primary_contact_first_name": "Hannah",
// "primary_contact_last_name": "David",
// "province": null,
// "street": null,
// "street2": null,
// "tax_defaults": [
// {
// "amount": "13.56",
// "created_at": "2020-10-06 14:23:06",
// "enabled": true,
// "name": "GST",
// "system_taxid": 36859,
// "tax_authorityid": null,
// "taxid": 1,
// "updated_at": "2020-10-06 14:23:06",
// "vendorid": 1
// },
// {
// "amount": "13",
// "created_at": "2020-10-06 14:23:06",
// "enabled": true,
// "name": "HST",
// "system_taxid": 37696,
// "tax_authorityid": null,
// "taxid": 3,
// "updated_at": "2020-10-06 14:23:06",
// "vendorid": 1
// }
// ],
// "updated_at": "2020-10-06 14:22:49",
// "vendor_name": "Staples",
// "vendorid": 1,
// "vis_state": 0,
// "website": null
// }
// ],
// "page": 1,
// "pages": 1,
// "per_page": 15,
// "total": 1
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *account_number = 0;
NSString *city = 0;
NSString *country = 0;
NSString *created_at = 0;
NSString *currency_code = 0;
BOOL is_1099;
NSString *language = 0;
NSString *phone = 0;
NSString *postal_code = 0;
NSString *primary_contact_email = 0;
NSString *primary_contact_first_name = 0;
NSString *primary_contact_last_name = 0;
NSString *province = 0;
NSString *street = 0;
NSString *street2 = 0;
NSString *updated_at = 0;
NSString *vendor_name = 0;
int vendorid;
int vis_state;
NSString *website = 0;
int j;
int count_j;
NSString *Amount = 0;
NSString *Code = 0;
NSString *amount = 0;
BOOL enabled;
NSString *name = 0;
int system_taxid;
NSString *tax_authorityid = 0;
int taxid;
int Page = [[jResp IntOf: @"response.result.page"] intValue];
int Pages = [[jResp IntOf: @"response.result.pages"] intValue];
int Per_page = [[jResp IntOf: @"response.result.per_page"] intValue];
int Total = [[jResp IntOf: @"response.result.total"] intValue];
int i = 0;
int count_i = [[jResp SizeOfArray: @"response.result.bill_vendors"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
account_number = [jResp StringOf: @"response.result.bill_vendors[i].account_number"];
city = [jResp StringOf: @"response.result.bill_vendors[i].city"];
country = [jResp StringOf: @"response.result.bill_vendors[i].country"];
created_at = [jResp StringOf: @"response.result.bill_vendors[i].created_at"];
currency_code = [jResp StringOf: @"response.result.bill_vendors[i].currency_code"];
is_1099 = [jResp BoolOf: @"response.result.bill_vendors[i].is_1099"];
language = [jResp StringOf: @"response.result.bill_vendors[i].language"];
phone = [jResp StringOf: @"response.result.bill_vendors[i].phone"];
postal_code = [jResp StringOf: @"response.result.bill_vendors[i].postal_code"];
primary_contact_email = [jResp StringOf: @"response.result.bill_vendors[i].primary_contact_email"];
primary_contact_first_name = [jResp StringOf: @"response.result.bill_vendors[i].primary_contact_first_name"];
primary_contact_last_name = [jResp StringOf: @"response.result.bill_vendors[i].primary_contact_last_name"];
province = [jResp StringOf: @"response.result.bill_vendors[i].province"];
street = [jResp StringOf: @"response.result.bill_vendors[i].street"];
street2 = [jResp StringOf: @"response.result.bill_vendors[i].street2"];
updated_at = [jResp StringOf: @"response.result.bill_vendors[i].updated_at"];
vendor_name = [jResp StringOf: @"response.result.bill_vendors[i].vendor_name"];
vendorid = [[jResp IntOf: @"response.result.bill_vendors[i].vendorid"] intValue];
vis_state = [[jResp IntOf: @"response.result.bill_vendors[i].vis_state"] intValue];
website = [jResp StringOf: @"response.result.bill_vendors[i].website"];
j = 0;
count_j = [[jResp SizeOfArray: @"response.result.bill_vendors[i].outstanding_balance"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
Amount = [jResp StringOf: @"response.result.bill_vendors[i].outstanding_balance[j].amount.amount"];
Code = [jResp StringOf: @"response.result.bill_vendors[i].outstanding_balance[j].amount.code"];
j = j + 1;
}
j = 0;
count_j = [[jResp SizeOfArray: @"response.result.bill_vendors[i].overdue_balance"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
j = j + 1;
}
j = 0;
count_j = [[jResp SizeOfArray: @"response.result.bill_vendors[i].tax_defaults"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
amount = [jResp StringOf: @"response.result.bill_vendors[i].tax_defaults[j].amount"];
created_at = [jResp StringOf: @"response.result.bill_vendors[i].tax_defaults[j].created_at"];
enabled = [jResp BoolOf: @"response.result.bill_vendors[i].tax_defaults[j].enabled"];
name = [jResp StringOf: @"response.result.bill_vendors[i].tax_defaults[j].name"];
system_taxid = [[jResp IntOf: @"response.result.bill_vendors[i].tax_defaults[j].system_taxid"] intValue];
tax_authorityid = [jResp StringOf: @"response.result.bill_vendors[i].tax_defaults[j].tax_authorityid"];
taxid = [[jResp IntOf: @"response.result.bill_vendors[i].tax_defaults[j].taxid"] intValue];
updated_at = [jResp StringOf: @"response.result.bill_vendors[i].tax_defaults[j].updated_at"];
vendorid = [[jResp IntOf: @"response.result.bill_vendors[i].tax_defaults[j].vendorid"] intValue];
j = j + 1;
}
i = i + 1;
}
Curl Command
curl -G -d "search[date_min]=2021-10-09"
-d "search[date_max]=search%5Bdate_min%5D"
-H "Authorization: Bearer <access_token>"
https://api.freshbooks.com/accounting/account/5pyBd/bills/bills
Postman Collection Item JSON
{
"name": "Get Bills",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody);",
"pm.environment.set(\"billId\", jsonData.response.result.bills[0].id)"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "eyJraWQiOiJhMTlPSlR5aVlKOXhPM3FoWnhWeE1KZE5ZNXJ4cUhpQzBSTUY0TWRheGtjIiwiYWxnIjoiUlMyNTYifQ.eyJqdGkiOiJjZTI5MTQ1MWUxMTYyMThmNDdlZDhhMGIyYWJhZGVkODhhZDIyZWUxNDlhNmI0OTczMzVlNWU3MDMxNTdmZDJmIiwiaWF0IjoxNjM3MDc4ODUyLCJleHAiOjE2MzcxMjIwNTIsInN1YiI6IlNtdXhJZGVudGl0eTs2NzA1NDgiLCJjbGllbnRfaWQiOiI1MzFlMjI0NzMxYWUxYjcyNzkyMDUwYzIxYjdjYjg4YjQ4YjVjZmYyM2IyNjQ0OGYxMGM3YjZkZDE2YzM4M2NiIiwic2NvcGUiOiJhZG1pbjphbGwiLCJhdXRoLmZyZXNoYm9va3MuY29tL3N1Yl90eXBlIjoicmVzb3VyY2Vfb3duZXIifQ.XZYsOTZZJyxc4ny1NVrAShnNqbpS1GGc54jlRSO8gll4axcdadpluV_gflS_CyZfPSw6ivhu1lwxczj5xGNllZkMI85nVs17EPmpq4MqO9b08oaWoWIptxD329uO893jxW4cFQdGLbCAnJ2BNddWoVIaHS-1EiVPbEh8EKTFeJ-j5tYHRbWcuy32ftuKrqX53z5dY3sUMRsmhsGMfOEzTUfz0J1epHqJSDGHn-HQLljZ4fbmGwCf4LlWPnsgGJj5nDxiRWbUOPXW2J73_tAAH2-u49MRhO2nf_8meHKHhCVZZ0PM4lPzaAqv5OkofwCSEEgIX4Af3Ifh88O9uLtbGg",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/5pyBd/bills/bills?search[date_min]=2021-10-09&search[date_max]=search[date_min]",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"5pyBd",
"bills",
"bills"
],
"query": [
{
"key": "search[date_min]",
"value": "2021-10-09"
},
{
"key": "search[date_max]",
"value": "search[date_min]"
}
]
}
},
"response": [
{
"name": "https://api.freshbooks.com/accounting/account/{{accountId}}/bill_vendors/bill_vendors",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/bill_vendors/bill_vendors",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"bill_vendors",
"bill_vendors"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Date",
"value": "Fri, 09 Oct 2020 15:19:07 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gGWFpfPRAGDFQNShECWl1eXxNcD1UOQRFGGgdNVk0LBQlRU1sOBwVTVwgABFBeVk4dUxRACVxRAFIGC1QHBAdaV1RWA0RPXlJcFwQ/"
},
{
"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": "1602256808"
},
{
"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_vendors\": [\n {\n \"account_number\": \"8394858982590\",\n \"city\": null,\n \"country\": null,\n \"created_at\": \"2020-10-06 14:20:20\",\n \"currency_code\": \"CAD\",\n \"is_1099\": false,\n \"language\": \"en\",\n \"outstanding_balance\": [\n {\n \"amount\": {\n \"amount\": \"5.00\",\n \"code\": \"CAD\"\n }\n }\n ],\n \"overdue_balance\": [],\n \"phone\": \"8335970553\",\n \"postal_code\": null,\n \"primary_contact_email\": \"hdavid@freshbooks.com\",\n \"primary_contact_first_name\": \"Hannah\",\n \"primary_contact_last_name\": \"David\",\n \"province\": null,\n \"street\": null,\n \"street2\": null,\n \"tax_defaults\": [\n {\n \"amount\": \"13.56\",\n \"created_at\": \"2020-10-06 14:23:06\",\n \"enabled\": true,\n \"name\": \"GST\",\n \"system_taxid\": 36859,\n \"tax_authorityid\": null,\n \"taxid\": 1,\n \"updated_at\": \"2020-10-06 14:23:06\",\n \"vendorid\": 1\n },\n {\n \"amount\": \"13\",\n \"created_at\": \"2020-10-06 14:23:06\",\n \"enabled\": true,\n \"name\": \"HST\",\n \"system_taxid\": 37696,\n \"tax_authorityid\": null,\n \"taxid\": 3,\n \"updated_at\": \"2020-10-06 14:23:06\",\n \"vendorid\": 1\n }\n ],\n \"updated_at\": \"2020-10-06 14:22:49\",\n \"vendor_name\": \"Staples\",\n \"vendorid\": 1,\n \"vis_state\": 0,\n \"website\": null\n }\n ],\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 15,\n \"total\": 1\n }\n }\n}"
}
]
}
