Chilkat Online Tools

Unicode C++ / Fatture in Cloud API v2 - API Reference / List Clients

Back to Collection Items

void ChilkatSample(void)
    {
    queryParams.UpdateString(L"fields",L"<string>");    queryParams.UpdateString(L"fieldset",L"basic");    queryParams.UpdateString(L"sort",L"<string>");    queryParams.UpdateInt(L"page",1);    queryParams.UpdateInt(L"per_page",5);    queryParams.UpdateString(L"q",L"<string>");    http.put_AuthToken(L"<access_token>");    resp->GetBodySb(sbResponseBody);    jResp.LoadSb(sbResponseBody);    jResp.put_EmitCompact(false);    jResp.put_I(i);    id = jResp.stringOf(L"data[i].id");    code = jResp.stringOf(L"data[i].code");    name = jResp.stringOf(L"data[i].name");    v_type = jResp.stringOf(L"data[i].type");    first_name = jResp.stringOf(L"data[i].first_name");    last_name = jResp.stringOf(L"data[i].last_name");    contact_person = jResp.stringOf(L"data[i].contact_person");    vat_number = jResp.stringOf(L"data[i].vat_number");    tax_code = jResp.stringOf(L"data[i].tax_code");    address_street = jResp.stringOf(L"data[i].address_street");    address_postal_code = jResp.stringOf(L"data[i].address_postal_code");    address_city = jResp.stringOf(L"data[i].address_city");    address_province = jResp.stringOf(L"data[i].address_province");    address_extra = jResp.stringOf(L"data[i].address_extra");    country = jResp.stringOf(L"data[i].country");    email = jResp.stringOf(L"data[i].email");    certified_email = jResp.stringOf(L"data[i].certified_email");    phone = jResp.stringOf(L"data[i].phone");    fax = jResp.stringOf(L"data[i].fax");    notes = jResp.stringOf(L"data[i].notes");    Id = jResp.stringOf(L"data[i].default_vat.id");    Value = jResp.stringOf(L"data[i].default_vat.value");    Description = jResp.stringOf(L"data[i].default_vat.description");    Notes = jResp.stringOf(L"data[i].default_vat.notes");    E_invoice = jResp.stringOf(L"data[i].default_vat.e_invoice");    Ei_type = jResp.stringOf(L"data[i].default_vat.ei_type");    Ei_description = jResp.stringOf(L"data[i].default_vat.ei_description");    Editable = jResp.stringOf(L"data[i].default_vat.editable");    Is_disabled = jResp.stringOf(L"data[i].default_vat.is_disabled");    default_payment_terms = jResp.stringOf(L"data[i].default_payment_terms");    default_payment_terms_type = jResp.stringOf(L"data[i].default_payment_terms_type");    default_payment_methodId = jResp.stringOf(L"data[i].default_payment_method.id");    Name = jResp.stringOf(L"data[i].default_payment_method.name");    v_Type = jResp.stringOf(L"data[i].default_payment_method.type");    Is_default = jResp.stringOf(L"data[i].default_payment_method.is_default");    Default_payment_accountId = jResp.stringOf(L"data[i].default_payment_method.default_payment_account.id");    Default_payment_accountName = jResp.stringOf(L"data[i].default_payment_method.default_payment_account.name");    Default_payment_accountType = jResp.stringOf(L"data[i].default_payment_method.default_payment_account.type");    Iban = jResp.stringOf(L"data[i].default_payment_method.default_payment_account.iban");    Sia = jResp.stringOf(L"data[i].default_payment_method.default_payment_account.sia");    Cuc = jResp.stringOf(L"data[i].default_payment_method.default_payment_account.cuc");    v_Virtual = jResp.stringOf(L"data[i].default_payment_method.default_payment_account.virtual");    Bank_iban = jResp.stringOf(L"data[i].default_payment_method.bank_iban");    Bank_name = jResp.stringOf(L"data[i].default_payment_method.bank_name");    Bank_beneficiary = jResp.stringOf(L"data[i].default_payment_method.bank_beneficiary");    Ei_payment_method = jResp.stringOf(L"data[i].default_payment_method.ei_payment_method");    bank_name = jResp.stringOf(L"data[i].bank_name");    bank_iban = jResp.stringOf(L"data[i].bank_iban");    bank_swift_code = jResp.stringOf(L"data[i].bank_swift_code");    shipping_address = jResp.stringOf(L"data[i].shipping_address");    e_invoice = jResp.stringOf(L"data[i].e_invoice");    ei_code = jResp.stringOf(L"data[i].ei_code");    discount_highlight = jResp.stringOf(L"data[i].discount_highlight");    default_discount = jResp.stringOf(L"data[i].default_discount");    has_intent_declaration = jResp.stringOf(L"data[i].has_intent_declaration");    intent_declaration_protocol_number = jResp.stringOf(L"data[i].intent_declaration_protocol_number");    intent_declaration_protocol_date = jResp.stringOf(L"data[i].intent_declaration_protocol_date");    created_at = jResp.stringOf(L"data[i].created_at");    updated_at = jResp.stringOf(L"data[i].updated_at");    j = 0;    count_j = jResp.SizeOfArray(L"data[i].default_payment_method.details");    jResp.put_J(j);    title = jResp.stringOf(L"data[i].default_payment_method.details[j].title");    description = jResp.stringOf(L"data[i].default_payment_method.details[j].description");    j = j + 1;    i = i + 1;
    }

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": ""
    }
  ]
}