Chilkat Online Tools

unicodeC / New FreshBooks / Delete Credit

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW json;
    HCkStringBuilderW sbRequestBody;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *Accounting_systemid;
    const wchar_t *Amount;
    const wchar_t *Code;
    const wchar_t *City;
    int Clientid;
    const wchar_t *Credit_noteCode;
    const wchar_t *Country;
    const wchar_t *Create_date;
    const wchar_t *Credit_number;
    const wchar_t *Credit_type;
    int Creditid;
    const wchar_t *Currency_code;
    const wchar_t *Current_organization;
    const wchar_t *Description;
    const wchar_t *Display_status;
    const wchar_t *Dispute_status;
    int Ext_archive;
    const wchar_t *Fname;
    int Id;
    const wchar_t *Language;
    const wchar_t *Last_order_status;
    const wchar_t *Lname;
    const wchar_t *Notes;
    const wchar_t *Organization;
    const wchar_t *PaidAmount;
    const wchar_t *PaidCode;
    const wchar_t *Payment_status;
    const wchar_t *Province;
    int Sentid;
    const wchar_t *Status;
    const wchar_t *Street;
    const wchar_t *Street2;
    const wchar_t *Template;
    const wchar_t *Terms;
    const wchar_t *Vat_name;
    const wchar_t *Vat_number;
    int Vis_state;

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

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

    json = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateInt(json,L"credit_note.vis_state",1);

    // Adds the "Authorization: Bearer <access_token>" header.
    CkHttpW_putAuthToken(http,L"<access_token>");

    sbRequestBody = CkStringBuilderW_Create();
    CkJsonObjectW_EmitSb(json,sbRequestBody);

    resp = CkHttpW_PTextSb(http,L"PUT",L"https://api.freshbooks.com/accounting/account/{{accountId}}/credit_notes/credit_notes/{{creditId}}",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbRequestBody);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbRequestBody);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(resp);

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "response": {
    //     "result": {
    //       "credit_note": {
    //         "accounting_systemid": "E86Qp",
    //         "amount": {
    //           "amount": "150.00",
    //           "code": "CAD"
    //         },
    //         "city": "",
    //         "clientid": 599843,
    //         "code": "",
    //         "country": "",
    //         "create_date": "2020-07-31",
    //         "credit_number": "0000069",
    //         "credit_type": "goodwill",
    //         "creditid": 30947,
    //         "currency_code": "CAD",
    //         "current_organization": "Squarespace",
    //         "description": "Goodwill Credit",
    //         "display_status": "created",
    //         "dispute_status": null,
    //         "ext_archive": 0,
    //         "fname": "",
    //         "id": 30947,
    //         "language": "en",
    //         "last_order_status": null,
    //         "lname": "",
    //         "notes": "Free $150 voucher",
    //         "organization": "Squarespace",
    //         "paid": {
    //           "amount": "150.00",
    //           "code": "CAD"
    //         },
    //         "payment_status": "paid",
    //         "province": "",
    //         "sentid": 1,
    //         "status": "created",
    //         "street": "",
    //         "street2": "",
    //         "template": "clean-grouped",
    //         "terms": "Will be applied to future invoice",
    //         "vat_name": "",
    //         "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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    Accounting_systemid = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.accounting_systemid");
    Amount = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.amount.amount");
    Code = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.amount.code");
    City = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.city");
    Clientid = CkJsonObjectW_IntOf(jResp,L"response.result.credit_note.clientid");
    Credit_noteCode = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.code");
    Country = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.country");
    Create_date = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.create_date");
    Credit_number = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.credit_number");
    Credit_type = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.credit_type");
    Creditid = CkJsonObjectW_IntOf(jResp,L"response.result.credit_note.creditid");
    Currency_code = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.currency_code");
    Current_organization = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.current_organization");
    Description = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.description");
    Display_status = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.display_status");
    Dispute_status = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.dispute_status");
    Ext_archive = CkJsonObjectW_IntOf(jResp,L"response.result.credit_note.ext_archive");
    Fname = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.fname");
    Id = CkJsonObjectW_IntOf(jResp,L"response.result.credit_note.id");
    Language = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.language");
    Last_order_status = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.last_order_status");
    Lname = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.lname");
    Notes = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.notes");
    Organization = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.organization");
    PaidAmount = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.paid.amount");
    PaidCode = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.paid.code");
    Payment_status = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.payment_status");
    Province = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.province");
    Sentid = CkJsonObjectW_IntOf(jResp,L"response.result.credit_note.sentid");
    Status = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.status");
    Street = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.street");
    Street2 = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.street2");
    Template = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.template");
    Terms = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.terms");
    Vat_name = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.vat_name");
    Vat_number = CkJsonObjectW_stringOf(jResp,L"response.result.credit_note.vat_number");
    Vis_state = CkJsonObjectW_IntOf(jResp,L"response.result.credit_note.vis_state");


    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(json);
    CkStringBuilderW_Dispose(sbRequestBody);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
  "credit_note": {
    "vis_state": 1
  }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/credit_notes/credit_notes/{{creditId}}

Postman Collection Item JSON

{
  "name": "Delete Credit",
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"credit_note\": {\n    \"vis_state\": 1\n  }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/credit_notes/credit_notes/{{creditId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "credit_notes",
        "credit_notes",
        "{{creditId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Delete Credit",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"credit_note\": {\n    \"vis_state\": 1\n  }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/credit_notes/credit_notes/{{creditId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "credit_notes",
            "credit_notes",
            "{{creditId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Date",
          "value": "Fri, 11 Sep 2020 14:41:22 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gHQ1NXCxI8DF8WXRECW0ZXVwxND14VVkBIBhtRSFALCwZUV1ECBgJRUAUAAVtKV1ccQAAGDlsEBVYECwAGAAsBUwYVTQACVEBVOQ=="
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "Content-Security-Policy",
          "value": "default-src 'self'"
        },
        {
          "key": "X-Content-Security-Policy",
          "value": "default-src 'self'"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31556926; includeSubDomains; preload"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin-when-cross-origin"
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "600"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "595"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1599835343"
        },
        {
          "key": "Retry-After",
          "value": "60"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Alt-Svc",
          "value": "h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"response\": {\n        \"result\": {\n            \"credit_note\": {\n                \"accounting_systemid\": \"E86Qp\",\n                \"amount\": {\n                    \"amount\": \"150.00\",\n                    \"code\": \"CAD\"\n                },\n                \"city\": \"\",\n                \"clientid\": 599843,\n                \"code\": \"\",\n                \"country\": \"\",\n                \"create_date\": \"2020-07-31\",\n                \"credit_number\": \"0000069\",\n                \"credit_type\": \"goodwill\",\n                \"creditid\": 30947,\n                \"currency_code\": \"CAD\",\n                \"current_organization\": \"Squarespace\",\n                \"description\": \"Goodwill Credit\",\n                \"display_status\": \"created\",\n                \"dispute_status\": null,\n                \"ext_archive\": 0,\n                \"fname\": \"\",\n                \"id\": 30947,\n                \"language\": \"en\",\n                \"last_order_status\": null,\n                \"lname\": \"\",\n                \"notes\": \"Free $150 voucher\",\n                \"organization\": \"Squarespace\",\n                \"paid\": {\n                    \"amount\": \"150.00\",\n                    \"code\": \"CAD\"\n                },\n                \"payment_status\": \"paid\",\n                \"province\": \"\",\n                \"sentid\": 1,\n                \"status\": \"created\",\n                \"street\": \"\",\n                \"street2\": \"\",\n                \"template\": \"clean-grouped\",\n                \"terms\": \"Will be applied to future invoice\",\n                \"vat_name\": \"\",\n                \"vat_number\": \"\",\n                \"vis_state\": 1\n            }\n        }\n    }\n}"
    }
  ]
}