Chilkat Online Tools

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

Back to Collection Items

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sId
    String sName
    String sV_Email
    String sV_Type
    String sRole
    String sFic_situation
    String sFic_clients
    String sFic_suppliers
    String sFic_products
    String sFic_issued_documents
    String sFic_received_documents
    String sFic_receipts
    String sFic_calendar
    String sFic_archive
    String sFic_taxes
    String sFic_stock
    String sFic_cashbook
    String sFic_settings
    String sFic_emails
    String sFic_export
    String sFic_import_bankstatements
    String sFic_import_clients_suppliers
    String sFic_import_issued_documents
    String sFic_import_products
    String sFic_recurring
    String sFic_riba
    String sDic_employees
    String sDic_settings
    String sDic_timesheet
    String sQuotes
    String sProformas
    String sInvoices
    String sReceipts
    String sDelivery_notes
    String sCredit_notes
    String sOrders
    String sWork_reports
    String sSupplier_orders
    String sSelf_invoices
    String sThrough_accountant
    String sClients
    String sSuppliers
    String sProducts
    String sDocuments
    String sArchive
    String sCerved
    String sDocument_attachments
    String sE_invoice
    String sGenius
    String sMail_tracking
    String sPayment_notifications
    String sPaypal
    String sFunctionsReceipts
    String sRecurring
    String sSmtp
    String sSofort
    String sStock
    String sSubaccounts
    String sTessera_sanitaria
    String sTs_digital
    String sTs_invoice_trading
    String sTs_pay
    String sActive
    String sTs_payActive
    String sAccountant_id
    String sIs_accountant
    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/c/:company_id/company/info" 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": {
    //     "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

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


End_Procedure

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