---
title: "Previews the import of an entity and its hierarchy into a job"
method: POST
path: "/api/v1/jobs/{jobId}/referrals/preview-import"
tags: ["JobReferral"]
---

# Previews the import of an entity and its hierarchy into a job

`POST /api/v1/jobs/{jobId}/referrals/preview-import`

## Request

- Base URL: `https://api.fireserviceusa.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.fireserviceusa.com/api/v1/jobs/{jobId}/referrals/preview-import`
- Auth: none declared

## Path parameters

- `jobId` integer, required

## Request body

- ImportRequest: Request model for importing entities
  - `JobId` integer: The job ID
  - `EntityId` integer: The entity ID to import
  - `Options` ImportOptions: Options for import operations
    - `CommissionPercentage` number, double, nullable: The commission percentage

## Response `200`

Success

- ImportPreviewViewModel: View model for import preview
  - `Entities` ImportEntityViewModel[], nullable: The list of entities to import
    - `ReferringEntityId` integer, nullable: The referring entity ID
    - `FullName` string, nullable: The full name
    - `EntityType` string, nullable: The entity type
    - `IsNew` boolean: Whether this is a new entity
  - `Relationships` ImportRelationshipViewModel[], nullable: The list of relationships to import
    - `ParentEntityId` integer: The parent entity ID
    - `ChildEntityId` integer: The child entity ID
    - `RelationshipType` string, nullable: The relationship type
    - `CommissionPercentage` number, double, nullable: The commission percentage
  - `Statistics` ImportStatisticsViewModel: View model for import statistics
    - `TotalEntities` integer: The total number of entities
    - `NewEntities` integer: The number of new entities
    - `ExistingEntities` integer: The number of existing entities
    - `TotalRelationships` integer: The total number of relationships
    - `NewRelationships` integer: The number of new relationships
    - `EstimatedCommission` number, double: The estimated commission
  - `Warnings` string[], nullable: The list of warnings

---

[API](https://skmtc.dev/fireserviceusa/apis/fireservice-usa-p2-api.md) - [All operations](https://skmtc.dev/fireserviceusa/apis/fireservice-usa-p2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fireserviceusa/apis/fireservice-usa-p2-api/revisions/96ea2ea68d87?raw)