Chilkat Online Tools

Node.js / New FreshBooks / Delete Invoice Profile

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var http = new chilkat.Http();
    var success;

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

    var json = new chilkat.JsonObject();
    json.UpdateInt("invoice_profile.vis_state",1);

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>";
    http.SetRequestHeader("Content-Type","application/json");

    var sbRequestBody = new chilkat.StringBuilder();
    json.EmitSb(sbRequestBody);

    // resp: HttpResponse
    var resp = http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}",sbRequestBody,"utf-8","application/json",false,false);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

    // 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": 456,
    //         "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": 456,
    //         "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:40",
    //         "vat_name": null,
    //         "vat_number": "",
    //         "vis_state": 1
    //       }
    //     }
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var Accounting_systemid = jResp.StringOf("response.result.invoice_profile.accounting_systemid");
    var Address = jResp.StringOf("response.result.invoice_profile.address");
    var Amount = jResp.StringOf("response.result.invoice_profile.amount.amount");
    var Code = jResp.StringOf("response.result.invoice_profile.amount.code");
    var Auto_bill = jResp.BoolOf("response.result.invoice_profile.auto_bill");
    var Bill_gateway = jResp.StringOf("response.result.invoice_profile.bill_gateway");
    var City = jResp.StringOf("response.result.invoice_profile.city");
    var Invoice_profileCode = jResp.StringOf("response.result.invoice_profile.code");
    var Country = jResp.StringOf("response.result.invoice_profile.country");
    var Create_date = jResp.StringOf("response.result.invoice_profile.create_date");
    var Currency_code = jResp.StringOf("response.result.invoice_profile.currency_code");
    var Customerid = jResp.IntOf("response.result.invoice_profile.customerid");
    var Description = jResp.StringOf("response.result.invoice_profile.description");
    var Disable = jResp.BoolOf("response.result.invoice_profile.disable");
    var Discount_totalAmount = jResp.StringOf("response.result.invoice_profile.discount_total.amount");
    var Discount_totalCode = jResp.StringOf("response.result.invoice_profile.discount_total.code");
    var Discount_value = jResp.StringOf("response.result.invoice_profile.discount_value");
    var Due_offset_days = jResp.IntOf("response.result.invoice_profile.due_offset_days");
    var Ext_archive = jResp.StringOf("response.result.invoice_profile.ext_archive");
    var Fname = jResp.StringOf("response.result.invoice_profile.fname");
    var Frequency = jResp.StringOf("response.result.invoice_profile.frequency");
    var Id = jResp.IntOf("response.result.invoice_profile.id");
    var Include_unbilled_time = jResp.BoolOf("response.result.invoice_profile.include_unbilled_time");
    var Language = jResp.StringOf("response.result.invoice_profile.language");
    var Lname = jResp.StringOf("response.result.invoice_profile.lname");
    var Notes = jResp.StringOf("response.result.invoice_profile.notes");
    var NumberRecurring = jResp.IntOf("response.result.invoice_profile.numberRecurring");
    var Occurrences_to_date = jResp.IntOf("response.result.invoice_profile.occurrences_to_date");
    var Organization = jResp.StringOf("response.result.invoice_profile.organization");
    var Ownerid = jResp.IntOf("response.result.invoice_profile.ownerid");
    var Payment_details = jResp.StringOf("response.result.invoice_profile.payment_details");
    var Po_number = jResp.StringOf("response.result.invoice_profile.po_number");
    var Profileid = jResp.IntOf("response.result.invoice_profile.profileid");
    var Province = jResp.StringOf("response.result.invoice_profile.province");
    var Require_auto_bill = jResp.BoolOf("response.result.invoice_profile.require_auto_bill");
    var Retainer_id = jResp.StringOf("response.result.invoice_profile.retainer_id");
    var Send_email = jResp.BoolOf("response.result.invoice_profile.send_email");
    var Send_gmail = jResp.BoolOf("response.result.invoice_profile.send_gmail");
    var Street = jResp.StringOf("response.result.invoice_profile.street");
    var Street2 = jResp.StringOf("response.result.invoice_profile.street2");
    var Terms = jResp.StringOf("response.result.invoice_profile.terms");
    var Total_accrued_revenue = jResp.StringOf("response.result.invoice_profile.total_accrued_revenue");
    var Updated = jResp.StringOf("response.result.invoice_profile.updated");
    var Vat_name = jResp.StringOf("response.result.invoice_profile.vat_name");
    var Vat_number = jResp.StringOf("response.result.invoice_profile.vat_number");
    var Vis_state = jResp.IntOf("response.result.invoice_profile.vis_state");

}

chilkatExample();

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "invoice_profile": {
    "vis_state": 1
  }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}

Postman Collection Item JSON

{
  "name": "Delete  Invoice Profile",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"invoice_profile\": {\n    \"vis_state\": 1\n  }\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "invoice_profiles",
        "invoice_profiles",
        "{{invoiceProfileId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Delete  Invoice Profile",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "type": "text",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"invoice_profile\": {\n    \"vis_state\": 1\n  }\n}"
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "invoice_profiles",
            "invoice_profiles",
            "{{invoiceProfileId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGPUAQVwRRVFFBCQxXF14IUAcURFgHDw9dERxUTVIZAAdfVAgOB1FSV1YIUAxQCQEYBgpJG1cEVVIDUg8FAFcACgNTVANAG1dWChdUaw=="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:17:40 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:40 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\": 456,\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\": 456,\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:40\",\n                \"vat_name\": null,\n                \"vat_number\": \"\",\n                \"vis_state\": 1\n            }\n        }\n    }\n}"
    }
  ]
}