C / New FreshBooks / Update Prepayment Credit
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkHttpResponse.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject json;
HCkStringBuilder sbRequestBody;
HCkHttpResponse resp;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_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": "0000070",
// "currency_code": "CAD",
// "create_date": "2020-07-31",
// "notes": "PrePayment for work",
// "credit_type": "prepayment",
// "terms": "Will be applied to future invoice",
// "language": "en",
// "lines": [
// {
// "id": "20375-1",
// "name": "Credit",
// "description": "Current Credit Balance",
// "taxName1": null,
// "taxAmount1": 0,
// "taxName2": null,
// "taxAmount2": 0,
// "compounded_tax": false,
// "qty": 1,
// "unit_cost": {
// "amount": "150",
// "code": "CAD"
// }
// },
// {
// "name": "Credit",
// "description": "Current Credit Balance",
// "taxName1": null,
// "taxAmount1": 0,
// "taxName2": null,
// "taxAmount2": 0,
// "compounded_tax": false,
// "qty": 1,
// "unit_cost": {
// "amount": "100",
// "code": "CAD"
// }
// }
// ],
// "clientid": 123
// }
// }
json = CkJsonObject_Create();
CkJsonObject_UpdateString(json,"credit_note.credit_number","0000070");
CkJsonObject_UpdateString(json,"credit_note.currency_code","CAD");
CkJsonObject_UpdateString(json,"credit_note.create_date","2020-07-31");
CkJsonObject_UpdateString(json,"credit_note.notes","PrePayment for work");
CkJsonObject_UpdateString(json,"credit_note.credit_type","prepayment");
CkJsonObject_UpdateString(json,"credit_note.terms","Will be applied to future invoice");
CkJsonObject_UpdateString(json,"credit_note.language","en");
CkJsonObject_UpdateString(json,"credit_note.lines[0].id","20375-1");
CkJsonObject_UpdateString(json,"credit_note.lines[0].name","Credit");
CkJsonObject_UpdateString(json,"credit_note.lines[0].description","Current Credit Balance");
CkJsonObject_UpdateNull(json,"credit_note.lines[0].taxName1");
CkJsonObject_UpdateInt(json,"credit_note.lines[0].taxAmount1",0);
CkJsonObject_UpdateNull(json,"credit_note.lines[0].taxName2");
CkJsonObject_UpdateInt(json,"credit_note.lines[0].taxAmount2",0);
CkJsonObject_UpdateBool(json,"credit_note.lines[0].compounded_tax",FALSE);
CkJsonObject_UpdateInt(json,"credit_note.lines[0].qty",1);
CkJsonObject_UpdateString(json,"credit_note.lines[0].unit_cost.amount","150");
CkJsonObject_UpdateString(json,"credit_note.lines[0].unit_cost.code","CAD");
CkJsonObject_UpdateString(json,"credit_note.lines[1].name","Credit");
CkJsonObject_UpdateString(json,"credit_note.lines[1].description","Current Credit Balance");
CkJsonObject_UpdateNull(json,"credit_note.lines[1].taxName1");
CkJsonObject_UpdateInt(json,"credit_note.lines[1].taxAmount1",0);
CkJsonObject_UpdateNull(json,"credit_note.lines[1].taxName2");
CkJsonObject_UpdateInt(json,"credit_note.lines[1].taxAmount2",0);
CkJsonObject_UpdateBool(json,"credit_note.lines[1].compounded_tax",FALSE);
CkJsonObject_UpdateInt(json,"credit_note.lines[1].qty",1);
CkJsonObject_UpdateString(json,"credit_note.lines[1].unit_cost.amount","100");
CkJsonObject_UpdateString(json,"credit_note.lines[1].unit_cost.code","CAD");
CkJsonObject_UpdateInt(json,"credit_note.clientid",123);
sbRequestBody = CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
resp = CkHttp_PTextSb(http,"PUT","https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes/{{creditnote}}",sbRequestBody,"utf-8","application/json",FALSE,FALSE);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
return;
}
printf("%d\n",CkHttpResponse_getStatusCode(resp));
printf("%s\n",CkHttpResponse_bodyStr(resp));
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
}
Curl Command
curl -X PUT
-d '{
"credit_note": {
"credit_number": "0000070",
"currency_code": "CAD",
"create_date": "2020-07-31",
"notes": "PrePayment for work",
"credit_type": "prepayment",
"terms": "Will be applied to future invoice",
"language": "en",
"lines": [
{
"id": "20375-1",
"name": "Credit",
"description": "Current Credit Balance",
"taxName1": null,
"taxAmount1": 0,
"taxName2": null,
"taxAmount2": 0,
"compounded_tax": false,
"qty": 1,
"unit_cost": {
"amount": "150",
"code": "CAD"
}
},
{
"name": "Credit",
"description": "Current Credit Balance",
"taxName1": null,
"taxAmount1": 0,
"taxName2": null,
"taxAmount2": 0,
"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 Prepayment Credit",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "",
"value": "",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"credit_note\": {\n \"credit_number\": \"0000070\",\n \"currency_code\": \"CAD\",\n \"create_date\": \"2020-07-31\",\n \"notes\": \"PrePayment for work\",\n \"credit_type\": \"prepayment\",\n \"terms\": \"Will be applied to future invoice\",\n \"language\": \"en\",\n \"lines\": [\n {\n \"id\": \"20375-1\",\n \"name\": \"Credit\",\n \"description\": \"Current Credit Balance\",\n \"taxName1\": null,\n \"taxAmount1\": 0,\n \"taxName2\": null,\n \"taxAmount2\": 0,\n \"compounded_tax\": false,\n \"qty\": 1,\n \"unit_cost\": {\n \"amount\": \"150\",\n \"code\": \"CAD\"\n }\n },\n {\n \"name\": \"Credit\",\n \"description\": \"Current Credit Balance\",\n \"taxName1\": null,\n \"taxAmount1\": 0,\n \"taxName2\": null,\n \"taxAmount2\": 0,\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": [
]
}
