Chilkat Online Tools

autoit / Fatture in Cloud API v2 - API Reference / List User Companies

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Accept","application/json"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api-v2.fattureincloud.it/user/companies",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

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

; {
;   "data": {
;     "companies": [
;       {
;         "id": "<integer>",
;         "name": "<string>",
;         "type": "accountant",
;         "access_token": "<string>",
;         "controlled_companies": [
;           {
;             "id": "<integer>",
;             "name": "<string>",
;             "type": "accountant",
;             "access_token": "<string>",
;             "connection_id": "<number>",
;             "tax_code": "<string>"
;           },
;           {
;             "id": "<integer>",
;             "name": "<string>",
;             "type": "accountant",
;             "access_token": "<string>",
;             "connection_id": "<number>",
;             "tax_code": "<string>"
;           }
;         ],
;         "connection_id": "<integer>",
;         "tax_code": "<string>"
;       },
;       {
;         "id": "<integer>",
;         "name": "<string>",
;         "type": "company",
;         "access_token": "<string>",
;         "controlled_companies": [
;           {
;             "id": "<integer>",
;             "name": "<string>",
;             "type": "accountant",
;             "access_token": "<string>",
;             "connection_id": "<number>",
;             "tax_code": "<string>"
;           },
;           {
;             "id": "<integer>",
;             "name": "<string>",
;             "type": "company",
;             "access_token": "<string>",
;             "connection_id": "<number>",
;             "tax_code": "<string>"
;           }
;         ],
;         "connection_id": "<integer>",
;         "tax_code": "<string>"
;       }
;     ]
;   }
; }

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

Local $sId
Local $sName
Local $sV_type
Local $sAccess_token
Local $sConnection_id
Local $sTax_code
Local $iJ
Local $iCount_j

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data.companies")
While $i < $iCount_i
    $oJResp.I = $i
    $sId = $oJResp.StringOf("data.companies[i].id")
    $sName = $oJResp.StringOf("data.companies[i].name")
    $sV_type = $oJResp.StringOf("data.companies[i].type")
    $sAccess_token = $oJResp.StringOf("data.companies[i].access_token")
    $sConnection_id = $oJResp.StringOf("data.companies[i].connection_id")
    $sTax_code = $oJResp.StringOf("data.companies[i].tax_code")
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("data.companies[i].controlled_companies")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $sId = $oJResp.StringOf("data.companies[i].controlled_companies[j].id")
        $sName = $oJResp.StringOf("data.companies[i].controlled_companies[j].name")
        $sV_type = $oJResp.StringOf("data.companies[i].controlled_companies[j].type")
        $sAccess_token = $oJResp.StringOf("data.companies[i].controlled_companies[j].access_token")
        $sConnection_id = $oJResp.StringOf("data.companies[i].controlled_companies[j].connection_id")
        $sTax_code = $oJResp.StringOf("data.companies[i].controlled_companies[j].tax_code")
        $iJ = $iJ + 1
    Wend
    $i = $i + 1
Wend

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Accept: application/json"
https://api-v2.fattureincloud.it/user/companies

Postman Collection Item JSON

{
  "name": "List User Companies",
  "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}}/user/companies",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "user",
        "companies"
      ]
    },
    "description": "Lists the companies controlled by the current user."
  },
  "response": [
    {
      "name": "User Companies.",
      "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}}/user/companies",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "user",
            "companies"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"companies\": [\n      {\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\",\n        \"type\": \"accountant\",\n        \"access_token\": \"<string>\",\n        \"controlled_companies\": [\n          {\n            \"id\": \"<integer>\",\n            \"name\": \"<string>\",\n            \"type\": \"accountant\",\n            \"access_token\": \"<string>\",\n            \"connection_id\": \"<number>\",\n            \"tax_code\": \"<string>\"\n          },\n          {\n            \"id\": \"<integer>\",\n            \"name\": \"<string>\",\n            \"type\": \"accountant\",\n            \"access_token\": \"<string>\",\n            \"connection_id\": \"<number>\",\n            \"tax_code\": \"<string>\"\n          }\n        ],\n        \"connection_id\": \"<integer>\",\n        \"tax_code\": \"<string>\"\n      },\n      {\n        \"id\": \"<integer>\",\n        \"name\": \"<string>\",\n        \"type\": \"company\",\n        \"access_token\": \"<string>\",\n        \"controlled_companies\": [\n          {\n            \"id\": \"<integer>\",\n            \"name\": \"<string>\",\n            \"type\": \"accountant\",\n            \"access_token\": \"<string>\",\n            \"connection_id\": \"<number>\",\n            \"tax_code\": \"<string>\"\n          },\n          {\n            \"id\": \"<integer>\",\n            \"name\": \"<string>\",\n            \"type\": \"company\",\n            \"access_token\": \"<string>\",\n            \"connection_id\": \"<number>\",\n            \"tax_code\": \"<string>\"\n          }\n        ],\n        \"connection_id\": \"<integer>\",\n        \"tax_code\": \"<string>\"\n      }\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}}/user/companies",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "user",
            "companies"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}