api.companies.get_details

GET /companies/{companyId}/details — ACPortal

Python

api.companies.get_details(company_id: str) -> CompanyDetails

CLI

ab companies get_details <company_id>

GET /companies/{companyId}/details

Response

Returns CompanyDetails.

Field	Type	Required	Description
id	Optional[str]	no	Company UUID
details	Optional[CompanyDetailsInfo]	no	Nested company detail fields
preferences	Optional[CompanyPreferences]	no	Company preferences and logos
capabilities	int | dict | None	no	Service capabilities (bitmask or dict)
settings	Optional[dict]	no	Company settings
addresses	Optional[list[dict]]	no	Associated addresses
contacts	Optional[list[dict]]	no	Associated contacts
address	Optional[CompanyAddress]	no	Primary company address
accountInformation	Optional[AccountInformation]	no	Carrier account information
pricing	Optional[CompanyPricing]	no	Pricing configuration
insurance	Optional[CompanyInsurance]	no	Insurance configuration
finalMileTariff	Optional[list[TariffGroup]]	no	Final mile tariff groups
taxes	Optional[CompanyTaxes]	no	Tax configuration
readOnlyAccess	Optional[bool]	no	Read-only access flag
userId	Optional[str]	no	User UUID
companyName	Optional[str]	no	Company name
contactName	Optional[str]	no	Contact name
contactPhone	Optional[str]	no	Contact phone
companyType	Optional[str]	no	Company type
parcelOnly	Optional[bool]	no	Parcel-only flag
isThirdParty	Optional[bool]	no	Third-party flag
companyCode	Optional[str]	no	Company code
parentCompanyName	Optional[str]	no	Parent company name
companyTypeID	Optional[str]	no	Company type UUID
parentCompanyID	Optional[str]	no	Parent company UUID
companyPhone	Optional[str]	no	Company phone
companyEmail	Optional[str]	no	Company email
companyFax	Optional[str]	no	Company fax
companyWebSite	Optional[str]	no	Company website URL
industryType	Optional[str]	no	Industry type UUID
industryTypeName	Optional[str]	no	Industry type name
taxId	Optional[str]	no	Tax ID
customerCell	Optional[str]	no	Customer cell phone
companyCell	Optional[str]	no	Company cell phone
pzCode	Optional[str]	no	PZ code
referralCode	Optional[str]	no	Referral code
companyLogo	Optional[str]	no	Company logo filename
letterHeadLogo	Optional[str]	no	Letterhead logo filename
thumbnailLogo	Optional[str]	no	Thumbnail logo filename
mapsMarkerImage	Optional[str]	no	Maps marker image filename
colorTheme	Optional[str]	no	Color theme name
franchiseeMaturityType	Optional[str]	no	Franchisee maturity type UUID
pricingToUse	Optional[str]	no	Pricing UUID
totalRows	Optional[int]	no	Total rows count
companyInsurancePricing	Optional[CompanyInsurancePricing]	no	Company insurance pricing data
companyServicePricing	Optional[CompanyServicePricing]	no	Company service pricing data
companyTaxPricing	Optional[CompanyTaxPricing]	no	Company tax pricing data
wholeSaleMarkup	Optional[float]	no	Wholesale markup
baseMarkup	Optional[float]	no	Base markup
mediumMarkup	Optional[float]	no	Medium markup
highMarkup	Optional[float]	no	High markup
miles	Optional[float]	no	Miles
insuranceType	Optional[str]	no	Insurance type UUID
isGlobal	Optional[bool]	no	Global company flag
isQbUser	Optional[bool]	no	QuickBooks user flag
skipIntacct	Optional[bool]	no	Skip Intacct flag
isAccess	Optional[str]	no	Access flag
companyDisplayID	Optional[str]	no	Company display ID
depth	Optional[int]	no	Hierarchy depth
franchiseeName	Optional[str]	no	Franchisee name
isPrefered	Optional[bool]	no	Preferred flag
createdUser	Optional[str]	no	Created by user
mappingLocations	Optional[str]	no	Mapping locations
locationCount	Optional[str]	no	Location count
baseParent	Optional[str]	no	Base parent
copyMaterialFrom	Optional[str]	no	Copy material from
isHide	Optional[bool]	no	Hidden flag
isDontUse	Optional[bool]	no	Don’t use flag
mainAddress	Optional[CompanyAddress]	no	Main address
accountManagerFranchiseeId	Optional[str]	no	Account manager franchisee UUID
accountManagerFranchiseeName	Optional[str]	no	Account manager franchisee name
carrierAccountsSourceCompanyId	Optional[str]	no	Carrier source company UUID
carrierAccountsSourceCompanyName	Optional[str]	no	Carrier source company name
autoPriceAPIEnableEmails	Optional[bool]	no	AutoPrice email notifications
autoPriceAPIEnableSMSs	Optional[bool]	no	AutoPrice SMS notifications
commercialCapabilities	Optional[int]	no	Commercial capabilities bitmask
primaryContactId	Optional[int]	no	Primary contact ID
payerContactId	Optional[int]	no	Payer contact ID
payerContactName	Optional[str]	no	Payer contact name
totalJobs	Optional[int]	no	Total jobs count
totalJobsRevenue	Optional[float]	no	Total jobs revenue
totalSales	Optional[int]	no	Total sales count
totalSalesRevenue	Optional[float]	no	Total sales revenue
isReadonly	Optional[bool]	no	Read-only flag
addressData	Optional[AddressData]	no	Address data
overridableAddressData	Optional[OverridableAddressData]	no	Overridable address data
companyInfo	Optional[CompanyInfo]	no	Company info summary
companyID	Optional[str]	no	Company UUID (flat details response)
addressID	Optional[str]	no	Address UUID (flat details response)
address1	Optional[str]	no	Address line 1
address2	Optional[str]	no	Address line 2
city	Optional[str]	no	City
state	Optional[str]	no	State
stateCode	Optional[str]	no	State code
countryName	Optional[str]	no	Country name
countryCode	Optional[str]	no	Country code
countryID	Optional[str]	no	Country UUID (flat details response)
zipCode	Optional[str]	no	ZIP code
isActive	Optional[bool]	no	Active flag
createdDate	Optional[str]	no	Created date
createdBy	Optional[str]	no	Created by UUID
modifiedDate	Optional[str]	no	Modified date
modifiedBy	Optional[str]	no	Modified by UUID
latitude	Optional[str]	no	Latitude
longitude	Optional[str]	no	Longitude
result	Optional[str]	no	Result
addressMappingID	Optional[str]	no	Address mapping UUID
contactID	Optional[str]	no	Contact UUID (flat details response)
userID	Optional[str]	no	User UUID (flat details response)
primaryCustomerName	Optional[str]	no	Primary customer name
contactInfo	Optional[dict]	no	Contact info

---

← Back to api.companies