Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
#include <C_CkDtObj.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
HCkDtObj Date_paid;
const char *Accountid;
const char *Accounting_systemid;
const char *Address;
const char *Amount;
const char *Code;
BOOL Auto_bill;
const char *Autobill_status;
int Basecampid;
const char *City;
const char *InvoiceCode;
const char *Country;
const char *Create_date;
const char *Created_at;
const char *Currency_code;
const char *Current_organization;
int Customerid;
const char *Deposit_amount;
const char *Deposit_percentage;
const char *Deposit_status;
const char *Description;
const char *Discount_description;
const char *Discount_totalAmount;
const char *Discount_totalCode;
const char *Discount_value;
const char *Display_status;
const char *Dispute_status;
const char *Due_date;
int Due_offset_days;
int Estimateid;
int Ext_archive;
const char *Fname;
const char *Fulfillment_date;
const char *Generation_date;
BOOL Gmail;
int Id;
const char *Invoice_number;
int Invoiceid;
const char *Language;
const char *Last_order_status;
const char *Lname;
const char *Notes;
const char *Organization;
const char *OutstandingAmount;
const char *OutstandingCode;
int Ownerid;
const char *PaidAmount;
const char *PaidCode;
int Parent;
const char *Payment_details;
const char *Payment_status;
const char *Po_number;
const char *Province;
const char *Return_uri;
int Sentid;
BOOL Show_attachments;
int Status;
const char *Street;
const char *Street2;
const char *Template;
const char *Terms;
const char *Updated;
const char *V3_status;
const char *Vat_name;
const char *Vat_number;
int Vis_state;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,"<access_token>");
CkHttp_SetRequestHeader(http,"Content-Type","application/json");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "invoice": {
// "accountid": "wkMd2g",
// "accounting_systemid": "wkMd2g",
// "address": "",
// "amount": {
// "amount": "180.00",
// "code": "USD"
// },
// "auto_bill": false,
// "autobill_status": null,
// "basecampid": 0,
// "city": "",
// "code": "",
// "country": "Canada",
// "create_date": "2019-04-20",
// "created_at": "2019-04-22 10:50:19",
// "currency_code": "USD",
// "current_organization": "first company",
// "customerid": 31006,
// "date_paid": null,
// "deposit_amount": null,
// "deposit_percentage": null,
// "deposit_status": "none",
// "description": "",
// "discount_description": null,
// "discount_total": {
// "amount": "0.00",
// "code": "USD"
// },
// "discount_value": "0",
// "display_status": "viewed",
// "dispute_status": null,
// "due_date": "2019-04-20",
// "due_offset_days": 0,
// "estimateid": 0,
// "ext_archive": 0,
// "fname": "Client",
// "fulfillment_date": "2019-04-20",
// "generation_date": null,
// "gmail": false,
// "id": 29618,
// "invoice_number": "0000012",
// "invoiceid": 29618,
// "language": "en",
// "last_order_status": null,
// "lname": "one",
// "notes": "",
// "organization": "first company",
// "outstanding": {
// "amount": "180.00",
// "code": "USD"
// },
// "ownerid": 31004,
// "paid": {
// "amount": "0.00",
// "code": "USD"
// },
// "parent": 0,
// "payment_details": "",
// "payment_status": "unpaid",
// "po_number": null,
// "province": "",
// "return_uri": null,
// "sentid": 31004,
// "show_attachments": true,
// "status": 3,
// "street": "",
// "street2": "",
// "template": "clean-grouped",
// "terms": "",
// "updated": "2019-04-23 17:59:12",
// "v3_status": "overdue",
// "vat_name": "",
// "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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
Date_paid = CkDtObj_Create();
Accountid = CkJsonObject_stringOf(jResp,"response.result.invoice.accountid");
Accounting_systemid = CkJsonObject_stringOf(jResp,"response.result.invoice.accounting_systemid");
Address = CkJsonObject_stringOf(jResp,"response.result.invoice.address");
Amount = CkJsonObject_stringOf(jResp,"response.result.invoice.amount.amount");
Code = CkJsonObject_stringOf(jResp,"response.result.invoice.amount.code");
Auto_bill = CkJsonObject_BoolOf(jResp,"response.result.invoice.auto_bill");
Autobill_status = CkJsonObject_stringOf(jResp,"response.result.invoice.autobill_status");
Basecampid = CkJsonObject_IntOf(jResp,"response.result.invoice.basecampid");
City = CkJsonObject_stringOf(jResp,"response.result.invoice.city");
InvoiceCode = CkJsonObject_stringOf(jResp,"response.result.invoice.code");
Country = CkJsonObject_stringOf(jResp,"response.result.invoice.country");
Create_date = CkJsonObject_stringOf(jResp,"response.result.invoice.create_date");
Created_at = CkJsonObject_stringOf(jResp,"response.result.invoice.created_at");
Currency_code = CkJsonObject_stringOf(jResp,"response.result.invoice.currency_code");
Current_organization = CkJsonObject_stringOf(jResp,"response.result.invoice.current_organization");
Customerid = CkJsonObject_IntOf(jResp,"response.result.invoice.customerid");
CkJsonObject_DtOf(jResp,"response.result.invoice.date_paid",FALSE,Date_paid);
Deposit_amount = CkJsonObject_stringOf(jResp,"response.result.invoice.deposit_amount");
Deposit_percentage = CkJsonObject_stringOf(jResp,"response.result.invoice.deposit_percentage");
Deposit_status = CkJsonObject_stringOf(jResp,"response.result.invoice.deposit_status");
Description = CkJsonObject_stringOf(jResp,"response.result.invoice.description");
Discount_description = CkJsonObject_stringOf(jResp,"response.result.invoice.discount_description");
Discount_totalAmount = CkJsonObject_stringOf(jResp,"response.result.invoice.discount_total.amount");
Discount_totalCode = CkJsonObject_stringOf(jResp,"response.result.invoice.discount_total.code");
Discount_value = CkJsonObject_stringOf(jResp,"response.result.invoice.discount_value");
Display_status = CkJsonObject_stringOf(jResp,"response.result.invoice.display_status");
Dispute_status = CkJsonObject_stringOf(jResp,"response.result.invoice.dispute_status");
Due_date = CkJsonObject_stringOf(jResp,"response.result.invoice.due_date");
Due_offset_days = CkJsonObject_IntOf(jResp,"response.result.invoice.due_offset_days");
Estimateid = CkJsonObject_IntOf(jResp,"response.result.invoice.estimateid");
Ext_archive = CkJsonObject_IntOf(jResp,"response.result.invoice.ext_archive");
Fname = CkJsonObject_stringOf(jResp,"response.result.invoice.fname");
Fulfillment_date = CkJsonObject_stringOf(jResp,"response.result.invoice.fulfillment_date");
Generation_date = CkJsonObject_stringOf(jResp,"response.result.invoice.generation_date");
Gmail = CkJsonObject_BoolOf(jResp,"response.result.invoice.gmail");
Id = CkJsonObject_IntOf(jResp,"response.result.invoice.id");
Invoice_number = CkJsonObject_stringOf(jResp,"response.result.invoice.invoice_number");
Invoiceid = CkJsonObject_IntOf(jResp,"response.result.invoice.invoiceid");
Language = CkJsonObject_stringOf(jResp,"response.result.invoice.language");
Last_order_status = CkJsonObject_stringOf(jResp,"response.result.invoice.last_order_status");
Lname = CkJsonObject_stringOf(jResp,"response.result.invoice.lname");
Notes = CkJsonObject_stringOf(jResp,"response.result.invoice.notes");
Organization = CkJsonObject_stringOf(jResp,"response.result.invoice.organization");
OutstandingAmount = CkJsonObject_stringOf(jResp,"response.result.invoice.outstanding.amount");
OutstandingCode = CkJsonObject_stringOf(jResp,"response.result.invoice.outstanding.code");
Ownerid = CkJsonObject_IntOf(jResp,"response.result.invoice.ownerid");
PaidAmount = CkJsonObject_stringOf(jResp,"response.result.invoice.paid.amount");
PaidCode = CkJsonObject_stringOf(jResp,"response.result.invoice.paid.code");
Parent = CkJsonObject_IntOf(jResp,"response.result.invoice.parent");
Payment_details = CkJsonObject_stringOf(jResp,"response.result.invoice.payment_details");
Payment_status = CkJsonObject_stringOf(jResp,"response.result.invoice.payment_status");
Po_number = CkJsonObject_stringOf(jResp,"response.result.invoice.po_number");
Province = CkJsonObject_stringOf(jResp,"response.result.invoice.province");
Return_uri = CkJsonObject_stringOf(jResp,"response.result.invoice.return_uri");
Sentid = CkJsonObject_IntOf(jResp,"response.result.invoice.sentid");
Show_attachments = CkJsonObject_BoolOf(jResp,"response.result.invoice.show_attachments");
Status = CkJsonObject_IntOf(jResp,"response.result.invoice.status");
Street = CkJsonObject_stringOf(jResp,"response.result.invoice.street");
Street2 = CkJsonObject_stringOf(jResp,"response.result.invoice.street2");
Template = CkJsonObject_stringOf(jResp,"response.result.invoice.template");
Terms = CkJsonObject_stringOf(jResp,"response.result.invoice.terms");
Updated = CkJsonObject_stringOf(jResp,"response.result.invoice.updated");
V3_status = CkJsonObject_stringOf(jResp,"response.result.invoice.v3_status");
Vat_name = CkJsonObject_stringOf(jResp,"response.result.invoice.vat_name");
Vat_number = CkJsonObject_stringOf(jResp,"response.result.invoice.vat_number");
Vis_state = CkJsonObject_IntOf(jResp,"response.result.invoice.vis_state");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
CkDtObj_Dispose(Date_paid);
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}
Postman Collection Item JSON
{
"name": "Single Invoice",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody);",
"pm.environment.set(\"invoiceId\", jsonData.response.result.invoice.id);",
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoices",
"invoices",
"{{invoiceId}}"
]
}
},
"response": [
{
"name": "Single Invoice",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoices",
"invoices",
"{{invoiceId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGEQoLVhRXUVdXEUkJTQFPA1pXAAVTUlYNBglSWFAECQRKSQAaEQZTUAYAUw5QWgpXUwtUD1ATTVUDCEVSPA=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:05:19 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:05:19 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 \"invoice\": {\n \"accountid\": \"wkMd2g\",\n \"accounting_systemid\": \"wkMd2g\",\n \"address\": \"\",\n \"amount\": {\n \"amount\": \"180.00\",\n \"code\": \"USD\"\n },\n \"auto_bill\": false,\n \"autobill_status\": null,\n \"basecampid\": 0,\n \"city\": \"\",\n \"code\": \"\",\n \"country\": \"Canada\",\n \"create_date\": \"2019-04-20\",\n \"created_at\": \"2019-04-22 10:50:19\",\n \"currency_code\": \"USD\",\n \"current_organization\": \"first company\",\n \"customerid\": 31006,\n \"date_paid\": null,\n \"deposit_amount\": null,\n \"deposit_percentage\": null,\n \"deposit_status\": \"none\",\n \"description\": \"\",\n \"discount_description\": null,\n \"discount_total\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"discount_value\": \"0\",\n \"display_status\": \"viewed\",\n \"dispute_status\": null,\n \"due_date\": \"2019-04-20\",\n \"due_offset_days\": 0,\n \"estimateid\": 0,\n \"ext_archive\": 0,\n \"fname\": \"Client\",\n \"fulfillment_date\": \"2019-04-20\",\n \"generation_date\": null,\n \"gmail\": false,\n \"id\": 29618,\n \"invoice_number\": \"0000012\",\n \"invoiceid\": 29618,\n \"language\": \"en\",\n \"last_order_status\": null,\n \"lname\": \"one\",\n \"notes\": \"\",\n \"organization\": \"first company\",\n \"outstanding\": {\n \"amount\": \"180.00\",\n \"code\": \"USD\"\n },\n \"ownerid\": 31004,\n \"paid\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"parent\": 0,\n \"payment_details\": \"\",\n \"payment_status\": \"unpaid\",\n \"po_number\": null,\n \"province\": \"\",\n \"return_uri\": null,\n \"sentid\": 31004,\n \"show_attachments\": true,\n \"status\": 3,\n \"street\": \"\",\n \"street2\": \"\",\n \"template\": \"clean-grouped\",\n \"terms\": \"\",\n \"updated\": \"2019-04-23 17:59:12\",\n \"v3_status\": \"overdue\",\n \"vat_name\": \"\",\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
