phpAx / New FreshBooks / Update Prepayment Credit
Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// 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
// }
// }
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('credit_note.credit_number','0000070');
$json->UpdateString('credit_note.currency_code','CAD');
$json->UpdateString('credit_note.create_date','2020-07-31');
$json->UpdateString('credit_note.notes','PrePayment for work');
$json->UpdateString('credit_note.credit_type','prepayment');
$json->UpdateString('credit_note.terms','Will be applied to future invoice');
$json->UpdateString('credit_note.language','en');
$json->UpdateString('credit_note.lines[0].id','20375-1');
$json->UpdateString('credit_note.lines[0].name','Credit');
$json->UpdateString('credit_note.lines[0].description','Current Credit Balance');
$json->UpdateNull('credit_note.lines[0].taxName1');
$json->UpdateInt('credit_note.lines[0].taxAmount1',0);
$json->UpdateNull('credit_note.lines[0].taxName2');
$json->UpdateInt('credit_note.lines[0].taxAmount2',0);
$json->UpdateBool('credit_note.lines[0].compounded_tax',0);
$json->UpdateInt('credit_note.lines[0].qty',1);
$json->UpdateString('credit_note.lines[0].unit_cost.amount','150');
$json->UpdateString('credit_note.lines[0].unit_cost.code','CAD');
$json->UpdateString('credit_note.lines[1].name','Credit');
$json->UpdateString('credit_note.lines[1].description','Current Credit Balance');
$json->UpdateNull('credit_note.lines[1].taxName1');
$json->UpdateInt('credit_note.lines[1].taxAmount1',0);
$json->UpdateNull('credit_note.lines[1].taxName2');
$json->UpdateInt('credit_note.lines[1].taxAmount2',0);
$json->UpdateBool('credit_note.lines[1].compounded_tax',0);
$json->UpdateInt('credit_note.lines[1].qty',1);
$json->UpdateString('credit_note.lines[1].unit_cost.amount','100');
$json->UpdateString('credit_note.lines[1].unit_cost.code','CAD');
$json->UpdateInt('credit_note.clientid',123);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbRequestBody = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbRequestBody);
// resp is a Chilkat.HttpResponse
$resp = $http->PTextSb('PUT','https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes/{{creditnote}}',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";
?>
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": [
]
}
