unicodeC / New FreshBooks / Create Single Invoice Profile
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *Accounting_systemid;
const wchar_t *Address;
const wchar_t *Amount;
const wchar_t *Code;
BOOL Auto_bill;
const wchar_t *Bill_gateway;
const wchar_t *City;
const wchar_t *Invoice_profileCode;
const wchar_t *Country;
const wchar_t *Create_date;
const wchar_t *Currency_code;
int Customerid;
const wchar_t *Description;
BOOL Disable;
const wchar_t *Discount_totalAmount;
const wchar_t *Discount_totalCode;
const wchar_t *Discount_value;
int Due_offset_days;
const wchar_t *Ext_archive;
const wchar_t *Fname;
const wchar_t *Frequency;
int Id;
BOOL Include_unbilled_time;
const wchar_t *Language;
const wchar_t *Lname;
const wchar_t *Notes;
int NumberRecurring;
int Occurrences_to_date;
const wchar_t *Organization;
int Ownerid;
const wchar_t *Payment_details;
const wchar_t *Po_number;
int Profileid;
const wchar_t *Province;
BOOL Require_auto_bill;
const wchar_t *Retainer_id;
BOOL Send_email;
BOOL Send_gmail;
const wchar_t *Street;
const wchar_t *Street2;
const wchar_t *Terms;
const wchar_t *Total_accrued_revenue;
const wchar_t *Updated;
const wchar_t *Vat_name;
const wchar_t *Vat_number;
int Vis_state;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_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.
// {
// "invoice_profile": {
// "customerid": 123,
// "create_date": "2019-04-25",
// "frequency": "m",
// "numberRecurring": 3,
// "lines": [
// {
// "name": "Test Item",
// "qty": "1",
// "unit_cost": {
// "amount": "27.00"
// }
// }
// ]
// }
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateInt(json,L"invoice_profile.customerid",123);
CkJsonObjectW_UpdateString(json,L"invoice_profile.create_date",L"2019-04-25");
CkJsonObjectW_UpdateString(json,L"invoice_profile.frequency",L"m");
CkJsonObjectW_UpdateInt(json,L"invoice_profile.numberRecurring",3);
CkJsonObjectW_UpdateString(json,L"invoice_profile.lines[0].name",L"Test Item");
CkJsonObjectW_UpdateString(json,L"invoice_profile.lines[0].qty",L"1");
CkJsonObjectW_UpdateString(json,L"invoice_profile.lines[0].unit_cost.amount",L"27.00");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
resp = CkHttpW_PostJson3(http,L"https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles",L"application/json",json);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "invoice_profile": {
// "accounting_systemid": "wkMd2g",
// "address": "",
// "amount": {
// "amount": "0.00",
// "code": "USD"
// },
// "auto_bill": false,
// "bill_gateway": null,
// "city": "",
// "code": "",
// "country": "Canada",
// "create_date": "2019-04-25",
// "currency_code": "USD",
// "customerid": 31006,
// "description": "",
// "disable": false,
// "discount_total": {
// "amount": "0.00",
// "code": "USD"
// },
// "discount_value": "0",
// "due_offset_days": 0,
// "ext_archive": null,
// "fname": "Nicolas",
// "frequency": "m",
// "id": 488,
// "include_unbilled_time": false,
// "language": "en",
// "lname": "one",
// "notes": "",
// "numberRecurring": 3,
// "occurrences_to_date": 0,
// "organization": "first company",
// "ownerid": 1,
// "payment_details": "",
// "po_number": null,
// "profileid": 488,
// "province": "",
// "require_auto_bill": false,
// "retainer_id": null,
// "send_email": true,
// "send_gmail": false,
// "street": "",
// "street2": "",
// "terms": null,
// "total_accrued_revenue": null,
// "updated": "2019-04-24 14:17:14",
// "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.
Accounting_systemid = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.accounting_systemid");
Address = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.address");
Amount = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.amount.amount");
Code = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.amount.code");
Auto_bill = CkJsonObjectW_BoolOf(jResp,L"response.result.invoice_profile.auto_bill");
Bill_gateway = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.bill_gateway");
City = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.city");
Invoice_profileCode = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.code");
Country = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.country");
Create_date = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.create_date");
Currency_code = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.currency_code");
Customerid = CkJsonObjectW_IntOf(jResp,L"response.result.invoice_profile.customerid");
Description = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.description");
Disable = CkJsonObjectW_BoolOf(jResp,L"response.result.invoice_profile.disable");
Discount_totalAmount = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.discount_total.amount");
Discount_totalCode = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.discount_total.code");
Discount_value = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.discount_value");
Due_offset_days = CkJsonObjectW_IntOf(jResp,L"response.result.invoice_profile.due_offset_days");
Ext_archive = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.ext_archive");
Fname = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.fname");
Frequency = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.frequency");
Id = CkJsonObjectW_IntOf(jResp,L"response.result.invoice_profile.id");
Include_unbilled_time = CkJsonObjectW_BoolOf(jResp,L"response.result.invoice_profile.include_unbilled_time");
Language = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.language");
Lname = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.lname");
Notes = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.notes");
NumberRecurring = CkJsonObjectW_IntOf(jResp,L"response.result.invoice_profile.numberRecurring");
Occurrences_to_date = CkJsonObjectW_IntOf(jResp,L"response.result.invoice_profile.occurrences_to_date");
Organization = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.organization");
Ownerid = CkJsonObjectW_IntOf(jResp,L"response.result.invoice_profile.ownerid");
Payment_details = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.payment_details");
Po_number = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.po_number");
Profileid = CkJsonObjectW_IntOf(jResp,L"response.result.invoice_profile.profileid");
Province = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.province");
Require_auto_bill = CkJsonObjectW_BoolOf(jResp,L"response.result.invoice_profile.require_auto_bill");
Retainer_id = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.retainer_id");
Send_email = CkJsonObjectW_BoolOf(jResp,L"response.result.invoice_profile.send_email");
Send_gmail = CkJsonObjectW_BoolOf(jResp,L"response.result.invoice_profile.send_gmail");
Street = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.street");
Street2 = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.street2");
Terms = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.terms");
Total_accrued_revenue = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.total_accrued_revenue");
Updated = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.updated");
Vat_name = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.vat_name");
Vat_number = CkJsonObjectW_stringOf(jResp,L"response.result.invoice_profile.vat_number");
Vis_state = CkJsonObjectW_IntOf(jResp,L"response.result.invoice_profile.vis_state");
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"invoice_profile": {
"customerid": {{customerId}},
"create_date": "2019-04-25",
"frequency": "m",
"numberRecurring": 3,
"lines": [
{
"name": "Test Item",
"qty": "1",
"unit_cost": {
"amount": "27.00"
}
}
]
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles
Postman Collection Item JSON
{
"name": "Create Single Invoice Profile",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody);",
"pm.environment.set(\"customerId\", jsonData.response.result.invoice_profile[0].customerid);"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"invoice_profile\": {\n \"customerid\": {{customerId}},\n \"create_date\": \"2019-04-25\",\n \"frequency\": \"m\", \n \"numberRecurring\": 3,\n \"lines\": [\n {\n \"name\": \"Test Item\",\n \"qty\": \"1\",\n \"unit_cost\": {\n \"amount\": \"27.00\"\n }\n }\n ]\n }\n }\n"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoice_profiles",
"invoice_profiles"
]
},
"description": "Creates a monthly recurring invoice that sends 3 invoices in total."
},
"response": [
{
"name": "Create Single Invoice Profile - Invalid Date",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"invoice_profile\": {\n \"customerid\": {{customerId}},\n \"create_date\": \"2019-04-20\",\n \"frequency\": \"m\", \n \"numberRecurring\": 3\n }\n }"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoice_profiles",
"invoice_profiles"
]
}
},
"status": "UNPROCESSABLE ENTITY",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGPUAQVwRRVFFBCQxXF14IUAcURFgHDw9dQBJIUU4HHwZXUAIPC1ZRWlYGUw5UAQEGHgJWAU0TUgEAAgYGU1IFCgVVU1EGAhMbAAVdRVY/"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Content-Length",
"value": "303"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:16: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": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"errors\": [\n {\n \"errno\": 16003,\n \"field\": \"create_date\",\n \"message\": \"'Create Date' is an invalid value: The date for a new recurring profile must be today or later.\",\n \"object\": \"invoice_profile\",\n \"value\": \"2019-04-20\"\n }\n ]\n }\n}"
},
{
"name": "Create Single Invoice Profile",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"invoice_profile\": {\n \"customerid\": {{customerId}},\n \"create_date\": \"2019-04-25\",\n \"frequency\": \"m\", \n \"numberRecurring\": 3\n }\n }"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoice_profiles",
"invoice_profiles"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGPUAQVwRRVFFBCQxXF14IUAcURFgHDw9dQBJIUU4HHwZfXAICBlRQUlMGUQtRCAgMHgJWAU0TVARRBlVWVV5VDVcEAQQGBBMbAAVdRVY/"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:17:14 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": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:17:14 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_profile\": {\n \"accounting_systemid\": \"wkMd2g\",\n \"address\": \"\",\n \"amount\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"auto_bill\": false,\n \"bill_gateway\": null,\n \"city\": \"\",\n \"code\": \"\",\n \"country\": \"Canada\",\n \"create_date\": \"2019-04-25\",\n \"currency_code\": \"USD\",\n \"customerid\": 31006,\n \"description\": \"\",\n \"disable\": false,\n \"discount_total\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"discount_value\": \"0\",\n \"due_offset_days\": 0,\n \"ext_archive\": null,\n \"fname\": \"Nicolas\",\n \"frequency\": \"m\",\n \"id\": 488,\n \"include_unbilled_time\": false,\n \"language\": \"en\",\n \"lname\": \"one\",\n \"notes\": \"\",\n \"numberRecurring\": 3,\n \"occurrences_to_date\": 0,\n \"organization\": \"first company\",\n \"ownerid\": 1,\n \"payment_details\": \"\",\n \"po_number\": null,\n \"profileid\": 488,\n \"province\": \"\",\n \"require_auto_bill\": false,\n \"retainer_id\": null,\n \"send_email\": true,\n \"send_gmail\": false,\n \"street\": \"\",\n \"street2\": \"\",\n \"terms\": null,\n \"total_accrued_revenue\": null,\n \"updated\": \"2019-04-24 14:17:14\",\n \"vat_name\": \"\",\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
