Chilkat Online Tools

C# / New FreshBooks / Update Invoice Profile

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool 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": {
//     "frequency": "2w",
//     "numberRecurring": 12
//   }
// }

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("invoice_profile.frequency","2w");
json.UpdateInt("invoice_profile.numberRecurring",12);

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

Chilkat.StringBuilder sbRequestBody = new Chilkat.StringBuilder();
json.EmitSb(sbRequestBody);

Chilkat.HttpResponse 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) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

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

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("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": "2w",
//         "id": 456,
//         "include_unbilled_time": false,
//         "language": "en",
//         "lname": "one",
//         "notes": "",
//         "numberRecurring": 12,
//         "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:18:27",
//         "vat_name": null,
//         "vat_number": "",
//         "vis_state": 0
//       }
//     }
//   }
// }

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

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

Curl Command

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

Postman Collection Item JSON

{
  "name": "Update Invoice Profile",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"invoice_profile\": {\n    \"frequency\": \"2w\",\n    \"numberRecurring\": 12\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}}"
      ]
    },
    "description": "Update invoice profile to two weeks and increase the number of remaining invoices to 10.\n\n"
  },
  "response": [
    {
      "name": "Update Invoice Profile",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"invoice_profile\": {\n    \"frequency\": \"2w\",\n    \"numberRecurring\": 12\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": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGPUAQVwRRVFFBCQxXF14IUAcURFgHDw9dERxUTVIZAA5SUAAABlBUWlUJVQtUCwsYBQpJGwcJAwFRUVMAUFdWWVUIB1BAG1dWChdUaw=="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:18:27 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:18:27 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\": \"2w\",\n                \"id\": 456,\n                \"include_unbilled_time\": false,\n                \"language\": \"en\",\n                \"lname\": \"one\",\n                \"notes\": \"\",\n                \"numberRecurring\": 12,\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:18:27\",\n                \"vat_name\": null,\n                \"vat_number\": \"\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}