Chilkat Online Tools

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

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

# Adds the "Authorization: Bearer <access_token>" header.
$http.AuthToken = "<access_token>"
$http.SetRequestHeader("Accept","application/json")

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://api-v2.fattureincloud.it/c/:company_id/company/info",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    exit
}

# 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

$Id = $jResp.StringOf("data.id")
$Name = $jResp.StringOf("data.name")
$v_Email = $jResp.StringOf("data.email")
$v_Type = $jResp.StringOf("data.type")
$Role = $jResp.StringOf("data.access_info.role")
$Fic_situation = $jResp.StringOf("data.access_info.permissions.fic_situation")
$Fic_clients = $jResp.StringOf("data.access_info.permissions.fic_clients")
$Fic_suppliers = $jResp.StringOf("data.access_info.permissions.fic_suppliers")
$Fic_products = $jResp.StringOf("data.access_info.permissions.fic_products")
$Fic_issued_documents = $jResp.StringOf("data.access_info.permissions.fic_issued_documents")
$Fic_received_documents = $jResp.StringOf("data.access_info.permissions.fic_received_documents")
$Fic_receipts = $jResp.StringOf("data.access_info.permissions.fic_receipts")
$Fic_calendar = $jResp.StringOf("data.access_info.permissions.fic_calendar")
$Fic_archive = $jResp.StringOf("data.access_info.permissions.fic_archive")
$Fic_taxes = $jResp.StringOf("data.access_info.permissions.fic_taxes")
$Fic_stock = $jResp.StringOf("data.access_info.permissions.fic_stock")
$Fic_cashbook = $jResp.StringOf("data.access_info.permissions.fic_cashbook")
$Fic_settings = $jResp.StringOf("data.access_info.permissions.fic_settings")
$Fic_emails = $jResp.StringOf("data.access_info.permissions.fic_emails")
$Fic_export = $jResp.StringOf("data.access_info.permissions.fic_export")
$Fic_import_bankstatements = $jResp.StringOf("data.access_info.permissions.fic_import_bankstatements")
$Fic_import_clients_suppliers = $jResp.StringOf("data.access_info.permissions.fic_import_clients_suppliers")
$Fic_import_issued_documents = $jResp.StringOf("data.access_info.permissions.fic_import_issued_documents")
$Fic_import_products = $jResp.StringOf("data.access_info.permissions.fic_import_products")
$Fic_recurring = $jResp.StringOf("data.access_info.permissions.fic_recurring")
$Fic_riba = $jResp.StringOf("data.access_info.permissions.fic_riba")
$Dic_employees = $jResp.StringOf("data.access_info.permissions.dic_employees")
$Dic_settings = $jResp.StringOf("data.access_info.permissions.dic_settings")
$Dic_timesheet = $jResp.StringOf("data.access_info.permissions.dic_timesheet")
$Quotes = $jResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.quotes")
$Proformas = $jResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.proformas")
$Invoices = $jResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.invoices")
$Receipts = $jResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.receipts")
$Delivery_notes = $jResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.delivery_notes")
$Credit_notes = $jResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.credit_notes")
$Orders = $jResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.orders")
$Work_reports = $jResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.work_reports")
$Supplier_orders = $jResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.supplier_orders")
$Self_invoices = $jResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.self_invoices")
$Through_accountant = $jResp.StringOf("data.access_info.through_accountant")
$Clients = $jResp.StringOf("data.plan_info.limits.clients")
$Suppliers = $jResp.StringOf("data.plan_info.limits.suppliers")
$Products = $jResp.StringOf("data.plan_info.limits.products")
$Documents = $jResp.StringOf("data.plan_info.limits.documents")
$Archive = $jResp.StringOf("data.plan_info.functions.archive")
$Cerved = $jResp.StringOf("data.plan_info.functions.cerved")
$Document_attachments = $jResp.StringOf("data.plan_info.functions.document_attachments")
$E_invoice = $jResp.StringOf("data.plan_info.functions.e_invoice")
$Genius = $jResp.StringOf("data.plan_info.functions.genius")
$Mail_tracking = $jResp.StringOf("data.plan_info.functions.mail_tracking")
$Payment_notifications = $jResp.StringOf("data.plan_info.functions.payment_notifications")
$Paypal = $jResp.StringOf("data.plan_info.functions.paypal")
$FunctionsReceipts = $jResp.StringOf("data.plan_info.functions.receipts")
$Recurring = $jResp.StringOf("data.plan_info.functions.recurring")
$Smtp = $jResp.StringOf("data.plan_info.functions.smtp")
$Sofort = $jResp.StringOf("data.plan_info.functions.sofort")
$Stock = $jResp.StringOf("data.plan_info.functions.stock")
$Subaccounts = $jResp.StringOf("data.plan_info.functions.subaccounts")
$Tessera_sanitaria = $jResp.StringOf("data.plan_info.functions.tessera_sanitaria")
$Ts_digital = $jResp.StringOf("data.plan_info.functions.ts_digital")
$Ts_invoice_trading = $jResp.StringOf("data.plan_info.functions.ts_invoice_trading")
$Ts_pay = $jResp.StringOf("data.plan_info.functions.ts_pay")
$Active = $jResp.StringOf("data.plan_info.functions_status.ts_digital.active")
$Ts_payActive = $jResp.StringOf("data.plan_info.functions_status.ts_pay.active")
$Accountant_id = $jResp.StringOf("data.accountant_id")
$Is_accountant = $jResp.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": ""
    }
  ]
}