Chilkat Online Tools

autoit / Fatture in Cloud API v2 - API Reference / Get Company Info

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_9_5_0.Http")
Local $bSuccess

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

$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api-v2.fattureincloud.it/c/:company_id/company/info",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat_9_5_0.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": {
;     "id": "<integer>",
;     "name": "<string>",
;     "email": "<string>",
;     "type": "accountant",
;     "access_info": {
;       "role": "subaccount",
;       "permissions": {
;         "fic_situation": "read",
;         "fic_clients": "none",
;         "fic_suppliers": "none",
;         "fic_products": "read",
;         "fic_issued_documents": "write",
;         "fic_received_documents": "write",
;         "fic_receipts": "write",
;         "fic_calendar": "detailed",
;         "fic_archive": "detailed",
;         "fic_taxes": "read",
;         "fic_stock": "read",
;         "fic_cashbook": "write",
;         "fic_settings": "read",
;         "fic_emails": "none",
;         "fic_export": "detailed",
;         "fic_import_bankstatements": "none",
;         "fic_import_clients_suppliers": "none",
;         "fic_import_issued_documents": "read",
;         "fic_import_products": "write",
;         "fic_recurring": "none",
;         "fic_riba": "none",
;         "dic_employees": "none",
;         "dic_settings": "read",
;         "dic_timesheet": "read",
;         "fic_issued_documents_detailed": {
;           "quotes": "none",
;           "proformas": "write",
;           "invoices": "write",
;           "receipts": "write",
;           "delivery_notes": "detailed",
;           "credit_notes": "none",
;           "orders": "write",
;           "work_reports": "none",
;           "supplier_orders": "detailed",
;           "self_invoices": "detailed"
;         }
;       },
;       "through_accountant": "<boolean>"
;     },
;     "plan_info": {
;       "limits": {
;         "clients": "<integer>",
;         "suppliers": "<integer>",
;         "products": "<integer>",
;         "documents": "<integer>"
;       },
;       "functions": {
;         "archive": "<boolean>",
;         "cerved": "<boolean>",
;         "document_attachments": "<boolean>",
;         "e_invoice": "<boolean>",
;         "genius": "<boolean>",
;         "mail_tracking": "<boolean>",
;         "payment_notifications": "<boolean>",
;         "paypal": "<boolean>",
;         "receipts": "<boolean>",
;         "recurring": "<boolean>",
;         "smtp": "<boolean>",
;         "sofort": "<boolean>",
;         "stock": "<boolean>",
;         "subaccounts": "<boolean>",
;         "tessera_sanitaria": "<boolean>",
;         "ts_digital": "<boolean>",
;         "ts_invoice_trading": "<boolean>",
;         "ts_pay": "<boolean>"
;       },
;       "functions_status": {
;         "ts_digital": {
;           "active": "<boolean>"
;         },
;         "ts_pay": {
;           "active": "<boolean>"
;         }
;       }
;     },
;     "accountant_id": "<integer>",
;     "is_accountant": "<boolean>"
;   }
; }

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

Local $sId = $oJResp.StringOf("data.id")
Local $sName = $oJResp.StringOf("data.name")
Local $sV_Email = $oJResp.StringOf("data.email")
Local $sV_Type = $oJResp.StringOf("data.type")
Local $sRole = $oJResp.StringOf("data.access_info.role")
Local $sFic_situation = $oJResp.StringOf("data.access_info.permissions.fic_situation")
Local $sFic_clients = $oJResp.StringOf("data.access_info.permissions.fic_clients")
Local $sFic_suppliers = $oJResp.StringOf("data.access_info.permissions.fic_suppliers")
Local $sFic_products = $oJResp.StringOf("data.access_info.permissions.fic_products")
Local $sFic_issued_documents = $oJResp.StringOf("data.access_info.permissions.fic_issued_documents")
Local $sFic_received_documents = $oJResp.StringOf("data.access_info.permissions.fic_received_documents")
Local $sFic_receipts = $oJResp.StringOf("data.access_info.permissions.fic_receipts")
Local $sFic_calendar = $oJResp.StringOf("data.access_info.permissions.fic_calendar")
Local $sFic_archive = $oJResp.StringOf("data.access_info.permissions.fic_archive")
Local $sFic_taxes = $oJResp.StringOf("data.access_info.permissions.fic_taxes")
Local $sFic_stock = $oJResp.StringOf("data.access_info.permissions.fic_stock")
Local $sFic_cashbook = $oJResp.StringOf("data.access_info.permissions.fic_cashbook")
Local $sFic_settings = $oJResp.StringOf("data.access_info.permissions.fic_settings")
Local $sFic_emails = $oJResp.StringOf("data.access_info.permissions.fic_emails")
Local $sFic_export = $oJResp.StringOf("data.access_info.permissions.fic_export")
Local $sFic_import_bankstatements = $oJResp.StringOf("data.access_info.permissions.fic_import_bankstatements")
Local $sFic_import_clients_suppliers = $oJResp.StringOf("data.access_info.permissions.fic_import_clients_suppliers")
Local $sFic_import_issued_documents = $oJResp.StringOf("data.access_info.permissions.fic_import_issued_documents")
Local $sFic_import_products = $oJResp.StringOf("data.access_info.permissions.fic_import_products")
Local $sFic_recurring = $oJResp.StringOf("data.access_info.permissions.fic_recurring")
Local $sFic_riba = $oJResp.StringOf("data.access_info.permissions.fic_riba")
Local $sDic_employees = $oJResp.StringOf("data.access_info.permissions.dic_employees")
Local $sDic_settings = $oJResp.StringOf("data.access_info.permissions.dic_settings")
Local $sDic_timesheet = $oJResp.StringOf("data.access_info.permissions.dic_timesheet")
Local $sQuotes = $oJResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.quotes")
Local $sProformas = $oJResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.proformas")
Local $sInvoices = $oJResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.invoices")
Local $sReceipts = $oJResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.receipts")
Local $sDelivery_notes = $oJResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.delivery_notes")
Local $sCredit_notes = $oJResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.credit_notes")
Local $sOrders = $oJResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.orders")
Local $sWork_reports = $oJResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.work_reports")
Local $sSupplier_orders = $oJResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.supplier_orders")
Local $sSelf_invoices = $oJResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.self_invoices")
Local $sThrough_accountant = $oJResp.StringOf("data.access_info.through_accountant")
Local $sClients = $oJResp.StringOf("data.plan_info.limits.clients")
Local $sSuppliers = $oJResp.StringOf("data.plan_info.limits.suppliers")
Local $sProducts = $oJResp.StringOf("data.plan_info.limits.products")
Local $sDocuments = $oJResp.StringOf("data.plan_info.limits.documents")
Local $sArchive = $oJResp.StringOf("data.plan_info.functions.archive")
Local $sCerved = $oJResp.StringOf("data.plan_info.functions.cerved")
Local $sDocument_attachments = $oJResp.StringOf("data.plan_info.functions.document_attachments")
Local $sE_invoice = $oJResp.StringOf("data.plan_info.functions.e_invoice")
Local $sGenius = $oJResp.StringOf("data.plan_info.functions.genius")
Local $sMail_tracking = $oJResp.StringOf("data.plan_info.functions.mail_tracking")
Local $sPayment_notifications = $oJResp.StringOf("data.plan_info.functions.payment_notifications")
Local $sPaypal = $oJResp.StringOf("data.plan_info.functions.paypal")
Local $sFunctionsReceipts = $oJResp.StringOf("data.plan_info.functions.receipts")
Local $sRecurring = $oJResp.StringOf("data.plan_info.functions.recurring")
Local $sSmtp = $oJResp.StringOf("data.plan_info.functions.smtp")
Local $sSofort = $oJResp.StringOf("data.plan_info.functions.sofort")
Local $sStock = $oJResp.StringOf("data.plan_info.functions.stock")
Local $sSubaccounts = $oJResp.StringOf("data.plan_info.functions.subaccounts")
Local $sTessera_sanitaria = $oJResp.StringOf("data.plan_info.functions.tessera_sanitaria")
Local $sTs_digital = $oJResp.StringOf("data.plan_info.functions.ts_digital")
Local $sTs_invoice_trading = $oJResp.StringOf("data.plan_info.functions.ts_invoice_trading")
Local $sTs_pay = $oJResp.StringOf("data.plan_info.functions.ts_pay")
Local $sActive = $oJResp.StringOf("data.plan_info.functions_status.ts_digital.active")
Local $sTs_payActive = $oJResp.StringOf("data.plan_info.functions_status.ts_pay.active")
Local $sAccountant_id = $oJResp.StringOf("data.accountant_id")
Local $sIs_accountant = $oJResp.StringOf("data.is_accountant")

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/company/info

Postman Collection Item JSON

{
  "name": "Get Company Info",
  "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/company/info",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "company",
        "info"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Gets the company detailed info."
  },
  "response": [
    {
      "name": "Company info.",
      "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/company/info",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "company",
            "info"
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"id\": \"<integer>\",\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"type\": \"accountant\",\n    \"access_info\": {\n      \"role\": \"subaccount\",\n      \"permissions\": {\n        \"fic_situation\": \"read\",\n        \"fic_clients\": \"none\",\n        \"fic_suppliers\": \"none\",\n        \"fic_products\": \"read\",\n        \"fic_issued_documents\": \"write\",\n        \"fic_received_documents\": \"write\",\n        \"fic_receipts\": \"write\",\n        \"fic_calendar\": \"detailed\",\n        \"fic_archive\": \"detailed\",\n        \"fic_taxes\": \"read\",\n        \"fic_stock\": \"read\",\n        \"fic_cashbook\": \"write\",\n        \"fic_settings\": \"read\",\n        \"fic_emails\": \"none\",\n        \"fic_export\": \"detailed\",\n        \"fic_import_bankstatements\": \"none\",\n        \"fic_import_clients_suppliers\": \"none\",\n        \"fic_import_issued_documents\": \"read\",\n        \"fic_import_products\": \"write\",\n        \"fic_recurring\": \"none\",\n        \"fic_riba\": \"none\",\n        \"dic_employees\": \"none\",\n        \"dic_settings\": \"read\",\n        \"dic_timesheet\": \"read\",\n        \"fic_issued_documents_detailed\": {\n          \"quotes\": \"none\",\n          \"proformas\": \"write\",\n          \"invoices\": \"write\",\n          \"receipts\": \"write\",\n          \"delivery_notes\": \"detailed\",\n          \"credit_notes\": \"none\",\n          \"orders\": \"write\",\n          \"work_reports\": \"none\",\n          \"supplier_orders\": \"detailed\",\n          \"self_invoices\": \"detailed\"\n        }\n      },\n      \"through_accountant\": \"<boolean>\"\n    },\n    \"plan_info\": {\n      \"limits\": {\n        \"clients\": \"<integer>\",\n        \"suppliers\": \"<integer>\",\n        \"products\": \"<integer>\",\n        \"documents\": \"<integer>\"\n      },\n      \"functions\": {\n        \"archive\": \"<boolean>\",\n        \"cerved\": \"<boolean>\",\n        \"document_attachments\": \"<boolean>\",\n        \"e_invoice\": \"<boolean>\",\n        \"genius\": \"<boolean>\",\n        \"mail_tracking\": \"<boolean>\",\n        \"payment_notifications\": \"<boolean>\",\n        \"paypal\": \"<boolean>\",\n        \"receipts\": \"<boolean>\",\n        \"recurring\": \"<boolean>\",\n        \"smtp\": \"<boolean>\",\n        \"sofort\": \"<boolean>\",\n        \"stock\": \"<boolean>\",\n        \"subaccounts\": \"<boolean>\",\n        \"tessera_sanitaria\": \"<boolean>\",\n        \"ts_digital\": \"<boolean>\",\n        \"ts_invoice_trading\": \"<boolean>\",\n        \"ts_pay\": \"<boolean>\"\n      },\n      \"functions_status\": {\n        \"ts_digital\": {\n          \"active\": \"<boolean>\"\n        },\n        \"ts_pay\": {\n          \"active\": \"<boolean>\"\n        }\n      }\n    },\n    \"accountant_id\": \"<integer>\",\n    \"is_accountant\": \"<boolean>\"\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/company/info",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "company",
            "info"
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}