Get a business entity
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityListDetails/{BusinessEntityKey}
Request
Path Parameters
-
BusinessEntityKey(required): integer(int64)
System generated unique identifier for a business entity.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorBusinessEntityListDetails-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address 1
Read Only:true
Maximum Length:240
The first line of the entity address. -
Address2: string
Title:
Address 2
Read Only:true
Maximum Length:240
The second line of the entity address. -
Address3: string
Title:
Address 3
Read Only:true
Maximum Length:240
The third line of the entity address. -
Address4: string
Title:
Address 4
Read Only:true
Maximum Length:240
The fourth line of the entity address. -
BusDisadvOwnedFlag: string
Title:
Disadvantaged Enterprise
Read Only:true
Maximum Length:30
Indicates whether the business entity is disadvantaged owned. -
BusEnabledFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the business entity is enabled. -
BusExemptFlag: string
Title:
Is this an exempt entity?
Read Only:true
Maximum Length:1
Indicates whether the business entity has an exemption. -
BusExemptPct: integer
(int32)
Title:
Exempt Percentage
Read Only:true
Business entity exemption percentage. -
BusExemptType: string
Title:
Exempt Type
Read Only:true
Maximum Length:30
Identifies the type of exemption for the business entity. -
BusHideInfoFlag: string
Title:
Hide Business from Public View
Read Only:true
Maximum Length:1
The business to show or hide the information to public users. -
BusInactiveReason: string
Read Only:
true
Maximum Length:1000
Indicates the reason the business entity was inactivated. -
BusinessEntityId: string
Title:
Business
Read Only:true
Maximum Length:255
The unique identifier for a business entity. -
BusinessEntityKey: integer
(int64)
Read Only:
true
System generated unique identifier for a business entity. -
BusLocationListDetails: array
Business Location List Details
Title:
Business Location List Details
The business location list details resource is used to view detailed information about the locations associated with a business entity. -
BusOwnershipType: string
Title:
Ownership Type
Read Only:true
Maximum Length:15
Business entity ownership type. -
BusOwnersLists: array
Business Owner List Details
Title:
Business Owner List Details
The business owner list details resource is used to view detailed information about the owners associated with a business entity. -
BusPartyId: integer
(int64)
Read Only:
true
Business entity party ID. -
BusStatus: string
Title:
Status
Read Only:true
Maximum Length:20
The current status of the business entity. -
BusStatusMeaning: string
Read Only:
true
Maximum Length:80
The current status meaning of the business entity. -
BusVeteranOwnedFlag: string
Title:
Veteran Owned
Read Only:true
Maximum Length:1
Indicates whether the business entity is owned by a military veteran. -
City: string
Title:
City
Read Only:true
Maximum Length:60
Business entity city. -
ContactAccess: string
Read Only:
true
Maximum Length:1
The contact has full access for a particular business entity or not. -
Country: string
Title:
Country
Read Only:true
Maximum Length:2
Business entity country. -
County: string
Read Only:
true
Maximum Length:60
Business entity county. -
FiscalYearendDay: integer
(int32)
Title:
Fiscal Year Day
Read Only:true
Fiscal year end day. -
FiscalYearendMonth: string
Title:
Fiscal Year Month
Read Only:true
Maximum Length:30
Fiscal year end month. -
JgzzFiscalCode: string
Title:
Business Tax ID
Read Only:true
Maximum Length:20
Taxpayer identification number, often unique identifier of person or organization. Can be SSN or income taxpayer ID in US, fiscal code or NIF in Europe. -
LegalStatus: string
Read Only:
true
Maximum Length:30
Business entity legal status. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinorityOwnedInd: string
Title:
Minority Owned
Read Only:true
Maximum Length:30
Indicates whether the business entity is minority owned. -
OrganizationName: string
Title:
Legal Name
Read Only:true
Maximum Length:360
The name of the business entity. -
PostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:60
Business entity postal code. -
PostalPlus4Code: string
Read Only:
true
Maximum Length:20
Business entity postal plus 4 code. -
Province: string
Title:
Province
Read Only:true
Maximum Length:60
Business entity province. -
SmallBusInd: string
Title:
Small Business
Read Only:true
Maximum Length:30
Indicates whether the entity is a small business. -
State: string
Title:
State
Read Only:true
Maximum Length:60
Business entity state. -
WomanOwnedInd: string
Title:
Woman Owned
Read Only:true
Maximum Length:30
Indicates whether the business entity is woman owned.
Nested Schema : Business Location List Details
Type:
array
Title:
Business Location List Details
The business location list details resource is used to view detailed information about the locations associated with a business entity.
Show Source
Nested Schema : Business Owner List Details
Type:
array
Title:
Business Owner List Details
The business owner list details resource is used to view detailed information about the owners associated with a business entity.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorBusinessEntityListDetails-BusLocationListDetails-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address 1
Read Only:true
Maximum Length:240
First line of the physical address. -
Address2: string
Title:
Address 2
Read Only:true
Maximum Length:240
Second line of the physical address. -
Address3: string
Title:
Address 3
Read Only:true
Maximum Length:240
Third line of the physical address. -
Address4: string
Title:
Address 4
Read Only:true
Maximum Length:240
Fourth line of the physical address. -
AddressCode: string
Read Only:
true
Maximum Length:32
Unique identifier for the parcel address. -
AddressId: integer
(int64)
Read Only:
true
The unique identifier for the parcel address. -
AddressLocId: integer
(int64)
Read Only:
true
Unique identifier of the physical address. -
AddressType: string
Read Only:
true
Maximum Length:20
Attribute used for address point validation. Possible values might be main address, virtual address, shipping gate address, or others. -
AgencyId: integer
(int32)
Read Only:
true
Unique identifier of the agency. -
AltPhoneAreaCode: string
Read Only:
true
Maximum Length:20
Alternate phone area code. -
AltPhoneContactPointId: integer
(int64)
Read Only:
true
Alternate phone contact point identifier. -
AltPhoneCountryCode: string
Read Only:
true
Maximum Length:10
Alternate phone country code. -
AltPhoneExtension: string
Read Only:
true
Maximum Length:20
Alternate phone extension number of the location. -
AltPhoneNumber: string
Title:
Alternate Phone
Read Only:true
Maximum Length:40
Alternate phone number of the location. -
AltPhoneType: string
Title:
Alternate Phone Type
Read Only:true
Maximum Length:30
Alternate phone type of the location. -
AltRawPhoneNumber: string
Read Only:
true
Maximum Length:60
Alternate raw phone number of the location. -
AreaSize: integer
(int64)
Read Only:
true
Size of the business location. -
AreaSizeUom: string
Read Only:
true
Maximum Length:10
Unit of measure for the business location size. -
Building: string
Read Only:
true
Maximum Length:240
Street number of the location. -
BuildingType: string
Read Only:
true
Maximum Length:20
Building type used for parcel address searches. -
BusCategory: string
Title:
Category
Read Only:true
Maximum Length:50
Indicates the type of business. -
BusinessEntityId: string
Title:
Business
Read Only:true
Maximum Length:50
The unique identifier for a business entity. -
BusinessEntityKey: integer
(int64)
Read Only:
true
System generated unique identifier for a business entity. -
BusinessLocationId: string
Title:
Location ID
Read Only:true
Maximum Length:255
The unique identifier for a business location. -
BusinessLocationKey: integer
(int64)
Read Only:
true
System generated unique identifier for a business location. -
BusinessLocationPartyId: integer
(int64)
Read Only:
true
Business location party ID. -
BusStateTaxId: string
Title:
State Tax ID
Read Only:true
Maximum Length:20
State tax ID of the business location. -
BusSubCategory: string
Title:
Subcategory
Read Only:true
Maximum Length:50
Business subcategory. -
City: string
Title:
City
Read Only:true
Maximum Length:60
Physical address city. -
CityTaxId: string
Title:
City Tax ID
Read Only:true
Maximum Length:20
City tax ID of the business location. -
CoordinateX: integer
(int64)
Read Only:
true
Geographic X-coordinate of the parcel address location. -
CoordinateY: integer
(int64)
Read Only:
true
Geographic Y-coordinate of the parcel address location. -
Country: string
Title:
Country
Read Only:true
Maximum Length:2
Physical address country. -
County: string
Read Only:
true
Maximum Length:60
Physical address county. -
CrossroadOne: string
Read Only:
true
Maximum Length:240
Cross road 1 that is part of parcel address. -
CrossroadTwo: string
Read Only:
true
Maximum Length:240
Cross road 2 that is part of parcel address. -
CtyFoodSerLicExp: string
(date)
Read Only:
true
Expiration date of the county food service license associated with the business location. -
CtyFoodSerLicNum: string
Read Only:
true
Maximum Length:30
County food service license number of the business location. -
Description: string
Title:
Business Description
Read Only:true
Maximum Length:2000
Description of the business location. -
EcontactAvailabilityOne: string
Read Only:
true
Maximum Length:1000
Availability of the primary emergency contact. -
EcontactAvailabilityTwo: string
Read Only:
true
Maximum Length:1000
Availability of the secondary emergency contact. -
EcontactEmailOne: string
Read Only:
true
Maximum Length:320
Email address of the primary emergency contact. -
EcontactEmailTwo: string
Read Only:
true
Maximum Length:320
Email address of the secondary emergency contact. -
EcontactFirstNameOne: string
Title:
Contact 1 First Name
Read Only:true
Maximum Length:150
First name of the primary emergency contact. -
EcontactFirstNameTwo: string
Title:
Contact 2 First Name
Read Only:true
Maximum Length:150
First name of the secondary emergency contact. -
EcontactLastNameOne: string
Title:
Contact 1 Last Name
Read Only:true
Maximum Length:150
Last name of the primary emergency contact. -
EcontactLastNameTwo: string
Title:
Contact 2 Last Name
Read Only:true
Maximum Length:150
Last name of the secondary emergency contact. -
EcontactPhoneAreaCodeOne: string
Read Only:
true
Maximum Length:20
Primary emergency contact area code. -
EcontactPhoneAreaCodeTwo: string
Read Only:
true
Maximum Length:20
Secondary emergency contact area code. -
EcontactPhoneCountryOne: string
Read Only:
true
Maximum Length:10
Primary emergency contact country. -
EcontactPhoneCountryTwo: string
Read Only:
true
Maximum Length:10
Secondary emergency contact country code. -
EcontactPhoneExtensionOne: string
Read Only:
true
Maximum Length:20
Primary emergency contact phone extension number of the location. -
EcontactPhoneExtensionTwo: string
Read Only:
true
Maximum Length:20
Secondary emergency contact phone extension number of the location. -
EcontactPhoneNumberOne: string
Read Only:
true
Maximum Length:40
Primary emergency contact phone number of the location. -
EcontactPhoneNumberTwo: string
Read Only:
true
Maximum Length:40
Secondary emergency contact phone number of the location. -
EcontactPhoneTypeOne: string
Read Only:
true
Maximum Length:30
Phone type of the primary emergency contact for the location. -
EcontactPhoneTypeTwo: string
Read Only:
true
Maximum Length:30
Secondary emergency contact phone type of the location. -
EcontactRawPhoneNumberOne: string
Read Only:
true
Maximum Length:60
Primary emergency contact raw phone number of the location. -
EcontactRawPhoneNumberTwo: string
Read Only:
true
Maximum Length:60
Secondary emergency contact raw phone number of the location. -
EffectiveEndDate: string
(date)
Read Only:
true
Effective end date of the location. -
EffectiveStartDate: string
(date)
Title:
Proposed Start Date
Read Only:true
Effective start date of the location. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
Email address of the location. -
EmployeesTotal: number
Read Only:
true
Total number of employees for the business location. -
EnabledFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the business location has been enabled. -
EndDate: string
(date)
Read Only:
true
The end date of the business location. -
EOnePhoneContactPointId: integer
(int64)
Read Only:
true
Unique identifier of the primary emergency phone contact. -
ETwoPhoneContactPointId: integer
(int64)
Read Only:
true
Unique identifier of the secondary emergency phone contact. -
FloorNumber: string
Read Only:
true
Maximum Length:40
The floor number of the physical address. -
InactiveReason: string
Read Only:
true
Maximum Length:1000
The reason that the business location was inactivated. -
JgzzFiscalCode: string
Read Only:
true
Maximum Length:20
Taxpayer identification number, often unique identifier of person or organization. Can be SSN or income taxpayer ID in US, fiscal code or NIF in Europe. -
Landmark: string
Read Only:
true
Maximum Length:200
Landmark for the parcel address. -
Latitude: number
Read Only:
true
Latitude of the location. -
LineOfBusiness: string
Read Only:
true
Maximum Length:240
Line of business. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationType: string
Title:
Location Type
Read Only:true
Maximum Length:30
The type of location. -
Longitude: number
Read Only:
true
Longitude of the location. -
MailAddress1: string
Read Only:
true
Maximum Length:240
First line of the location mailing address. -
MailAddress2: string
Read Only:
true
Maximum Length:240
Second line of the location mailing address. -
MailAddress3: string
Read Only:
true
Maximum Length:240
Third line of the location mailing address. -
MailAddress4: string
Read Only:
true
Maximum Length:240
Fourth line of the location mailing address. -
MailAddrsLocId: integer
(int64)
Read Only:
true
Unique identifier of the mailing address for the business location. -
MailCity: string
Read Only:
true
Maximum Length:60
Location mailing city. -
MailCountry: string
Read Only:
true
Maximum Length:2
Location mailing country. -
MailCounty: string
Read Only:
true
Maximum Length:60
Location mailing county. -
MailPostalCode: string
Read Only:
true
Maximum Length:60
Location mailing postal code. -
MailPostalPlusCode: string
Read Only:
true
Maximum Length:20
Location mailing postal plus 4 code. -
MailProvince: string
Read Only:
true
Maximum Length:60
Location mailing province. -
MailState: string
Read Only:
true
Maximum Length:60
Location mailing state. -
MobileBusinessFlag: string
Title:
Is this a mobile business?
Read Only:true
Maximum Length:1
Indicates whether the business is a mobile product or provides mobile service. -
MunicipalityId: string
Read Only:
true
Maximum Length:20
Municipality in which the parcel address is located. -
OrganizationName: string
Title:
Doing Business As
Read Only:true
Maximum Length:360
Doing business as name. -
OrgProfilesStatus: string
Read Only:
true
Maximum Length:1
Organization profile status. -
OtherTaxId: string
Title:
County Tax ID
Read Only:true
Maximum Length:20
County tax ID of the business location. -
ParcelId: integer
(int64)
Title:
Parcel
Read Only:true
The unique identifier for the parcel. -
ParcelIdEntered: string
Read Only:
true
Maximum Length:30
The parcel number. -
Position: string
Read Only:
true
Maximum Length:50
Street direction of the location. -
PostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:60
Physical address postal code. -
PostalPlus4Code: string
Read Only:
true
Maximum Length:20
Physical address postal plus 4 code. -
PrimaryPhoneAreaCode: string
Read Only:
true
Maximum Length:20
Primary phone area code. -
PrimaryPhoneCountryCode: string
Read Only:
true
Maximum Length:10
Primary phone country code. -
PrimaryPhoneExtension: string
Read Only:
true
Maximum Length:20
Primary phone extension number of the location. -
PrimaryPhoneNumber: string
Title:
Primary Phone
Read Only:true
Maximum Length:40
Primary phone number of the location. -
PrimaryPhoneType: string
Title:
Primary Phone Type
Read Only:true
Maximum Length:30
Primary phone type of the location. -
PrimaryRawPhoneNumber: string
Read Only:
true
Maximum Length:60
Primary raw phone number of the location. -
PrimPhoneContactPointId: integer
(int64)
Read Only:
true
Primary phone contact point identifier. -
Province: string
Title:
Province
Read Only:true
Maximum Length:60
Physical address province. -
RentalUnitNum: integer
(int64)
Read Only:
true
Number of rental units for the business location. -
SameMailAddressFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the mailing address is same as the location address. -
SellPerNum: string
Title:
Seller's Permit Number
Read Only:true
Maximum Length:30
Business sellers permit number of the location. -
SellPerNumExp: string
(date)
Title:
Seller's Permit Expiration Date
Read Only:true
Expiration date of the business sellers permit number associated with the location. -
StartDate: string
(date)
Read Only:
true
The start date of the business location. -
State: string
Title:
State
Read Only:true
Maximum Length:60
Physical address state. -
Status: string
Title:
Status
Read Only:true
Maximum Length:20
Current status of the location. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
Current status meaning of the location. -
StQualPerNum: string
Title:
State Equalization Board Number
Read Only:true
Maximum Length:30
State equalization board number of the business location. -
StreetName: string
Read Only:
true
Maximum Length:240
Street name used for parcel address searches. -
StreetSuffix: string
Read Only:
true
Maximum Length:20
Street name that describes the street. -
StreetType: string
Read Only:
true
Maximum Length:20
Street type used for parcel address searches. -
TaxClass: string
Title:
Tax Class Name
Read Only:true
Maximum Length:30
Municipal tax class of the business location. -
UnitNumber: string
Read Only:
true
Maximum Length:30
Apartment unit number used for parcel address searches. -
Website: string
Title:
Website
Read Only:true
Maximum Length:1000
Website address of the location. -
WithinJurisdictionFlag: string
Title:
Is this business physically located within the agency's jurisdiction?
Read Only:true
Maximum Length:1
Indicates whether the business is located within agency jurisdiction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorBusinessEntityListDetails-BusOwnersLists-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address 1
Read Only:true
Maximum Length:240
First line of the physical address. -
Address2: string
Title:
Address 2
Read Only:true
Maximum Length:240
Second line of the physical address. -
Address3: string
Title:
Address 3
Read Only:true
Maximum Length:240
Third line of the physical address. -
Address4: string
Title:
Address 4
Read Only:true
Maximum Length:240
Fourth line of the physical address. -
AgencyId: integer
(int32)
Read Only:
true
Unique identifier for the agency. -
BePersonId: string
Read Only:
true
Maximum Length:200
Meaningful identifier of a responsible person for the business. -
BePersonLengthAtAddress: integer
(int64)
Read Only:
true
The length of time that the person has been at this address. -
BusContactDmvLicExp: string
(date)
Title:
Expiration Date
Read Only:true
Contact DMV expiry date. -
BusContactDmvLicNum: string
Title:
Driver's License
Read Only:true
Maximum Length:30
Contact DMV license number. -
BusContactDmvLicSt: string
Title:
Issuing State
Read Only:true
Maximum Length:60
Contact DMV license state. -
BusinessEntityId: string
Title:
Business
Read Only:true
Maximum Length:50
The unique identifier for a business entity. -
BusinessEntityKey: integer
(int64)
Read Only:
true
System generated unique identifier for a business entity. -
CitizenshipStatus: string
Title:
Citizenship Status
Read Only:true
Maximum Length:30
The citizenship status of an owner. -
City: string
Title:
City
Read Only:true
Maximum Length:60
Physical address city. -
Country: string
Title:
Country
Read Only:true
Maximum Length:2
Physical address country. -
County: string
Read Only:
true
Maximum Length:60
Physical address county. -
DateOfBirth: string
(date)
Title:
Date of Birth
Read Only:true
Date of birth of the person. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
Email address of the person. -
EntityPartyId: integer
(int64)
Read Only:
true
Business entity party ID. -
JobTitle: string
Title:
Title
Read Only:true
Maximum Length:100
Person title. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MailingAddress1: string
Read Only:
true
Maximum Length:240
First line of the location mailing address. -
MailingAddress2: string
Read Only:
true
Maximum Length:240
Second line of the location mailing address. -
MailingAddress3: string
Read Only:
true
Maximum Length:240
Third line of the location mailing address. -
MailingAddress4: string
Read Only:
true
Maximum Length:240
Fourth line of the location mailing address. -
MailingCity: string
Read Only:
true
Maximum Length:60
Mailing address city. -
MailingCountry: string
Read Only:
true
Maximum Length:2
Mailing address country. -
MailingCounty: string
Read Only:
true
Maximum Length:60
Mailing address county. -
MailingPostalCode: string
Read Only:
true
Maximum Length:60
Mailing address postal code. -
MailingPostalPlusCode: string
Read Only:
true
Maximum Length:20
Mailing address postal plus 4 code. -
MailingProvince: string
Read Only:
true
Maximum Length:60
Mailing address province. -
MailingState: string
Read Only:
true
Maximum Length:60
Mailing address state. -
OwnerPartyId: integer
Read Only:
true
The unique identifier for an owner party. -
PercentageOwnership: number
Title:
Ownership Percentage
Read Only:true
Indicates a person's percentage of ownership in the business. -
PersonFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
First name of the person. -
PersonLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
Last name of the person. -
PersonMiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
Middle name of the person. -
PersonName: string
Read Only:
true
Maximum Length:450
Name of the person. -
PersonNameSuffix: string
Title:
Suffix
Read Only:true
Maximum Length:30
Person name suffix. -
PhoneAreaCode: string
Read Only:
true
Maximum Length:20
Area code. -
PhoneCountryCode: string
Read Only:
true
Maximum Length:10
Country code. -
PhoneExtension: string
Read Only:
true
Maximum Length:20
Phone extension number. -
PhoneNumber: string
Read Only:
true
Maximum Length:40
Phone number. -
PhoneType: string
Title:
Phone Type
Read Only:true
Maximum Length:30
Phone type. -
PostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:60
Physical address postal code. -
PostalPlus4Code: string
Read Only:
true
Maximum Length:20
Physical address postal plus 4 code. -
Province: string
Title:
Province
Read Only:true
Maximum Length:60
Physical address province. -
RawPhoneNumber: string
Read Only:
true
Maximum Length:60
Raw phone number. -
ReferenceKey: integer
(int64)
Read Only:
true
System generated unique identifier for an owner. -
ReferencePuid: string
Read Only:
true
Maximum Length:50
The unique identifier for an owner. -
Salutation: string
Title:
Salutation
Read Only:true
Maximum Length:60
Person's prename adjunct. -
SameAsApplicantFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the physical address is the same as the mailing address. -
SameMailAddressFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the physical address is the same as the mailing address. -
State: string
Title:
State
Read Only:true
Maximum Length:60
Physical address state. -
Status: string
Read Only:
true
Maximum Length:30
Current status of the owner. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the owner's current status. -
VerificationDate: string
(date)
Read Only:
true
The date that the responsible person was verified. -
VerificationStatus: string
Read Only:
true
Maximum Length:30
The verification status for the responsible person. -
VerifiedBy: string
Read Only:
true
Maximum Length:30
Identifies who verified the responsible person.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- BusLocationListDetails
-
Parameters:
- BusinessEntityKey:
$request.path.BusinessEntityKey
The business location list details resource is used to view detailed information about the locations associated with a business entity. - BusinessEntityKey:
- BusOwnersLists
-
Parameters:
- BusinessEntityKey:
$request.path.BusinessEntityKey
The business owner list details resource is used to view detailed information about the owners associated with a business entity. - BusinessEntityKey: