> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Kernel Get Firmographics Job: Inputs, Cost & CLI Example
> Reading firmographics status and terminal headcount, revenue, and location data. Includes inputs, outputs, costs, and Deepline CLI examples for GTM automation.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=kernel_get_firmographics_job:{"job_id":"{{job_id}}"}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ---------------- | -------- | -------- | ------- | ------------------------------------- |
| `payload.job_id` | `string` | Yes | | ID of the firmographic enrichment job |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Returns the status and result of a firmographic enrichment job. When `status` is `completed`, the `record` field contains the enriched firmographic data.",
"properties": {
"job_id": {
"type": "string",
"description": "ID of the firmographic enrichment job"
}
},
"required": [
"job_id"
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes | | Provider response payload. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the job. Present when `status` is `pending`, `processing`, or `completed`."
},
"jobid": {
"type": "string",
"description": "Unique identifier for the job. Present only when `status` is `failed`."
},
"status": {
"type": "string",
"description": "Current status of the job. Terminal states are `completed` and `failed`.",
"enum": [
"pending",
"processing",
"completed",
"failed"
]
},
"created_at": {
"type": "string",
"description": "ISO 8601 timestamp when the job was created.",
"format": "date-time"
},
"completed_at": {
"type": "string",
"description": "ISO 8601 timestamp when the job reached a terminal state.",
"format": "date-time"
},
"record": {
"type": "object",
"properties": {
"kernel_id": {
"type": "string",
"description": "The unique identifier for the entity in Kernel's database."
},
"op_status": {
"type": [
"object",
"null"
],
"description": "Operational status of the entity. `null` when not yet determined.",
"properties": {
"operational_status": {
"type": [
"string",
"null"
],
"description": "Current operational status.",
"enum": [
"Active",
"Out of business",
"Absorbed",
"Undetermined",
null
]
},
"reasoning": {
"type": [
"string",
"null"
],
"description": "Explanation of how the operational status was determined."
}
},
"additionalProperties": false
},
"location": {
"type": [
"object",
"null"
],
"description": "Operating and registered addresses. `null` when not yet determined.",
"properties": {
"operating": {
"type": [
"object",
"null"
],
"description": "Operating address.",
"properties": {
"street": {
"type": [
"string",
"null"
],
"description": "Street address."
},
"city": {
"type": [
"string",
"null"
],
"description": "City."
},
"state": {
"type": [
"string",
"null"
],
"description": "State or province."
},
"country": {
"type": [
"string",
"null"
],
"description": "Country."
},
"postcode": {
"type": [
"string",
"null"
],
"description": "ZIP or postal code."
},
"reasoning": {
"type": [
"string",
"null"
],
"description": "Explanation of how the address was determined."
}
},
"additionalProperties": false
},
"registered": {
"type": [
"object",
"null"
],
"description": "Registered/legal address.",
"properties": {
"street": {
"type": [
"string",
"null"
],
"description": "Street address."
},
"city": {
"type": [
"string",
"null"
],
"description": "City."
},
"state": {
"type": [
"string",
"null"
],
"description": "State or province."
},
"country": {
"type": [
"string",
"null"
],
"description": "Country."
},
"postcode": {
"type": [
"string",
"null"
],
"description": "ZIP or postal code."
},
"reasoning": {
"type": [
"string",
"null"
],
"description": "Explanation of how the address was determined."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"headcount": {
"type": [
"object",
"null"
],
"description": "Headcount data. `null` when not yet determined.",
"properties": {
"count": {
"type": [
"number",
"null"
],
"description": "Recommended (headline) headcount. Kernel automatically picks the entity-direct or consolidated figure based on entity type; equals `count_entity` or `count_consolidated`."
},
"count_entity": {
"type": [
"number",
"null"
],
"description": "Entity-direct headcount, excluding subsidiaries."
},
"count_consolidated": {
"type": [
"number",
"null"
],
"description": "Consolidated headcount including subsidiaries."
},
"confidence": {
"type": [
"string",
"null"
],
"description": "Confidence in the headcount figure.",
"enum": [
"HIGH",
"MEDIUM",
"LOW",
null
]
},
"reasoning": {
"type": [
"string",
"null"
],
"description": "Explanation of how the headcount was determined."
}
},
"additionalProperties": false
},
"revenue": {
"type": [
"object",
"null"
],
"description": "Revenue data. `null` when not yet determined.",
"properties": {
"usd": {
"type": [
"number",
"null"
],
"description": "Recommended (headline) annual revenue in USD. Kernel automatically picks the entity-direct or consolidated figure based on entity type; equals `usd_entity` or `consolidated_usd`."
},
"usd_entity": {
"type": [
"number",
"null"
],
"description": "Entity-direct annual revenue in USD, excluding subsidiaries."
},
"consolidated_usd": {
"type": [
"number",
"null"
],
"description": "Consolidated annual revenue in USD including subsidiaries."
},
"confidence": {
"type": [
"string",
"null"
],
"description": "Confidence in the revenue figure.",
"enum": [
"HIGH",
"MEDIUM",
"LOW",
null
]
},
"local_currency": {
"type": [
"string",
"null"
],
"description": "The local currency of the recommended source figure, before USD conversion."
},
"local_currency_entity": {
"type": [
"string",
"null"
],
"description": "The local currency of the entity-direct source figure, before USD conversion."
},
"local": {
"type": [
"number",
"null"
],
"description": "Recommended annual revenue in local currency, matching `usd`."
},
"local_entity": {
"type": [
"number",
"null"
],
"description": "Entity-direct annual revenue in local currency."
},
"consolidated_local": {
"type": [
"number",
"null"
],
"description": "Consolidated revenue in local currency."
},
"consolidated_currency": {
"type": [
"string",
"null"
],
"description": "The currency of the consolidated source figure, before USD conversion."
},
"reasoning": {
"type": [
"string",
"null"
],
"description": "Explanation of how the revenue figure was determined."
},
"source": {
"type": [
"string",
"null"
],
"description": "Source of the revenue data. One of: `identified`, `estimated`.",
"enum": [
"identified",
"estimated",
null
]
}
},
"additionalProperties": false
}
},
"required": [
"kernel_id",
"op_status",
"location",
"headcount",
"revenue"
],
"additionalProperties": false
},
"error_message": {
"type": "string",
"description": "Error message. Present when `status` is `failed`."
},
"error_type": {
"type": "string",
"description": "Machine-readable error type. Present when `status` is `failed`. One of: `kernel_id_not_found`, `unknown`."
}
},
"required": [
"status"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute kernel_get_firmographics_job --payload '{
"job_id": "string"
}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.