Chilkat Online Tools

Android / Fatture in Cloud API v2 - API Reference / Get Client

Back to Collection Items

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkHttp http = new CkHttp();
    boolean success;

    CkJsonObject queryParams = new CkJsonObject();
    queryParams.UpdateString("fields","<string>");
    queryParams.UpdateString("fieldset","basic");

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken("<access_token>");
    http.SetRequestHeader("Accept","application/json");

    CkHttpResponse resp = http.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/entities/clients/:client_id",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    Log.i(TAG, "Response Body:");
    Log.i(TAG, jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
    if (respStatusCode >= 400) {
        Log.i(TAG, "Response Header:");
        Log.i(TAG, resp.header());
        Log.i(TAG, "Failed.");

        return;
        }

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

    // {
    //   "data": {
    //     "id": "<integer>",
    //     "code": "<string>",
    //     "name": "<string>",
    //     "type": null,
    //     "first_name": "<string>",
    //     "last_name": "<string>",
    //     "contact_person": "<string>",
    //     "vat_number": "<string>",
    //     "tax_code": "<string>",
    //     "address_street": "<string>",
    //     "address_postal_code": "<string>",
    //     "address_city": "<string>",
    //     "address_province": "<string>",
    //     "address_extra": "<string>",
    //     "country": "<string>",
    //     "email": "<string>",
    //     "certified_email": "<string>",
    //     "phone": "<string>",
    //     "fax": "<string>",
    //     "notes": "<string>",
    //     "default_vat": {
    //       "id": "<integer>",
    //       "value": "<number>",
    //       "description": "<string>",
    //       "notes": "<string>",
    //       "e_invoice": "<boolean>",
    //       "ei_type": "<string>",
    //       "ei_description": "<string>",
    //       "editable": "<boolean>",
    //       "is_disabled": "<boolean>"
    //     },
    //     "default_payment_terms": "<integer>",
    //     "default_payment_terms_type": "standard",
    //     "default_payment_method": {
    //       "id": "<integer>",
    //       "name": "<string>",
    //       "type": "standard",
    //       "is_default": "<boolean>",
    //       "default_payment_account": {
    //         "id": "<integer>",
    //         "name": "<string>",
    //         "type": "standard",
    //         "iban": "<string>",
    //         "sia": "<string>",
    //         "cuc": "<string>",
    //         "virtual": "<boolean>"
    //       },
    //       "details": [
    //         {
    //           "title": "<string>",
    //           "description": "<string>"
    //         },
    //         {
    //           "title": "<string>",
    //           "description": "<string>"
    //         }
    //       ],
    //       "bank_iban": "<string>",
    //       "bank_name": "<string>",
    //       "bank_beneficiary": "<string>",
    //       "ei_payment_method": "<string>"
    //     },
    //     "bank_name": "<string>",
    //     "bank_iban": "<string>",
    //     "bank_swift_code": "<string>",
    //     "shipping_address": "<string>",
    //     "e_invoice": "<boolean>",
    //     "ei_code": "<string>",
    //     "discount_highlight": "<boolean>",
    //     "default_discount": "<number>",
    //     "has_intent_declaration": "<boolean>",
    //     "intent_declaration_protocol_number": "<string>",
    //     "intent_declaration_protocol_date": "<date>",
    //     "created_at": "<string>",
    //     "updated_at": "<string>"
    //   }
    // }

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

    String title;
    String description;

    String Id = jResp.stringOf("data.id");
    String Code = jResp.stringOf("data.code");
    String Name = jResp.stringOf("data.name");
    String v_Type = jResp.stringOf("data.type");
    String First_name = jResp.stringOf("data.first_name");
    String Last_name = jResp.stringOf("data.last_name");
    String Contact_person = jResp.stringOf("data.contact_person");
    String Vat_number = jResp.stringOf("data.vat_number");
    String Tax_code = jResp.stringOf("data.tax_code");
    String Address_street = jResp.stringOf("data.address_street");
    String Address_postal_code = jResp.stringOf("data.address_postal_code");
    String Address_city = jResp.stringOf("data.address_city");
    String Address_province = jResp.stringOf("data.address_province");
    String Address_extra = jResp.stringOf("data.address_extra");
    String Country = jResp.stringOf("data.country");
    String v_Email = jResp.stringOf("data.email");
    String Certified_email = jResp.stringOf("data.certified_email");
    String Phone = jResp.stringOf("data.phone");
    String Fax = jResp.stringOf("data.fax");
    String Notes = jResp.stringOf("data.notes");
    String Default_vatId = jResp.stringOf("data.default_vat.id");
    String Value = jResp.stringOf("data.default_vat.value");
    String Description = jResp.stringOf("data.default_vat.description");
    String Default_vatNotes = jResp.stringOf("data.default_vat.notes");
    String E_invoice = jResp.stringOf("data.default_vat.e_invoice");
    String Ei_type = jResp.stringOf("data.default_vat.ei_type");
    String Ei_description = jResp.stringOf("data.default_vat.ei_description");
    String Editable = jResp.stringOf("data.default_vat.editable");
    String Is_disabled = jResp.stringOf("data.default_vat.is_disabled");
    String Default_payment_terms = jResp.stringOf("data.default_payment_terms");
    String Default_payment_terms_type = jResp.stringOf("data.default_payment_terms_type");
    String Default_payment_methodId = jResp.stringOf("data.default_payment_method.id");
    String Default_payment_methodName = jResp.stringOf("data.default_payment_method.name");
    String Default_payment_methodType = jResp.stringOf("data.default_payment_method.type");
    String Is_default = jResp.stringOf("data.default_payment_method.is_default");
    String Default_payment_accountId = jResp.stringOf("data.default_payment_method.default_payment_account.id");
    String Default_payment_accountName = jResp.stringOf("data.default_payment_method.default_payment_account.name");
    String Default_payment_accountType = jResp.stringOf("data.default_payment_method.default_payment_account.type");
    String Iban = jResp.stringOf("data.default_payment_method.default_payment_account.iban");
    String Sia = jResp.stringOf("data.default_payment_method.default_payment_account.sia");
    String Cuc = jResp.stringOf("data.default_payment_method.default_payment_account.cuc");
    String v_Virtual = jResp.stringOf("data.default_payment_method.default_payment_account.virtual");
    String Bank_iban = jResp.stringOf("data.default_payment_method.bank_iban");
    String Bank_name = jResp.stringOf("data.default_payment_method.bank_name");
    String Bank_beneficiary = jResp.stringOf("data.default_payment_method.bank_beneficiary");
    String Ei_payment_method = jResp.stringOf("data.default_payment_method.ei_payment_method");
    String dataBank_name = jResp.stringOf("data.bank_name");
    String dataBank_iban = jResp.stringOf("data.bank_iban");
    String Bank_swift_code = jResp.stringOf("data.bank_swift_code");
    String Shipping_address = jResp.stringOf("data.shipping_address");
    String dataE_invoice = jResp.stringOf("data.e_invoice");
    String Ei_code = jResp.stringOf("data.ei_code");
    String Discount_highlight = jResp.stringOf("data.discount_highlight");
    String Default_discount = jResp.stringOf("data.default_discount");
    String Has_intent_declaration = jResp.stringOf("data.has_intent_declaration");
    String Intent_declaration_protocol_number = jResp.stringOf("data.intent_declaration_protocol_number");
    String Intent_declaration_protocol_date = jResp.stringOf("data.intent_declaration_protocol_date");
    String Created_at = jResp.stringOf("data.created_at");
    String Updated_at = jResp.stringOf("data.updated_at");
    int i = 0;
    int count_i = jResp.SizeOfArray("data.default_payment_method.details");
    while (i < count_i) {
        jResp.put_I(i);
        title = jResp.stringOf("data.default_payment_method.details[i].title");
        description = jResp.stringOf("data.default_payment_method.details[i].description");
        i = i + 1;
        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

Curl Command

curl -G -d "fields=%3Cstring%3E"
	-d "fieldset=basic"
	-H "Authorization: Bearer <access_token>"
	-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/entities/clients/:client_id

Postman Collection Item JSON

{
  "name": "Get Client",
  "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": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/c/:company_id/entities/clients/:client_id?fields=<string>&fieldset=basic",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "entities",
        "clients",
        ":client_id"
      ],
      "query": [
        {
          "key": "fields",
          "value": "<string>",
          "description": "List of comma-separated fields."
        },
        {
          "key": "fieldset",
          "value": "basic",
          "description": "Name of the fieldset."
        }
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        },
        {
          "key": "client_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Gets the specified client."
  },
  "response": [
    {
      "name": "Client Details.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/entities/clients/:client_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "clients",
            ":client_id"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "client_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"id\": \"<integer>\",\n    \"code\": \"<string>\",\n    \"name\": \"<string>\",\n    \"type\": null,\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"contact_person\": \"<string>\",\n    \"vat_number\": \"<string>\",\n    \"tax_code\": \"<string>\",\n    \"address_street\": \"<string>\",\n    \"address_postal_code\": \"<string>\",\n    \"address_city\": \"<string>\",\n    \"address_province\": \"<string>\",\n    \"address_extra\": \"<string>\",\n    \"country\": \"<string>\",\n    \"email\": \"<string>\",\n    \"certified_email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"fax\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"default_vat\": {\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    \"default_payment_terms\": \"<integer>\",\n    \"default_payment_terms_type\": \"standard\",\n    \"default_payment_method\": {\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"type\": \"standard\",\n      \"is_default\": \"<boolean>\",\n      \"default_payment_account\": {\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\",\n        \"type\": \"standard\",\n        \"iban\": \"<string>\",\n        \"sia\": \"<string>\",\n        \"cuc\": \"<string>\",\n        \"virtual\": \"<boolean>\"\n      },\n      \"details\": [\n        {\n          \"title\": \"<string>\",\n          \"description\": \"<string>\"\n        },\n        {\n          \"title\": \"<string>\",\n          \"description\": \"<string>\"\n        }\n      ],\n      \"bank_iban\": \"<string>\",\n      \"bank_name\": \"<string>\",\n      \"bank_beneficiary\": \"<string>\",\n      \"ei_payment_method\": \"<string>\"\n    },\n    \"bank_name\": \"<string>\",\n    \"bank_iban\": \"<string>\",\n    \"bank_swift_code\": \"<string>\",\n    \"shipping_address\": \"<string>\",\n    \"e_invoice\": \"<boolean>\",\n    \"ei_code\": \"<string>\",\n    \"discount_highlight\": \"<boolean>\",\n    \"default_discount\": \"<number>\",\n    \"has_intent_declaration\": \"<boolean>\",\n    \"intent_declaration_protocol_number\": \"<string>\",\n    \"intent_declaration_protocol_date\": \"<date>\",\n    \"created_at\": \"<string>\",\n    \"updated_at\": \"<string>\"\n  }\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/entities/clients/:client_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "clients",
            ":client_id"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "client_id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/entities/clients/:client_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "clients",
            ":client_id"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "client_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}