Chilkat Online Tools

delphiAx / Fatture in Cloud API v2 - API Reference / Create Vat Type

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
Id: WideString;
Value: WideString;
Description: WideString;
Notes: WideString;
E_invoice: WideString;
Ei_type: WideString;
Ei_description: WideString;
Editable: WideString;
Is_disabled: WideString;

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

http := TChilkatHttp.Create(Self);

// 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 := TChilkatJsonObject.Create(Self);
json.UpdateString('data.value','<number>');
json.UpdateString('data.id','<integer>');
json.UpdateString('data.description','<string>');
json.UpdateString('data.notes','<string>');
json.UpdateString('data.e_invoice','<boolean>');
json.UpdateString('data.ei_type','<string>');
json.UpdateString('data.ei_description','<string>');
json.UpdateBool('data.editable',1);
json.UpdateString('data.is_disabled','<boolean>');

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

resp := http.PostJson3('https://api-v2.fattureincloud.it/c/:company_id/settings/vat_types','application/json',json.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

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

Id := jResp.StringOf('data.id');
Value := jResp.StringOf('data.value');
Description := jResp.StringOf('data.description');
Notes := jResp.StringOf('data.notes');
E_invoice := jResp.StringOf('data.e_invoice');
Ei_type := jResp.StringOf('data.ei_type');
Ei_description := jResp.StringOf('data.ei_description');
Editable := jResp.StringOf('data.editable');
Is_disabled := jResp.StringOf('data.is_disabled');

Curl Command

curl -X POST
	-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

Postman Collection Item JSON

{
  "name": "Create 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": "POST",
    "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",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "settings",
        "vat_types"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Creates a vat type."
  },
  "response": [
    {
      "name": "Example response",
      "originalRequest": {
        "method": "POST",
        "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "settings",
            "vat_types"
          ],
          "variable": [
            {
              "key": "company_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}"
    }
  ]
}