Chilkat Online Tools

Node.js / Fatture in Cloud API v2 - API Reference / List Suppliers

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    var queryParams = new chilkat.JsonObject();
    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.AuthToken = "<access_token>";
    http.SetRequestHeader("Accept","application/json");

    // resp: HttpResponse
    var resp = http.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/entities/suppliers",queryParams);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

    // 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>",
    //       "bank_iban": "<string>",
    //       "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>",
    //       "bank_iban": "<string>",
    //       "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

    var id;
    var code;
    var name;
    var v_type;
    var first_name;
    var last_name;
    var contact_person;
    var vat_number;
    var tax_code;
    var address_street;
    var address_postal_code;
    var address_city;
    var address_province;
    var address_extra;
    var country;
    var email;
    var certified_email;
    var phone;
    var fax;
    var notes;
    var bank_iban;
    var created_at;
    var updated_at;

    var current_page = jResp.StringOf("current_page");
    var first_page_url = jResp.StringOf("first_page_url");
    var from = jResp.StringOf("from");
    var last_page = jResp.StringOf("last_page");
    var last_page_url = jResp.StringOf("last_page_url");
    var next_page_url = jResp.StringOf("next_page_url");
    var path = jResp.StringOf("path");
    var per_page = jResp.StringOf("per_page");
    var prev_page_url = jResp.StringOf("prev_page_url");
    var v_to = jResp.StringOf("to");
    var total = jResp.StringOf("total");
    var i = 0;
    var count_i = jResp.SizeOfArray("data");
    while (i < count_i) {
        jResp.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");
        bank_iban = jResp.StringOf("data[i].bank_iban");
        created_at = jResp.StringOf("data[i].created_at");
        updated_at = jResp.StringOf("data[i].updated_at");
        i = i+1;
    }


}

chilkatExample();

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

Postman Collection Item JSON

{
  "name": "List Suppliers",
  "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/suppliers?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "entities",
        "suppliers"
      ],
      "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 suppliers."
  },
  "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/suppliers?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "suppliers"
          ],
          "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      \"bank_iban\": \"<string>\",\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      \"bank_iban\": \"<string>\",\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/suppliers?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "suppliers"
          ],
          "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": ""
    }
  ]
}