api.reports.insurance

POST /reports/insurance — ACPortal

Python

api.reports.insurance(*, data: InsuranceReportRequest | dict) -> list[InsuranceReport]

CLI

ab reports insurance [--data ...]

POST /reports/insurance.

Args: data: Insurance report payload with date range filters. Accepts an :class:InsuranceReportRequest instance or a dict.

Request model: :class:InsuranceReportRequest

Request body — InsuranceReportRequest

Field	Type	Required	Description
startDate	Optional[str]	no	Range start date (ISO 8601)
endDate	Optional[str]	no	Range end date (ISO 8601)
pageNo	Optional[int]	no	Page number
pageSize	Optional[int]	no	Items per page
sortBy	Optional[dict]	no	Sort config {sortByField: int, sortDir: bool}

Response

Returns a list of List[InsuranceReport].

Field	Type	Required	Description
jobNumber	Optional[str]	no	Job display number
franchisee	Optional[str]	no	Franchisee code
insuranceType	Optional[str]	no	Insurance type
noOfPiece	Optional[int]	no	Number of pieces
totalCost	Optional[float]	no	Total declared value
jobDate	Optional[str]	no	Job date
insuranceCost	Optional[float]	no	Insurance cost
carrier	Optional[str]	no	Carrier name
intacctDate	Optional[str]	no	Intacct sync date
totalRecords	Optional[int]	no	Total record count

---

← Back to api.reports