unicodeC / New FreshBooks / Update Credit Note
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkStringBuilderW sbRequestBody;
HCkHttpResponseW resp;
// 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.
// {
// "credit_note": {
// "credit_number": "0000066",
// "currency_code": "CAD",
// "create_date": "2020-08-04",
// "notes": "",
// "credit_type": "goodwill",
// "terms": null,
// "language": "en",
// "lines": [
// {
// "id": "20405-1",
// "name": "Credit",
// "description": "Free Voucher",
// "taxName1": null,
// "taxAmount1": 0,
// "taxName2": null,
// "taxAmount2": 0,
// "compounded_tax": false,
// "qty": 1,
// "unit_cost": {
// "amount": "50",
// "code": "CAD"
// }
// },
// {
// "name": "Credit",
// "description": "More voucher",
// "taxName1": null,
// "taxAmount1": null,
// "taxName2": null,
// "taxAmount2": null,
// "compounded_tax": false,
// "qty": 1,
// "unit_cost": {
// "amount": "100",
// "code": "CAD"
// }
// }
// ],
// "clientid": 123
// }
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"credit_note.credit_number",L"0000066");
CkJsonObjectW_UpdateString(json,L"credit_note.currency_code",L"CAD");
CkJsonObjectW_UpdateString(json,L"credit_note.create_date",L"2020-08-04");
CkJsonObjectW_UpdateString(json,L"credit_note.notes",L"");
CkJsonObjectW_UpdateString(json,L"credit_note.credit_type",L"goodwill");
CkJsonObjectW_UpdateNull(json,L"credit_note.terms");
CkJsonObjectW_UpdateString(json,L"credit_note.language",L"en");
CkJsonObjectW_UpdateString(json,L"credit_note.lines[0].id",L"20405-1");
CkJsonObjectW_UpdateString(json,L"credit_note.lines[0].name",L"Credit");
CkJsonObjectW_UpdateString(json,L"credit_note.lines[0].description",L"Free Voucher");
CkJsonObjectW_UpdateNull(json,L"credit_note.lines[0].taxName1");
CkJsonObjectW_UpdateInt(json,L"credit_note.lines[0].taxAmount1",0);
CkJsonObjectW_UpdateNull(json,L"credit_note.lines[0].taxName2");
CkJsonObjectW_UpdateInt(json,L"credit_note.lines[0].taxAmount2",0);
CkJsonObjectW_UpdateBool(json,L"credit_note.lines[0].compounded_tax",FALSE);
CkJsonObjectW_UpdateInt(json,L"credit_note.lines[0].qty",1);
CkJsonObjectW_UpdateString(json,L"credit_note.lines[0].unit_cost.amount",L"50");
CkJsonObjectW_UpdateString(json,L"credit_note.lines[0].unit_cost.code",L"CAD");
CkJsonObjectW_UpdateString(json,L"credit_note.lines[1].name",L"Credit");
CkJsonObjectW_UpdateString(json,L"credit_note.lines[1].description",L"More voucher");
CkJsonObjectW_UpdateNull(json,L"credit_note.lines[1].taxName1");
CkJsonObjectW_UpdateNull(json,L"credit_note.lines[1].taxAmount1");
CkJsonObjectW_UpdateNull(json,L"credit_note.lines[1].taxName2");
CkJsonObjectW_UpdateNull(json,L"credit_note.lines[1].taxAmount2");
CkJsonObjectW_UpdateBool(json,L"credit_note.lines[1].compounded_tax",FALSE);
CkJsonObjectW_UpdateInt(json,L"credit_note.lines[1].qty",1);
CkJsonObjectW_UpdateString(json,L"credit_note.lines[1].unit_cost.amount",L"100");
CkJsonObjectW_UpdateString(json,L"credit_note.lines[1].unit_cost.code",L"CAD");
CkJsonObjectW_UpdateInt(json,L"credit_note.clientid",123);
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
sbRequestBody = CkStringBuilderW_Create();
CkJsonObjectW_EmitSb(json,sbRequestBody);
resp = CkHttpW_PTextSb(http,L"PUT",L"https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes/{{creditnote}}",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
return;
}
wprintf(L"%d\n",CkHttpResponseW_getStatusCode(resp));
wprintf(L"%s\n",CkHttpResponseW_bodyStr(resp));
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
}
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"credit_note": {
"credit_number": "0000066",
"currency_code": "CAD",
"create_date": "2020-08-04",
"notes": "",
"credit_type": "goodwill",
"terms": null,
"language": "en",
"lines": [
{
"id": "20405-1",
"name": "Credit",
"description": "Free Voucher",
"taxName1": null,
"taxAmount1": 0,
"taxName2": null,
"taxAmount2": 0,
"compounded_tax": false,
"qty": 1,
"unit_cost": {
"amount": "50",
"code": "CAD"
}
},
{
"name": "Credit",
"description": "More voucher",
"taxName1": null,
"taxAmount1": null,
"taxName2": null,
"taxAmount2": null,
"compounded_tax": false,
"qty": 1,
"unit_cost": {
"amount": "100",
"code": "CAD"
}
}
],
"clientid": {{clientId}}
}
}'
https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes/{{creditnote}}
Postman Collection Item JSON
{
"name": "Update Credit Note",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"credit_note\": {\n \"credit_number\": \"0000066\",\n \"currency_code\": \"CAD\",\n \"create_date\": \"2020-08-04\",\n \"notes\": \"\",\n \"credit_type\": \"goodwill\",\n \"terms\": null,\n \"language\": \"en\",\n \"lines\": [\n {\n \"id\": \"20405-1\",\n \"name\": \"Credit\",\n \"description\": \"Free Voucher\",\n \"taxName1\": null,\n \"taxAmount1\": 0,\n \"taxName2\": null,\n \"taxAmount2\": 0,\n \"compounded_tax\": false,\n \"qty\": 1,\n \"unit_cost\": {\n \"amount\": \"50\",\n \"code\": \"CAD\"\n }\n },\n {\n \"name\": \"Credit\",\n \"description\": \"More voucher\",\n \"taxName1\": null,\n \"taxAmount1\": null,\n \"taxName2\": null,\n \"taxAmount2\": null,\n \"compounded_tax\": false,\n \"qty\": 1,\n \"unit_cost\": {\n \"amount\": \"100\",\n \"code\": \"CAD\"\n }\n }\n ],\n \"clientid\": {{clientId}}\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes/{{creditnote}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountid}}",
"credit_notes",
"credit_notes",
"{{creditnote}}"
]
}
},
"response": [
]
}
