Atoka API User Reference
Companies package "Groups"
API tokens are configured to access only the packages each user needs; this means you might not have access to the content of this package. Ask your sales contact!
Available fields | Description | Data | Used by filters | Facet | Match | Stats |
|---|---|---|---|---|---|---|
| items[] | Groups the company is part of | - | - | |||
| items[].computedTotalOperatingRevenue Private field | the computed sum of revenues generated by main, recurrent business activities for the companies belonging to the same group (latest year available) | float | groupComputedTotalOperatingRevenueMax groupComputedTotalOperatingRevenueMin | |||
| items[].employees Private field | the sum of the employees of the companies belonging to the same group (latest available) | float | groupEmployeesMax groupEmployeesMin | |||
| items[].groupId Private field | Group ID | int | groupIds groupIdsExclude | |||
| items[].items[].active Private field | is the company active? | true | false | - | |||
| items[].items[].ateco[].code Private field | ATECO 2007 code (the most specific one) | "string" | - | |||
| items[].items[].ateco[].description Private field | short description of ATECO 2007 code | "string" | - | |||
| items[].items[].ateco[].rootCode Private field | the class of the ATECO 2007 code | "string" | - | |||
| items[].items[].cervedId Private field | Cerved ID of the person or company | int | - | |||
| items[].items[].company Private field | is the subject a company or a person? | true | false | - | |||
| items[].items[].founded Private field | foundation date of the company | date | - | |||
| items[].items[].id Private field | Atoka ID of the person or company | "string" | - | |||
| items[].items[].latestBalanceSheet.date Private field | balance sheet closing date ("data di chiusura del bilancio") | date | - | |||
| items[].items[].latestBalanceSheet.revenue Private field | Revenue ("ricavi") | int | - | |||
| items[].items[].latestBalanceSheet.year Private field | year (from the balance sheet closing date) | int | - | |||
| items[].items[].latestEmployees.date Private field | date where the number of employees is referring to | date | - | |||
| items[].items[].latestEmployees.value Private field | total number of employees (not considering the contract type) | int | - | |||
| items[].items[].latestEmployees.year Private field | year of this record | int | - | |||
| items[].items[].legalName Private field | legal name of the company (available only if | "string" | - | |||
| items[].items[].name Private field | name of the person or company | "string" | - | |||
| items[].items[].taxId Private field | the taxID ("codice fiscale") of the person or company | "string" | - | |||
| items[].items[].vat Private field | the VAT ID ("partita IVA") of the company | "string" | - | |||
| items[].label | Group label | "string" | - | |||
| items[].numberOfItems Private field | number of items | int | - | |||
| items[].numberOfRelationships Private field | number of relationships | int | - | |||
| items[].numberOfRoots Private field | number of roots | int | - | |||
| items[].relationships[].provenance Private field | source of the relationship | "Bilancio di esercizio", "Bilancio consolidato", "Elenco soci", "Visura", "Cebi" | - | |||
| items[].relationships[].ratio Private field | the ownership ratio; multiply this number by 100 to get the percentage | float | - | |||
| items[].relationships[].src Private field | the source ID of the relationship | "string" | - | |||
| items[].relationships[].trg Private field | the target ID of the relationship | "string" | - | |||
| items[].relationships[].type Private field | Type of the relationship | "Controllata", "Collegata", "Altre" | - | |||
| items[].revenue.computed | sum of revenue of the companies in this group | float | groupComputedRevenueMax groupComputedRevenueMin | |||
| items[].revenue.consolidated | consolidated revenue of the group, as from official balance sheets | float | groupConsolidatedRevenueMax groupConsolidatedRevenueMin | |||
| items[].roots[].active Private field | is the company active? | true | false | - | |||
| items[].roots[].ateco[].code Private field | ATECO 2007 code (the most specific one) | "string" | - | |||
| items[].roots[].ateco[].description Private field | short description of ATECO 2007 code | "string" | - | |||
| items[].roots[].ateco[].rootCode Private field | the class of the ATECO 2007 code | "string" | - | |||
| items[].roots[].cervedId Private field | Cerved ID of the person or company | int | - | |||
| items[].roots[].company Private field | is the subject a company or a person? | true | false | - | |||
| items[].roots[].founded Private field | foundation date of the company | date | - | |||
| items[].roots[].id Private field | Atoka ID of the person or company | "string" | - | |||
| items[].roots[].latestBalanceSheet.date Private field | balance sheet closing date ("data di chiusura del bilancio") | date | - | |||
| items[].roots[].latestBalanceSheet.revenue Private field | Revenue ("ricavi") | int | - | |||
| items[].roots[].latestBalanceSheet.year Private field | year (from the balance sheet closing date) | int | - | |||
| items[].roots[].latestEmployees.date Private field | date where the number of employees is referring to | date | - | |||
| items[].roots[].latestEmployees.value Private field | total number of employees (not considering the contract type) | int | - | |||
| items[].roots[].latestEmployees.year Private field | year of this record | int | - | |||
| items[].roots[].legalName Private field | legal name of the company (available only if | "string" | - | |||
| items[].roots[].name Private field | name of the person or company | "string" | - | |||
| items[].roots[].taxId Private field | the taxID ("codice fiscale") of the person or company | "string" | - | |||
| items[].roots[].vat Private field | the VAT ID ("partita IVA") of the company | "string" | - |
Example JSON fragment for package
{"items": [{"roots": [{"id": "foo", "cervedId": 42, "company": false, "name": "foo", "legalName": "foo", "active": false, "vat": "foo", "taxId": "foo", "founded": "2015-12-24", "ateco": [{"code": "64.92.09", "description": "altre attività creditizie nca", "rootCode": "G" },...],"latestBalanceSheet": {"year": 42, "date": "2015-12-24", "revenue": 42 },"latestEmployees": {"year": 42, "date": "2015-12-24", "value": 42 }},...],"items": [{"id": "foo", "cervedId": 42, "company": false, "name": "foo", "legalName": "foo", "active": false, "vat": "foo", "taxId": "foo", "founded": "2015-12-24", "ateco": [{"code": "64.92.09", "description": "altre attività creditizie nca", "rootCode": "G" },...],"latestBalanceSheet": {"year": 42, "date": "2015-12-24", "revenue": 42 },"latestEmployees": {"year": 42, "date": "2015-12-24", "value": 42 }},...],"relationships": [{"src": "foo", "trg": "foo", "ratio": 0.42, "provenance": "Bilancio di esercizio", "type": "Controllata" },...],"groupId": 42, "label": "foo", "revenue": {"computed": 0.42, "consolidated": 0.42 },"computedTotalOperatingRevenue": 0.42, "employees": 0.42, "numberOfRoots": 42, "numberOfItems": 42, "numberOfRelationships": 42 },...]}