Chilkat Online Tools

Ruby / Fatture in Cloud API v2 - API Reference / List Clients

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("fields","<string>")
queryParams.UpdateString("fieldset","basic")
queryParams.UpdateString("sort","<string>")
queryParams.UpdateInt("page",1)
queryParams.UpdateInt("per_page",5)
queryParams.UpdateString("q","<string>")

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

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/entities/clients",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# {
#   "current_page": "<integer>",
#   "first_page_url": "<uri>",
#   "from": "<integer>",
#   "last_page": "<integer>",
#   "last_page_url": "<uri>",
#   "next_page_url": "<uri>",
#   "path": "<uri>",
#   "per_page": "<integer>",
#   "prev_page_url": "<uri>",
#   "to": "<integer>",
#   "total": "<integer>",
#   "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>"
#     },
#     {
#       "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

current_page = jResp.stringOf("current_page")
first_page_url = jResp.stringOf("first_page_url")
from = jResp.stringOf("from")
last_page = jResp.stringOf("last_page")
last_page_url = jResp.stringOf("last_page_url")
next_page_url = jResp.stringOf("next_page_url")
path = jResp.stringOf("path")
per_page = jResp.stringOf("per_page")
prev_page_url = jResp.stringOf("prev_page_url")
v_to = jResp.stringOf("to")
total = jResp.stringOf("total")
i = 0
count_i = jResp.SizeOfArray("data")
while i < count_i
    jResp.put_I(i)
    id = jResp.stringOf("data[i].id")
    code = jResp.stringOf("data[i].code")
    name = jResp.stringOf("data[i].name")
    v_type = jResp.stringOf("data[i].type")
    first_name = jResp.stringOf("data[i].first_name")
    last_name = jResp.stringOf("data[i].last_name")
    contact_person = jResp.stringOf("data[i].contact_person")
    vat_number = jResp.stringOf("data[i].vat_number")
    tax_code = jResp.stringOf("data[i].tax_code")
    address_street = jResp.stringOf("data[i].address_street")
    address_postal_code = jResp.stringOf("data[i].address_postal_code")
    address_city = jResp.stringOf("data[i].address_city")
    address_province = jResp.stringOf("data[i].address_province")
    address_extra = jResp.stringOf("data[i].address_extra")
    country = jResp.stringOf("data[i].country")
    email = jResp.stringOf("data[i].email")
    certified_email = jResp.stringOf("data[i].certified_email")
    phone = jResp.stringOf("data[i].phone")
    fax = jResp.stringOf("data[i].fax")
    notes = jResp.stringOf("data[i].notes")
    Id = jResp.stringOf("data[i].default_vat.id")
    Value = jResp.stringOf("data[i].default_vat.value")
    Description = jResp.stringOf("data[i].default_vat.description")
    Notes = jResp.stringOf("data[i].default_vat.notes")
    E_invoice = jResp.stringOf("data[i].default_vat.e_invoice")
    Ei_type = jResp.stringOf("data[i].default_vat.ei_type")
    Ei_description = jResp.stringOf("data[i].default_vat.ei_description")
    Editable = jResp.stringOf("data[i].default_vat.editable")
    Is_disabled = jResp.stringOf("data[i].default_vat.is_disabled")
    default_payment_terms = jResp.stringOf("data[i].default_payment_terms")
    default_payment_terms_type = jResp.stringOf("data[i].default_payment_terms_type")
    default_payment_methodId = jResp.stringOf("data[i].default_payment_method.id")
    Name = jResp.stringOf("data[i].default_payment_method.name")
    v_Type = jResp.stringOf("data[i].default_payment_method.type")
    Is_default = jResp.stringOf("data[i].default_payment_method.is_default")
    Default_payment_accountId = jResp.stringOf("data[i].default_payment_method.default_payment_account.id")
    Default_payment_accountName = jResp.stringOf("data[i].default_payment_method.default_payment_account.name")
    Default_payment_accountType = jResp.stringOf("data[i].default_payment_method.default_payment_account.type")
    Iban = jResp.stringOf("data[i].default_payment_method.default_payment_account.iban")
    Sia = jResp.stringOf("data[i].default_payment_method.default_payment_account.sia")
    Cuc = jResp.stringOf("data[i].default_payment_method.default_payment_account.cuc")
    v_Virtual = jResp.stringOf("data[i].default_payment_method.default_payment_account.virtual")
    Bank_iban = jResp.stringOf("data[i].default_payment_method.bank_iban")
    Bank_name = jResp.stringOf("data[i].default_payment_method.bank_name")
    Bank_beneficiary = jResp.stringOf("data[i].default_payment_method.bank_beneficiary")
    Ei_payment_method = jResp.stringOf("data[i].default_payment_method.ei_payment_method")
    bank_name = jResp.stringOf("data[i].bank_name")
    bank_iban = jResp.stringOf("data[i].bank_iban")
    bank_swift_code = jResp.stringOf("data[i].bank_swift_code")
    shipping_address = jResp.stringOf("data[i].shipping_address")
    e_invoice = jResp.stringOf("data[i].e_invoice")
    ei_code = jResp.stringOf("data[i].ei_code")
    discount_highlight = jResp.stringOf("data[i].discount_highlight")
    default_discount = jResp.stringOf("data[i].default_discount")
    has_intent_declaration = jResp.stringOf("data[i].has_intent_declaration")
    intent_declaration_protocol_number = jResp.stringOf("data[i].intent_declaration_protocol_number")
    intent_declaration_protocol_date = jResp.stringOf("data[i].intent_declaration_protocol_date")
    created_at = jResp.stringOf("data[i].created_at")
    updated_at = jResp.stringOf("data[i].updated_at")
    j = 0
    count_j = jResp.SizeOfArray("data[i].default_payment_method.details")
    while j < count_j
        jResp.put_J(j)
        title = jResp.stringOf("data[i].default_payment_method.details[j].title")
        description = jResp.stringOf("data[i].default_payment_method.details[j].description")
        j = j + 1
    end
    i = i + 1
end

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Clients",
  "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?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "entities",
        "clients"
      ],
      "query": [
        {
          "key": "fields",
          "value": "<string>",
          "description": "List of comma-separated fields."
        },
        {
          "key": "fieldset",
          "value": "basic",
          "description": "Name of the fieldset."
        },
        {
          "key": "sort",
          "value": "<string>",
          "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
        },
        {
          "key": "page",
          "value": "1",
          "description": "The page to retrieve."
        },
        {
          "key": "per_page",
          "value": "5",
          "description": "The size of the page."
        },
        {
          "key": "q",
          "value": "<string>",
          "description": "Query for filtering the results."
        }
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Lists the clients."
  },
  "response": [
    {
      "name": "Example response",
      "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?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "clients"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            },
            {
              "key": "sort",
              "value": "<string>",
              "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
            },
            {
              "key": "page",
              "value": "1",
              "description": "The page to retrieve."
            },
            {
              "key": "per_page",
              "value": "5",
              "description": "The size of the page."
            },
            {
              "key": "q",
              "value": "<string>",
              "description": "Query for filtering the results."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"current_page\": \"<integer>\",\n  \"first_page_url\": \"<uri>\",\n  \"from\": \"<integer>\",\n  \"last_page\": \"<integer>\",\n  \"last_page_url\": \"<uri>\",\n  \"next_page_url\": \"<uri>\",\n  \"path\": \"<uri>\",\n  \"per_page\": \"<integer>\",\n  \"prev_page_url\": \"<uri>\",\n  \"to\": \"<integer>\",\n  \"total\": \"<integer>\",\n  \"data\": [\n    {\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    {\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  ]\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?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "clients"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            },
            {
              "key": "sort",
              "value": "<string>",
              "description": "List of comma-separated fields for result sorting (minus for desc sorting)."
            },
            {
              "key": "page",
              "value": "1",
              "description": "The page to retrieve."
            },
            {
              "key": "per_page",
              "value": "5",
              "description": "The size of the page."
            },
            {
              "key": "q",
              "value": "<string>",
              "description": "Query for filtering the results."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}