Jump to

• Request
• Response

Get all business owners

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/BusinessOwner

Request

Path Parameters

• LnpRecordKey(required): integer(int64)
  The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a business owner by the specified primary key criteria.
    Finder Variables:
    • LnpBusinessOwnersKey; integer; The unique identifier for a business owner.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Address1; string; The address portion of the person???s address.
  • Address2; string; The address portion of the person???s address.
  • Address3; string; The address portion of the person???s address.
  • Address4; string; The address portion of the person???s address.
  • AgencyId; integer; The identifier of the agency.
  • BePersonId; string; Meaningful identifier of a responsible person for the business.
  • BePersonKey; integer; The unique identifier of a responsible person for the business.
  • BusinessEntityId; string; Meaningful identifier for business location.
  • BusinessEntityKey; integer; The unique identifier for the business entity.
  • BusinessLocationId; string; Meaningful identifier for business location.
  • BusinessLocationKey; integer; The unique identifier for business location.
  • CitizenshipStatus; string; The citizenship status of an owner.
  • City; string; The city portion of the person???s address.
  • ContactDmvLicExp; string; The responsible person???s driver???s license expiration date.
  • ContactDmvLicNum; string; The responsible person???s driver???s license number.
  • ContactDmvLicSt; string; The responsible person???s driver???s license issued state.
  • Country; string; The address portion of the person???s address.
  • County; string; The county portion of the person???s address.
  • DateOfBirth; string; The responsible person???s date of birth.
  • EmailAddress; string; The responsible person???s email address.
  • EmergencyContactFlag; boolean; Indicates if an emergency contact phone exists.
  • LnpBusinessOwnersKey; integer; The unique identifier for the transaction business owners.
  • LnpBusinessOwnersPuid; string; The unique identifier of the migrated business owner record.
  • LnpRecordId; string; Meaningful identifier for the transaction.
  • LnpRecordKey; integer; The unique identifier for the transaction.
  • MailingAddress1; string; The address portion of the person???s address.
  • MailingAddress2; string; The address portion of the person???s address.
  • MailingAddress3; string; The address portion of the person???s address.
  • MailingAddress4; string; The address portion of the person???s address.
  • MailingCity; string; The city portion of the person???s address.
  • MailingCountry; string; The country portion of the person???s address.
  • MailingCounty; string; The county portion of the person???s address.
  • MailingPostalCode; string; The postal code portion of the person???s address.
  • MailingPostalPlusFourCode; string; The postal4 code portion of the person???s address.
  • MailingProvince; string; The province portion of the person???s address.
  • MailingState; string; The state portion of the person???s address.
  • OwnershipPct; number; The person???s ownership percentage.
  • PartyId; integer; The unique identifier of a responsible person for the business.
  • PersonFirstName; string; The first name of the responsible person.
  • PersonLastName; string; The last name of the responsible person.
  • PersonLengthAtAddress; integer; The length of time the person has been at the address.
  • PersonMiddleName; string; The middle name of the responsible person.
  • PersonName; string; Full concatenated name including first, middle, last, and suffix names.
  • PersonNameSuffix; string; The name suffix of the responsible person.
  • PersonPreNameAdjunct; string; The salutation for the responsible person.
  • PersonTitle; string; The title for the responsible person.
  • PhoneAreaCode; string; The contact's phone area code within a country.
  • PhoneCountryCode; string; The international country code for a contact's telephone number.
  • PhoneExtension; string; The person???s additional extension number after initial connection to an internal telephone system.
  • PhoneNumber; string; The phone number of the user's contact.
  • PhoneType; string; The type of phone for the responsible person.
  • PostalCode; string; The postal code portion of the person???s address.
  • PostalPlus4Code; string; The postal4 code portion of the person???s address.
  • Province; string; The province portion of the person???s address.
  • RawPhoneNumber; string; The responsible person???s full phone number.
  • RecordNumber; string; The record number of the business owner.
  • ReferencePuid; string; The unique identifier of the migrated business owner setup record.
  • SameAsApplicantFlag; boolean; Indicates that the owners address is the same as the applicant???s address.
  • SameMailAddressFlag; boolean; Indicates that the mailing address is the same as the primary address.
  • State; string; The state portion of the person???s address.
  • Status; string; The status of responsible person for the business.
  • VerificationDate; string; The date the responsible person was verified.
  • VerificationStatus; string; The verification status for the responsible person.
  • VerifiedBy; string; The agency staff that verified the responsible person.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorRecordLists-BusinessOwner

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecordLists-BusinessOwner-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorRecordLists-BusinessOwner-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecordLists-BusinessOwner-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorRecordLists-BusinessOwner-item-response

Type: object

Show Source

• Address1: string
  Title: Address 1

  Maximum Length: 240

  The address portion of the person???s address.
• Address2: string
  Title: Address 2

  Maximum Length: 240

  The address portion of the person???s address.
• Address3: string
  Title: Address 3

  Maximum Length: 240

  The address portion of the person???s address.
• Address4: string
  Title: Address 4

  Maximum Length: 240

  The address portion of the person???s address.
• AgencyId: integer (int32)
  Default Value: 1

  The identifier of the agency.
• BePersonId: string
  Maximum Length: 200

  Meaningful identifier of a responsible person for the business.
• BePersonKey: integer (int64)
  The unique identifier of a responsible person for the business.
• BusinessEntityId: string
  Title: Business ID

  Maximum Length: 50

  Meaningful identifier for business location.
• BusinessEntityKey: integer (int64)
  The unique identifier for the business entity.
• BusinessLocationId: string
  Maximum Length: 50

  Meaningful identifier for business location.
• BusinessLocationKey: integer (int64)
  The unique identifier for business location.
• CitizenshipStatus: string
  Title: Citizenship Status

  Maximum Length: 30

  The citizenship status of an owner.
• City: string
  Title: City

  Maximum Length: 60

  The city portion of the person???s address.
• ContactAccess: string
  Maximum Length: 80

  Access rights provided to the contact owner.
• ContactDmvLicExp: string (date)
  Title: Expiration Date

  The responsible person???s driver???s license expiration date.
• ContactDmvLicNum: string
  Title: Driver's License

  Maximum Length: 30

  The responsible person???s driver???s license number.
• ContactDmvLicSt: string
  Title: Issuing State

  Maximum Length: 60

  The responsible person???s driver???s license issued state.
• ContactPrimaryFlag: boolean
  Maximum Length: 80

  The unique identifier for the primary contact owner.
• ContactType: string
  Maximum Length: 80

  The type of the contact owner.
• Country: string
  Title: Country

  Maximum Length: 3

  The address portion of the person???s address.
• County: string
  Title: County

  Maximum Length: 60

  The county portion of the person???s address.
• DateOfBirth: string (date)
  Title: Date of Birth

  The responsible person???s date of birth.
• EmailAddress: string
  Title: Email

  Maximum Length: 320

  The responsible person???s email address.
• EmergencyContactFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates if an emergency contact phone exists.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpBusinessOwnersKey: integer (int64)
  The unique identifier for the transaction business owners.
• LnpBusinessOwnersPuid: string
  Maximum Length: 480

  The unique identifier of the migrated business owner record.
• LnpRecordId: string
  Maximum Length: 50

  Meaningful identifier for the transaction.
• LnpRecordKey: integer (int64)
  The unique identifier for the transaction.
• MailingAddress1: string
  Title: Address 1

  Maximum Length: 240

  The address portion of the person???s address.
• MailingAddress2: string
  Title: Address 2

  Maximum Length: 240

  The address portion of the person???s address.
• MailingAddress3: string
  Title: Address 3

  Maximum Length: 240

  The address portion of the person???s address.
• MailingAddress4: string
  Title: Address 4

  Maximum Length: 240

  The address portion of the person???s address.
• MailingCity: string
  Title: City

  Maximum Length: 60

  The city portion of the person???s address.
• MailingCountry: string
  Title: Country

  Maximum Length: 3

  The country portion of the person???s address.
• MailingCounty: string
  Title: County

  Maximum Length: 60

  The county portion of the person???s address.
• MailingPostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code portion of the person???s address.
• MailingPostalPlusFourCode: string
  Title: Postal Plus 4 Code

  Maximum Length: 10

  The postal4 code portion of the person???s address.
• MailingProvince: string
  Title: Province

  Maximum Length: 60

  The province portion of the person???s address.
• MailingState: string
  Title: State

  Maximum Length: 60

  The state portion of the person???s address.
• OwnershipPct: number
  Title: Ownership Percentage

  The person???s ownership percentage.
• PartyId: integer (int64)
  The unique identifier of a responsible person for the business.
• PersonFirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of the responsible person.
• PersonLastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of the responsible person.
• PersonLengthAtAddress: integer (int64)
  Title: Years at This Location

  The length of time the person has been at the address.
• PersonMiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name of the responsible person.
• PersonName: string
  Title: Name

  Maximum Length: 450

  Full concatenated name including first, middle, last, and suffix names.
• PersonNameSuffix: string
  Title: Suffix

  Maximum Length: 30

  The name suffix of the responsible person.
• PersonPreNameAdjunct: string
  Title: Salutation

  Maximum Length: 30

  The salutation for the responsible person.
• PersonTitle: string
  Title: Title

  Maximum Length: 60

  The title for the responsible person.
• PhoneAreaCode: string
  Maximum Length: 10

  The contact's phone area code within a country.
• PhoneCountryCode: string
  Maximum Length: 10

  The international country code for a contact's telephone number.
• PhoneExtension: string
  Maximum Length: 20

  The person???s additional extension number after initial connection to an internal telephone system.
• PhoneNumber: string
  Maximum Length: 40

  The phone number of the user's contact.
• PhoneType: string
  Title: Phone Type

  Maximum Length: 30

  The type of phone for the responsible person.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code portion of the person???s address.
• PostalPlus4Code: string
  Title: Postal Plus 4 Code

  Maximum Length: 10

  The postal4 code portion of the person???s address.
• Province: string
  Title: Province

  Maximum Length: 60

  The province portion of the person???s address.
• RawPhoneNumber: string
  Maximum Length: 60

  The responsible person???s full phone number.
• RecordNumber: string
  Maximum Length: 64

  The record number of the business owner.
• ReferencePuid: string
  Maximum Length: 480

  The unique identifier of the migrated business owner setup record.
• SameAsApplicantFlag: boolean
  Title: Is the applicant an owner or a corporate officer?

  Maximum Length: 1

  Default Value: false

  Indicates that the owners address is the same as the applicant???s address.
• SameMailAddressFlag: boolean
  Title: Is the mailing address the same as the physical address?

  Maximum Length: 1

  Default Value: false

  Indicates that the mailing address is the same as the primary address.
• State: string
  Title: State

  Maximum Length: 60

  The state portion of the person???s address.
• Status: string
  Title: Status

  Maximum Length: 30

  The status of responsible person for the business.
• VerificationDate: string (date)
  The date the responsible person was verified.
• VerificationStatus: string
  Maximum Length: 30

  The verification status for the responsible person.
• VerifiedBy: string
  Maximum Length: 200

  The agency staff that verified the responsible person.

{
    "type":"object",
    "properties":{
        "VerificationStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The verification status for the responsible person.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "VerificationDate":{
            "type":"string",
            "description":"The date the responsible person was verified.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContactType":{
            "maxLength":"80",
            "type":"string",
            "description":"The type of the contact owner.",
            "nullable":true,
            "x-queryable":false
        },
        "SameMailAddressFlag":{
            "title":"Is the mailing address the same as the physical address?",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the mailing address is the same as the primary address.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name of the responsible person.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"The title for the responsible person.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BusinessEntityKey":{
            "type":"integer",
            "description":"The unique identifier for the business entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "MailingPostalPlusFourCode":{
            "title":"Postal Plus 4 Code",
            "maxLength":"10",
            "type":"string",
            "description":"The postal4 code portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EmergencyContactFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an emergency contact phone exists.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CitizenshipStatus":{
            "title":"Citizenship Status",
            "maxLength":"30",
            "type":"string",
            "description":"The citizenship status of an owner.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BePersonKey":{
            "type":"integer",
            "description":"The unique identifier of a responsible person for the business.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContactDmvLicSt":{
            "title":"Issuing State",
            "maxLength":"60",
            "type":"string",
            "description":"The responsible person???s driver???s license issued state.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DateOfBirth":{
            "title":"Date of Birth",
            "type":"string",
            "description":"The responsible person???s date of birth.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of responsible person for the business.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ReferencePuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The unique identifier of the migrated business owner setup record.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the responsible person.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "MailingCity":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the responsible person.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The responsible person???s email address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PhoneExtension":{
            "maxLength":"20",
            "type":"string",
            "description":"The person???s additional extension number after initial connection to an internal telephone system.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":"10",
            "type":"string",
            "description":"The postal4 code portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BusinessLocationId":{
            "maxLength":"50",
            "type":"string",
            "description":"Meaningful identifier for business location.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PhoneType":{
            "title":"Phone Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of phone for the responsible person.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The address portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "VerifiedBy":{
            "maxLength":"200",
            "type":"string",
            "description":"The agency staff that verified the responsible person.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PersonLengthAtAddress":{
            "title":"Years at This Location",
            "type":"integer",
            "description":"The length of time the person has been at the address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContactDmvLicNum":{
            "title":"Driver's License",
            "maxLength":"30",
            "type":"string",
            "description":"The responsible person???s driver???s license number.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContactAccess":{
            "maxLength":"80",
            "type":"string",
            "description":"Access rights provided to the contact owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RecordNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"The record number of the business owner.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "RawPhoneNumber":{
            "maxLength":"60",
            "type":"string",
            "description":"The responsible person???s full phone number.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContactPrimaryFlag":{
            "maxLength":"80",
            "type":"boolean",
            "description":"The unique identifier for the primary contact owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "BusinessEntityId":{
            "title":"Business ID",
            "maxLength":"50",
            "type":"string",
            "description":"Meaningful identifier for business location.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "OwnershipPct":{
            "title":"Ownership Percentage",
            "type":"number",
            "description":"The person???s ownership percentage.",
            "nullable":true,
            "x-hints":{
                "precision":"10",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "scale":"7"
            },
            "x-queryable":true
        },
        "MailingCountry":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "SameAsApplicantFlag":{
            "title":"Is the applicant an owner or a corporate officer?",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the owners address is the same as the applicant???s address.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "title":"Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The name suffix of the responsible person.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "MailingCounty":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "MailingState":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The international country code for a contact's telephone number.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The contact's phone area code within a country.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContactDmvLicExp":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The responsible person???s driver???s license expiration date.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address 4",
            "maxLength":"240",
            "type":"string",
            "description":"The address portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "MailingPostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "MailingAddress3":{
            "title":"Address 3",
            "maxLength":"240",
            "type":"string",
            "description":"The address portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "MailingAddress4":{
            "title":"Address 4",
            "maxLength":"240",
            "type":"string",
            "description":"The address portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "MailingAddress1":{
            "title":"Address 1",
            "maxLength":"240",
            "type":"string",
            "description":"The address portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "MailingAddress2":{
            "title":"Address 2",
            "maxLength":"240",
            "type":"string",
            "description":"The address portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BePersonId":{
            "maxLength":"200",
            "type":"string",
            "description":"Meaningful identifier of a responsible person for the business.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PersonPreNameAdjunct":{
            "title":"Salutation",
            "maxLength":"30",
            "type":"string",
            "description":"The salutation for the responsible person.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":"50",
            "type":"string",
            "description":"Meaningful identifier for the transaction.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "MailingProvince":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PersonName":{
            "title":"Name",
            "maxLength":"450",
            "type":"string",
            "description":"Full concatenated name including first, middle, last, and suffix names.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BusinessLocationKey":{
            "type":"integer",
            "description":"The unique identifier for business location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address 2",
            "maxLength":"240",
            "type":"string",
            "description":"The address portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Address3":{
            "title":"Address 3",
            "maxLength":"240",
            "type":"string",
            "description":"The address portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Address1":{
            "title":"Address 1",
            "maxLength":"240",
            "type":"string",
            "description":"The address portion of the person???s address.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LnpBusinessOwnersKey":{
            "type":"integer",
            "description":"The unique identifier for the transaction business owners.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LnpBusinessOwnersPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The unique identifier of the migrated business owner record.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of a responsible person for the business.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "maxLength":"40",
            "type":"string",
            "description":"The phone number of the user's contact.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top