Chilkat Online Tools

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

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_Name
string ls_V_Email
string ls_V_Type
string ls_Role
string ls_Fic_situation
string ls_Fic_clients
string ls_Fic_suppliers
string ls_Fic_products
string ls_Fic_issued_documents
string ls_Fic_received_documents
string ls_Fic_receipts
string ls_Fic_calendar
string ls_Fic_archive
string ls_Fic_taxes
string ls_Fic_stock
string ls_Fic_cashbook
string ls_Fic_settings
string ls_Fic_emails
string ls_Fic_export
string ls_Fic_import_bankstatements
string ls_Fic_import_clients_suppliers
string ls_Fic_import_issued_documents
string ls_Fic_import_products
string ls_Fic_recurring
string ls_Fic_riba
string ls_Dic_employees
string ls_Dic_settings
string ls_Dic_timesheet
string ls_Quotes
string ls_Proformas
string ls_Invoices
string ls_Receipts
string ls_Delivery_notes
string ls_Credit_notes
string ls_Orders
string ls_Work_reports
string ls_Supplier_orders
string ls_Self_invoices
string ls_Through_accountant
string ls_Clients
string ls_Suppliers
string ls_Products
string ls_Documents
string ls_Archive
string ls_Cerved
string ls_Document_attachments
string ls_E_invoice
string ls_Genius
string ls_Mail_tracking
string ls_Payment_notifications
string ls_Paypal
string ls_FunctionsReceipts
string ls_Recurring
string ls_Smtp
string ls_Sofort
string ls_Stock
string ls_Subaccounts
string ls_Tessera_sanitaria
string ls_Ts_digital
string ls_Ts_invoice_trading
string ls_Ts_pay
string ls_Active
string ls_Ts_payActive
string ls_Accountant_id
string ls_Is_accountant

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://api-v2.fattureincloud.it/c/:company_id/company/info",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

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

ls_Id = loo_JResp.StringOf("data.id")
ls_Name = loo_JResp.StringOf("data.name")
ls_V_Email = loo_JResp.StringOf("data.email")
ls_V_Type = loo_JResp.StringOf("data.type")
ls_Role = loo_JResp.StringOf("data.access_info.role")
ls_Fic_situation = loo_JResp.StringOf("data.access_info.permissions.fic_situation")
ls_Fic_clients = loo_JResp.StringOf("data.access_info.permissions.fic_clients")
ls_Fic_suppliers = loo_JResp.StringOf("data.access_info.permissions.fic_suppliers")
ls_Fic_products = loo_JResp.StringOf("data.access_info.permissions.fic_products")
ls_Fic_issued_documents = loo_JResp.StringOf("data.access_info.permissions.fic_issued_documents")
ls_Fic_received_documents = loo_JResp.StringOf("data.access_info.permissions.fic_received_documents")
ls_Fic_receipts = loo_JResp.StringOf("data.access_info.permissions.fic_receipts")
ls_Fic_calendar = loo_JResp.StringOf("data.access_info.permissions.fic_calendar")
ls_Fic_archive = loo_JResp.StringOf("data.access_info.permissions.fic_archive")
ls_Fic_taxes = loo_JResp.StringOf("data.access_info.permissions.fic_taxes")
ls_Fic_stock = loo_JResp.StringOf("data.access_info.permissions.fic_stock")
ls_Fic_cashbook = loo_JResp.StringOf("data.access_info.permissions.fic_cashbook")
ls_Fic_settings = loo_JResp.StringOf("data.access_info.permissions.fic_settings")
ls_Fic_emails = loo_JResp.StringOf("data.access_info.permissions.fic_emails")
ls_Fic_export = loo_JResp.StringOf("data.access_info.permissions.fic_export")
ls_Fic_import_bankstatements = loo_JResp.StringOf("data.access_info.permissions.fic_import_bankstatements")
ls_Fic_import_clients_suppliers = loo_JResp.StringOf("data.access_info.permissions.fic_import_clients_suppliers")
ls_Fic_import_issued_documents = loo_JResp.StringOf("data.access_info.permissions.fic_import_issued_documents")
ls_Fic_import_products = loo_JResp.StringOf("data.access_info.permissions.fic_import_products")
ls_Fic_recurring = loo_JResp.StringOf("data.access_info.permissions.fic_recurring")
ls_Fic_riba = loo_JResp.StringOf("data.access_info.permissions.fic_riba")
ls_Dic_employees = loo_JResp.StringOf("data.access_info.permissions.dic_employees")
ls_Dic_settings = loo_JResp.StringOf("data.access_info.permissions.dic_settings")
ls_Dic_timesheet = loo_JResp.StringOf("data.access_info.permissions.dic_timesheet")
ls_Quotes = loo_JResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.quotes")
ls_Proformas = loo_JResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.proformas")
ls_Invoices = loo_JResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.invoices")
ls_Receipts = loo_JResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.receipts")
ls_Delivery_notes = loo_JResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.delivery_notes")
ls_Credit_notes = loo_JResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.credit_notes")
ls_Orders = loo_JResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.orders")
ls_Work_reports = loo_JResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.work_reports")
ls_Supplier_orders = loo_JResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.supplier_orders")
ls_Self_invoices = loo_JResp.StringOf("data.access_info.permissions.fic_issued_documents_detailed.self_invoices")
ls_Through_accountant = loo_JResp.StringOf("data.access_info.through_accountant")
ls_Clients = loo_JResp.StringOf("data.plan_info.limits.clients")
ls_Suppliers = loo_JResp.StringOf("data.plan_info.limits.suppliers")
ls_Products = loo_JResp.StringOf("data.plan_info.limits.products")
ls_Documents = loo_JResp.StringOf("data.plan_info.limits.documents")
ls_Archive = loo_JResp.StringOf("data.plan_info.functions.archive")
ls_Cerved = loo_JResp.StringOf("data.plan_info.functions.cerved")
ls_Document_attachments = loo_JResp.StringOf("data.plan_info.functions.document_attachments")
ls_E_invoice = loo_JResp.StringOf("data.plan_info.functions.e_invoice")
ls_Genius = loo_JResp.StringOf("data.plan_info.functions.genius")
ls_Mail_tracking = loo_JResp.StringOf("data.plan_info.functions.mail_tracking")
ls_Payment_notifications = loo_JResp.StringOf("data.plan_info.functions.payment_notifications")
ls_Paypal = loo_JResp.StringOf("data.plan_info.functions.paypal")
ls_FunctionsReceipts = loo_JResp.StringOf("data.plan_info.functions.receipts")
ls_Recurring = loo_JResp.StringOf("data.plan_info.functions.recurring")
ls_Smtp = loo_JResp.StringOf("data.plan_info.functions.smtp")
ls_Sofort = loo_JResp.StringOf("data.plan_info.functions.sofort")
ls_Stock = loo_JResp.StringOf("data.plan_info.functions.stock")
ls_Subaccounts = loo_JResp.StringOf("data.plan_info.functions.subaccounts")
ls_Tessera_sanitaria = loo_JResp.StringOf("data.plan_info.functions.tessera_sanitaria")
ls_Ts_digital = loo_JResp.StringOf("data.plan_info.functions.ts_digital")
ls_Ts_invoice_trading = loo_JResp.StringOf("data.plan_info.functions.ts_invoice_trading")
ls_Ts_pay = loo_JResp.StringOf("data.plan_info.functions.ts_pay")
ls_Active = loo_JResp.StringOf("data.plan_info.functions_status.ts_digital.active")
ls_Ts_payActive = loo_JResp.StringOf("data.plan_info.functions_status.ts_pay.active")
ls_Accountant_id = loo_JResp.StringOf("data.accountant_id")
ls_Is_accountant = loo_JResp.StringOf("data.is_accountant")


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp

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