Chilkat Online Tools

phpAx / New FreshBooks / Update Credit Note

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": "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
//   }
// }

// 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','0000066');
$json->UpdateString('credit_note.currency_code','CAD');
$json->UpdateString('credit_note.create_date','2020-08-04');
$json->UpdateString('credit_note.notes','');
$json->UpdateString('credit_note.credit_type','goodwill');
$json->UpdateNull('credit_note.terms');
$json->UpdateString('credit_note.language','en');
$json->UpdateString('credit_note.lines[0].id','20405-1');
$json->UpdateString('credit_note.lines[0].name','Credit');
$json->UpdateString('credit_note.lines[0].description','Free Voucher');
$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','50');
$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','More voucher');
$json->UpdateNull('credit_note.lines[1].taxName1');
$json->UpdateNull('credit_note.lines[1].taxAmount1');
$json->UpdateNull('credit_note.lines[1].taxName2');
$json->UpdateNull('credit_note.lines[1].taxAmount2');
$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);

// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';

// 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
	-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": [
  ]
}