Chilkat Online Tools

unicodeC / Fatture in Cloud API v2 - API Reference / Modify Vat Type

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 *Id;
    const wchar_t *Value;
    const wchar_t *Description;
    const wchar_t *Notes;
    const wchar_t *E_invoice;
    const wchar_t *Ei_type;
    const wchar_t *Ei_description;
    const wchar_t *Editable;
    const wchar_t *Is_disabled;

    // 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.

    // {
    //   "data": {
    //     "value": "<number>",
    //     "id": "<integer>",
    //     "description": "<string>",
    //     "notes": "<string>",
    //     "e_invoice": "<boolean>",
    //     "ei_type": "<string>",
    //     "ei_description": "<string>",
    //     "editable": true,
    //     "is_disabled": "<boolean>"
    //   }
    // }

    json = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(json,L"data.value",L"<number>");
    CkJsonObjectW_UpdateString(json,L"data.id",L"<integer>");
    CkJsonObjectW_UpdateString(json,L"data.description",L"<string>");
    CkJsonObjectW_UpdateString(json,L"data.notes",L"<string>");
    CkJsonObjectW_UpdateString(json,L"data.e_invoice",L"<boolean>");
    CkJsonObjectW_UpdateString(json,L"data.ei_type",L"<string>");
    CkJsonObjectW_UpdateString(json,L"data.ei_description",L"<string>");
    CkJsonObjectW_UpdateBool(json,L"data.editable",TRUE);
    CkJsonObjectW_UpdateString(json,L"data.is_disabled",L"<boolean>");

    CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
    // Adds the "Authorization: Bearer <access_token>" header.
    CkHttpW_putAuthToken(http,L"<access_token>");
    CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");

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

    resp = CkHttpW_PTextSb(http,L"PUT",L"https://api-v2.fattureincloud.it/c/:company_id/settings/vat_types/:vat_type_id",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)

    // {
    //   "data": {
    //     "id": "<integer>",
    //     "value": "<number>",
    //     "description": "<string>",
    //     "notes": "<string>",
    //     "e_invoice": "<boolean>",
    //     "ei_type": "<string>",
    //     "ei_description": "<string>",
    //     "editable": "<boolean>",
    //     "is_disabled": "<boolean>"
    //   }
    // }

    // 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.

    Id = CkJsonObjectW_stringOf(jResp,L"data.id");
    Value = CkJsonObjectW_stringOf(jResp,L"data.value");
    Description = CkJsonObjectW_stringOf(jResp,L"data.description");
    Notes = CkJsonObjectW_stringOf(jResp,L"data.notes");
    E_invoice = CkJsonObjectW_stringOf(jResp,L"data.e_invoice");
    Ei_type = CkJsonObjectW_stringOf(jResp,L"data.ei_type");
    Ei_description = CkJsonObjectW_stringOf(jResp,L"data.ei_description");
    Editable = CkJsonObjectW_stringOf(jResp,L"data.editable");
    Is_disabled = CkJsonObjectW_stringOf(jResp,L"data.is_disabled");


    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>"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "value": "<number>",
    "id": "<integer>",
    "description": "<string>",
    "notes": "<string>",
    "e_invoice": "<boolean>",
    "ei_type": "<string>",
    "ei_description": "<string>",
    "editable": true,
    "is_disabled": "<boolean>"
  }
}'
https://api-v2.fattureincloud.it/c/:company_id/settings/vat_types/:vat_type_id

Postman Collection Item JSON

{
  "name": "Modify Vat Type",
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": [
        {
          "key": "scope",
          "value": "entity.clients:r entity.clients:a entity.suppliers:r entity.suppliers:a products:r products:a issued_documents.invoices:r issued_documents.credit_notes:r issued_documents.receipts:r issued_documents.orders:r issued_documents.quotes:r issued_documents.proformas:r issued_documents.delivery_notes:r issued_documents.work_reports:r issued_documents.supplier_orders:r issued_documents.self_invoices:r issued_documents.invoices:a issued_documents.credit_notes:a issued_documents.receipts:a issued_documents.orders:a issued_documents.quotes:a issued_documents.proformas:a issued_documents.delivery_notes:a issued_documents.work_reports:a issued_documents.supplier_orders:a issued_documents.self_invoices:a received_documents:r received_documents:a stock:r stock:a receipts:r receipts:a taxes:r taxes:a archive:r archive:a cashbook:r cashbook:a settings:r settings:a situation:r",
          "type": "string"
        },
        {
          "key": "redirect_uri",
          "value": "https://api-v2.fattureincloud.it/oauth/token",
          "type": "string"
        },
        {
          "key": "accessTokenUrl",
          "value": "https://api-v2.fattureincloud.it/oauth/token",
          "type": "string"
        },
        {
          "key": "authUrl",
          "value": "https://api-v2.fattureincloud.it/oauth/authorize",
          "type": "string"
        },
        {
          "key": "grant_type",
          "value": "authorization_code",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"value\": \"<number>\",\n    \"id\": \"<integer>\",\n    \"description\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"e_invoice\": \"<boolean>\",\n    \"ei_type\": \"<string>\",\n    \"ei_description\": \"<string>\",\n    \"editable\": true,\n    \"is_disabled\": \"<boolean>\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/c/:company_id/settings/vat_types/:vat_type_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "settings",
        "vat_types",
        ":vat_type_id"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        },
        {
          "key": "vat_type_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Modifies the specified vat type."
  },
  "response": [
    {
      "name": "Example response",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"value\": \"<number>\",\n    \"id\": \"<integer>\",\n    \"description\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"e_invoice\": \"<boolean>\",\n    \"ei_type\": \"<string>\",\n    \"ei_description\": \"<string>\",\n    \"editable\": true,\n    \"is_disabled\": \"<boolean>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/settings/vat_types/:vat_type_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "settings",
            "vat_types",
            ":vat_type_id"
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "vat_type_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"id\": \"<integer>\",\n    \"value\": \"<number>\",\n    \"description\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"e_invoice\": \"<boolean>\",\n    \"ei_type\": \"<string>\",\n    \"ei_description\": \"<string>\",\n    \"editable\": \"<boolean>\",\n    \"is_disabled\": \"<boolean>\"\n  }\n}"
    }
  ]
}