Chilkat Online Tools

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

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sId
    String sName
    String sV_type
    String sAccess_token
    String sConnection_id
    String sTax_code
    Integer j
    Integer iCount_j
    Integer i
    Integer iCount_i
    String sTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // Adds the "Authorization: Bearer <access_token>" header.
    Set ComAuthToken Of hoHttp To "<access_token>"
    Send ComSetRequestHeader To hoHttp "Accept" "application/json"

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComQuickGetSb Of hoHttp "https://api-v2.fattureincloud.it/user/companies" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComLastStatus Of hoHttp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComLastHeader Of hoHttp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_Return
    End

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

    Move 0 To i
    Get ComSizeOfArray Of hoJResp "data.companies" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "data.companies[i].id" To sId
        Get ComStringOf Of hoJResp "data.companies[i].name" To sName
        Get ComStringOf Of hoJResp "data.companies[i].type" To sV_type
        Get ComStringOf Of hoJResp "data.companies[i].access_token" To sAccess_token
        Get ComStringOf Of hoJResp "data.companies[i].connection_id" To sConnection_id
        Get ComStringOf Of hoJResp "data.companies[i].tax_code" To sTax_code
        Move 0 To j
        Get ComSizeOfArray Of hoJResp "data.companies[i].controlled_companies" To iCount_j
        While (j < iCount_j)
            Set ComJ Of hoJResp To j
            Get ComStringOf Of hoJResp "data.companies[i].controlled_companies[j].id" To sId
            Get ComStringOf Of hoJResp "data.companies[i].controlled_companies[j].name" To sName
            Get ComStringOf Of hoJResp "data.companies[i].controlled_companies[j].type" To sV_type
            Get ComStringOf Of hoJResp "data.companies[i].controlled_companies[j].access_token" To sAccess_token
            Get ComStringOf Of hoJResp "data.companies[i].controlled_companies[j].connection_id" To sConnection_id
            Get ComStringOf Of hoJResp "data.companies[i].controlled_companies[j].tax_code" To sTax_code
            Move (j + 1) To j
        Loop

        Move (i + 1) To i
    Loop



End_Procedure

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