Jump to

• Request
• Response

Get all business licenses, credentials, and associated conditions

get

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLicenseCredentialsWithoutTransients

Request

Query Parameters

• 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 business licenses and credentials that match the specified filter values.
    Finder Variables:
    • LnpCredentialKey; integer; Finds business licenses and credentials that match the specified credential.
    • LnpRecordId; string; Finds business licenses and credentials that match the specified business license identifier.
    • LnpRecordKey; integer; Finds business licenses and credentials that match the specified business license key.
• 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:
  

  • AboutToExpireDate; string; The date an expiring license/permit notification is sent.
  • AcceptanceDate; string; The accepted date for the business license application.
  • ActivityDescription; string; The description of the business license application.
  • AddressId; integer; The reference key to the TCA location table.
  • AgencyId; integer; The identifier for a public-sector agency (typically an alphanumeric ID for a city, county, or state, but it may also be the agency name).
  • AmendmentType; string; Indicates whether an inactive application should be reactivated from the amendment intake form.
  • ApplAteDate; string; The date an about-to-expire notification is sent for the permit application.
  • ApplExpirationDate; string; The date the application expires.
  • Applicant; integer; The party ID of the permit applicant.
  • ApplicantAddressOne; string; Address line 1 for the business license applicant.
  • ApplicantAddressTwo; string; Address line 2 for the business license applicant.
  • ApplicantBizProfileId; integer; The business profile used by the applicant.
  • ApplicantCity; string; The city in the applicant???s address.
  • ApplicantCountry; string; The country in the applicant???s address.
  • ApplicantCounty; string; The county in the applicant???s address.
  • ApplicantEmailAddressOne; string; The applicant???s primary email address.
  • ApplicantEmailAddressTwo; string; The applicant???s secondary email address.
  • ApplicantPhoneAreaCode; string; The area code for the applicant???s phone number.
  • ApplicantPhoneCountryCode; string; The country code for the applicant???s phone number.
  • ApplicantPhoneExtension; string; The applicant???s phone extension.
  • ApplicantPhoneNumber; string; The applicant???s phone number.
  • ApplicantPostalCode; string; The postal code in the applicant???s address.
  • ApplicantProfileId; integer; The applicant???s user profile.
  • ApplicantProvince; string; The province in the applicant???s address.
  • ApplicantState; string; The state in the applicant???s address.
  • ApplyToInProcessTrans; string; Indicates whether the value also applies to in-progress transactions.
  • AssignedSpecialistName; string; The user name of the specialist assigned to the application.
  • AssignedSpecialistUserid; string; The user ID of the specialist assigned to the application.
  • AttributeCategory; string; The category of the business license type.
  • BalanceDue; number; The fee balance due for this application.
  • BusAddressOne; string; Address line 1 for the business address.
  • BusAddressTwo; string; Address line 2 for the business address.
  • BusBusinessLegalName; string; The legal name of the business entity.
  • BusBusinessName; string; The name of the applicant???s business (for example, a contractor???s business name).
  • BusCity; string; The city for the business address.
  • BusCountry; string; The country for the business address.
  • BusCounty; string; The county for the business address.
  • BusDbaBusinessName; string; The ???doing business as??? (DBA) name for the business.
  • BusDescription; string; A field in the Business Information component of the form designer used to enter a description of the business.
  • BusOwnershipType; string; A field in the Business Information component of the form designer that describes the type of business ownership.
  • BusPostalCode; string; The postal code for the business address.
  • BusProvince; string; The province for the business address.
  • BusStartDate; string; The field used to enter the business establishment date in the Business Information component of the form designer.
  • BusState; string; The state for the business address.
  • Classification; string; The record classification (permit, business license, professional license, or planning and zoning).
  • ConditionName; string; The condition associated with a business license application.
  • CreatedBy; string; The user ID of the person who created the business license application.
  • CreationDate; string; The date the business license application was created.
  • CredentialCode; string; The credential type.
  • CredentialName; string; The credential name.
  • CurrencyCode; string; The currency code.
  • DelinquentDate; string; The date the license becomes delinquent.
  • EffChangeDate; string; The effective change date of a business license record.
  • ExemptReasonMeaning; string; The meaning/description of the credential exemption reason.
  • ExpirationDate; string; The date the license or permit is no longer valid.
  • ExpirationGraceDate; string; The expiration grace date for the business license application.
  • ExpirationStatus; string; The expiration status of the business license application.
  • FeeDueUpdateDate; string; The identifier that captures the date when a due-status fee item is added or updated.
  • InheritFlag; string; Indicates whether the value is inherited.
  • IssueDate; string; The date the license or permit was issued (used in the Application Information component of the Permit Designer).
  • LastUpdateDate; string; The last-updated date of the business license application.
  • LastUpdatedBy; string; The user ID of the person who last updated the business license application.
  • LicensePeriod; string; The period for which the business license is valid.
  • LicenseStatus; string; The overall status of the business license.
  • LicenseSystemStatus; string; The system status of the business license.
  • LnpCredentialKey; integer; The identifier of the business license credential record.
  • LnpRecordId; string; The unique identifier of the record.
  • LnpRecordKey; integer; The identifier of the business license record.
  • LocAltPhoneExtn; string; The extension used after connecting to an internal phone system.
  • LocAltPhoneNumber; string; The full phone number for the location.
  • LocAltPhoneType; string; The phone type for the location.
  • LocEmailAddress; string; The email address for the business location.
  • LocPrimaryPhoneExtn; string; The extension used after connecting to an internal phone system.
  • LocPrimaryPhoneNumber; string; The location phone number.
  • LocPrimaryPhoneType; string; The phone type for the location.
  • LocationAddressOne; string; Parcel address line 1.
  • LocationAddressTwo; string; Parcel address line 2.
  • LocationCity; string; The city in the parcel address.
  • LocationCountry; string; The country in the parcel address.
  • LocationCounty; string; The county where the parcel address is located.
  • LocationPostalCode; string; The postal code in the parcel address.
  • LocationProvince; string; The province in the parcel address.
  • LocationState; string; The state in the parcel address.
  • MailingAddress1; string; Location address line 1.
  • MailingAddress2; string; Location address line 2.
  • MailingCity; string; The city in the location address.
  • MailingCountry; string; The country in the location address.
  • MailingCounty; string; The county in the location address.
  • MailingPostalCode; string; The postal code in the location address.
  • MailingProvince; string; The province in the location address.
  • MailingState; string; The state in the location address.
  • MobileBusFlag; string; Indicates whether the business is mobile.
  • OraAmount; number; The amount associated with the credential.
  • OraBusinessName; string; The associated business name.
  • OraCertificateNumber; string; The certificate or license number associated with the credential.
  • OraCurrency; string; The currency associated with the amount.
  • OraDescription; string; The description associated with the credential.
  • OraExempt; string; Indicates whether the business is exempt from the credential.
  • OraExemptReason; string; The reason for the credential exemption.
  • OraExpirationDate; string; The expiration date for the certificate or license number.
  • OraQualifierName; string; The name of the qualifying individual.
  • OraStartDate; string; The start date for the certificate or license number.
  • OrganizationName; string; The applicant???s business name (for example, a contractor???s business name).
  • Originator; string; The originator of the business license application.
  • ParcelId; integer; The identifier of the record parcel.
  • PermitStatus; string; The overall status of the application.
  • PersonFirstName; string; The applicant???s first name.
  • PersonLastName; string; The applicant???s last name.
  • PersonMiddleName; string; The applicant???s middle name.
  • PersonName; string; The name of the license/business license applicant.
  • PersonTitle; string; The contact???s title.
  • ReceivedDate; string; The received date for the license application.
  • RecordStatus; string; The record status.
  • RecordType; string; The user-friendly name of the record type.
  • RecordTypeId; string; The identifier of the record type.
  • RenewalDate; string; The renewal date for the license or permit.
  • Subclassification; string; The subclassification of the business license application type.
  • SubmitDate; string; The date the license transaction was submitted.
  • SubmittedBy; string; The user ID of the person who submitted the business license application.
  • SystemStatus; string; The system status of the business license application.
  • TotalFees; number; The total amount of all fees for this application.
  • TotalHold; number; The total amount of fees on hold for this application.
  • TotalOutstanding; number; The total amount of fees outstanding for this application.
  • TotalPaid; number; The total amount paid for this application.
  • TotalPayable; number; The total amount of fees payable for this application.
  • TotalPending; number; The total amount of fees pending for this application.
  • TotalWaived; number; The total amount of fees waived for this application.
  • VersionType; string; The version of the business license application.
• 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: string
  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: string
  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 : publicSectorBusinessLicenseCredentialsWithoutTransients

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorBusinessLicenseCredentialsWithoutTransients-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "subgroup":"CommonSetup",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorBusinessLicenseCredentialsWithoutTransients-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorBusinessLicenseCredentialsWithoutTransients-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 : publicSectorBusinessLicenseCredentialsWithoutTransients-item-response

Type: object

Show Source

• AboutToExpireDate: string (date-time)
  Title: About to Expire Date

  Read Only: true

  The date an expiring license/permit notification is sent.
• AcceptanceDate: string (date-time)
  Title: Acceptance Date

  Read Only: true

  The accepted date for the business license application.
• ActivityDescription: string
  Title: Activity Description

  Read Only: true

  Maximum Length: 1000

  The description of the business license application.
• AddressId: integer (int64)
  Title: Location Address ID

  Read Only: true

  The reference key to the TCA location table.
• AgencyId: integer
  Read Only: true

  The identifier for a public-sector agency (typically an alphanumeric ID for a city, county, or state, but it may also be the agency name).
• AmendmentType: string
  Title: Amendment Type

  Read Only: true

  Maximum Length: 1000

  Indicates whether an inactive application should be reactivated from the amendment intake form.
• ApplAteDate: string (date-time)
  Title: Application About to Expire Date

  Read Only: true

  The date an about-to-expire notification is sent for the permit application.
• ApplExpirationDate: string (date-time)
  Title: Application Expiration Date

  Read Only: true

  The date the application expires.
• Applicant: integer (int64)
  Read Only: true

  The party ID of the permit applicant.
• ApplicantAddressOne: string
  Title: Applicant Address Line 1

  Read Only: true

  Maximum Length: 240

  Address line 1 for the business license applicant.
• ApplicantAddressTwo: string
  Title: Applicant Address Line 2

  Read Only: true

  Maximum Length: 240

  Address line 2 for the business license applicant.
• ApplicantBizProfileId: integer (int64)
  Read Only: true

  The business profile used by the applicant.
• ApplicantCity: string
  Title: Applicant City

  Read Only: true

  Maximum Length: 60

  The city in the applicant???s address.
• ApplicantCountry: string
  Title: Applicant Country

  Read Only: true

  Maximum Length: 3

  The country in the applicant???s address.
• ApplicantCounty: string
  Title: Applicant County

  Read Only: true

  Maximum Length: 60

  The county in the applicant???s address.
• ApplicantEmailAddressOne: string
  Title: Applicant Email 1

  Read Only: true

  Maximum Length: 320

  The applicant???s primary email address.
• ApplicantEmailAddressTwo: string
  Title: Applicant Email 2

  Read Only: true

  Maximum Length: 320

  The applicant???s secondary email address.
• ApplicantPhoneAreaCode: string
  Title: Applicant Phone Area Code

  Read Only: true

  Maximum Length: 10

  The area code for the applicant???s phone number.
• ApplicantPhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

  The country code for the applicant???s phone number.
• ApplicantPhoneExtension: string
  Title: Applicant Phone Extension

  Read Only: true

  Maximum Length: 20

  The applicant???s phone extension.
• ApplicantPhoneNumber: string
  Title: Applicant Phone Number

  Read Only: true

  Maximum Length: 61

  The applicant???s phone number.
• ApplicantPostalCode: string
  Title: Applicant Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the applicant???s address.
• ApplicantProfileId: integer (int64)
  Read Only: true

  The applicant???s user profile.
• ApplicantProvince: string
  Title: Applicant Province

  Read Only: true

  Maximum Length: 60

  The province in the applicant???s address.
• ApplicantState: string
  Title: Applicant State

  Read Only: true

  Maximum Length: 60

  The state in the applicant???s address.
• ApplyToInProcessTrans: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the value also applies to in-progress transactions.
• AssignedSpecialistName: string
  Title: Assigned Specialist Name

  Read Only: true

  Maximum Length: 240

  The user name of the specialist assigned to the application.
• AssignedSpecialistUserid: string
  Title: Assigned Specialist User ID

  Read Only: true

  Maximum Length: 64

  The user ID of the specialist assigned to the application.
• AttributeCategory: string
  Read Only: true

  Maximum Length: 30

  The category of the business license type.
• BalanceDue: number
  Title: Fees Balance Due

  Read Only: true

  The fee balance due for this application.
• BusAddressOne: string
  Title: Business Address 1

  Read Only: true

  Maximum Length: 240

  Address line 1 for the business address.
• BusAddressTwo: string
  Title: Business Address 2

  Read Only: true

  Maximum Length: 240

  Address line 2 for the business address.
• BusBusinessLegalName: string
  Title: Business Legal Name

  Read Only: true

  Maximum Length: 240

  The legal name of the business entity.
• BusBusinessName: string
  Title: Business

  Read Only: true

  Maximum Length: 100

  The name of the applicant???s business (for example, a contractor???s business name).
• BusCity: string
  Title: Business City

  Read Only: true

  Maximum Length: 60

  The city for the business address.
• BusCountry: string
  Title: Business Country

  Read Only: true

  Maximum Length: 3

  The country for the business address.
• BusCounty: string
  Title: Business County

  Read Only: true

  Maximum Length: 60

  The county for the business address.
• BusDbaBusinessName: string
  Read Only: true

  Maximum Length: 100

  The ???doing business as??? (DBA) name for the business.
• BusDescription: string
  Title: Location Business Description

  Read Only: true

  Maximum Length: 200

  A field in the Business Information component of the form designer used to enter a description of the business.
• BusOwnershipType: string
  Title: Business Ownership Type

  Read Only: true

  Maximum Length: 15

  A field in the Business Information component of the form designer that describes the type of business ownership.
• BusPostalCode: string
  Title: Business Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code for the business address.
• BusProvince: string
  Title: Business Province

  Read Only: true

  Maximum Length: 60

  The province for the business address.
• BusStartDate: string (date)
  Title: Proposed Effective Date

  Read Only: true

  The field used to enter the business establishment date in the Business Information component of the form designer.
• BusState: string
  Title: Business State

  Read Only: true

  Maximum Length: 60

  The state for the business address.
• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 80

  The record classification (permit, business license, professional license, or planning and zoning).
• ConditionName: string
  Title: Business License Condition

  Read Only: true

  Maximum Length: 50

  The condition associated with a business license application.
• CreatedBy: string
  Title: Created by User ID

  Read Only: true

  Maximum Length: 64

  The user ID of the person who created the business license application.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the business license application was created.
• CredentialCode: string
  Title: Credential Code

  Read Only: true

  Maximum Length: 30

  The credential type.
• CredentialName: string
  Title: Credential Name

  Read Only: true

  Maximum Length: 100

  The credential name.
• CurrencyCode: string
  Title: Currency

  Read Only: true

  Maximum Length: 3

  The currency code.
• DelinquentDate: string (date-time)
  Read Only: true

  The date the license becomes delinquent.
• EffChangeDate: string (date)
  Title: Approved Effective Date

  Read Only: true

  The effective change date of a business license record.
• ExemptReasonMeaning: string
  Title: Credential Exemption Reason

  Read Only: true

  Maximum Length: 80

  The meaning/description of the credential exemption reason.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Read Only: true

  The date the license or permit is no longer valid.
• ExpirationGraceDate: string (date-time)
  Title: Grace Period Date

  Read Only: true

  The expiration grace date for the business license application.
• ExpirationStatus: string
  Title: Expiration Status

  Read Only: true

  Maximum Length: 15

  The expiration status of the business license application.
• FeeDueUpdateDate: string (date-time)
  Title: Fees Due Updated Date

  Read Only: true

  The identifier that captures the date when a due-status fee item is added or updated.
• InheritFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the value is inherited.
• IssueDate: string (date-time)
  Title: Issue Date

  Read Only: true

  The date the license or permit was issued (used in the Application Information component of the Permit Designer).
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The last-updated date of the business license application.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user ID of the person who last updated the business license application.
• LicensePeriod: string
  Title: License Period

  Read Only: true

  Maximum Length: 100

  The period for which the business license is valid.
• LicenseStatus: string
  Title: License Status

  Read Only: true

  Maximum Length: 30

  The overall status of the business license.
• LicenseSystemStatus: string
  Title: License System Status

  Read Only: true

  Maximum Length: 80

  The system status of the business license.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpCredentialKey: integer (int64)
  Read Only: true

  The identifier of the business license credential record.
• LnpRecordId: string
  Title: License ID

  Read Only: true

  Maximum Length: 50

  The unique identifier of the record.
• LnpRecordKey: integer (int64)
  Read Only: true

  The identifier of the business license record.
• LocAltPhoneExtn: string
  Title: Location Alternate Phone Extension

  Read Only: true

  Maximum Length: 20

  The extension used after connecting to an internal phone system.
• LocAltPhoneNumber: string
  Title: Location Alternate Phone Number

  Read Only: true

  Maximum Length: 61

  The full phone number for the location.
• LocAltPhoneType: string
  Title: Location Alternate Phone Type

  Read Only: true

  Maximum Length: 30

  The phone type for the location.
• LocationAddressOne: string
  Title: Location Address Line 1

  Read Only: true

  Maximum Length: 240

  Parcel address line 1.
• LocationAddressTwo: string
  Title: Location Address Line 2

  Read Only: true

  Maximum Length: 240

  Parcel address line 2.
• LocationCity: string
  Title: Location City

  Read Only: true

  Maximum Length: 60

  The city in the parcel address.
• LocationCountry: string
  Title: Location Country

  Read Only: true

  Maximum Length: 3

  The country in the parcel address.
• LocationCounty: string
  Title: Location County

  Read Only: true

  Maximum Length: 60

  The county where the parcel address is located.
• LocationPostalCode: string
  Title: Location Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the parcel address.
• LocationProvince: string
  Title: Location Province

  Read Only: true

  Maximum Length: 60

  The province in the parcel address.
• LocationState: string
  Title: Location State

  Read Only: true

  Maximum Length: 60

  The state in the parcel address.
• LocEmailAddress: string
  Title: Location Primary Email

  Read Only: true

  Maximum Length: 320

  The email address for the business location.
• LocPrimaryPhoneExtn: string
  Title: Location Primary Phone Extension

  Read Only: true

  Maximum Length: 20

  The extension used after connecting to an internal phone system.
• LocPrimaryPhoneNumber: string
  Title: Location Primary Phone

  Read Only: true

  Maximum Length: 61

  The location phone number.
• LocPrimaryPhoneType: string
  Title: Location Primary Phone Type

  Read Only: true

  Maximum Length: 30

  The phone type for the location.
• MailingAddress1: string
  Title: Mailing Address Line 1

  Read Only: true

  Maximum Length: 240

  Location address line 1.
• MailingAddress2: string
  Title: Mailing Address Line 2

  Read Only: true

  Maximum Length: 240

  Location address line 2.
• MailingCity: string
  Title: Mailing Address City

  Read Only: true

  Maximum Length: 60

  The city in the location address.
• MailingCountry: string
  Title: Mailing Address Country

  Read Only: true

  Maximum Length: 3

  The country in the location address.
• MailingCounty: string
  Title: Mailing Address County

  Read Only: true

  Maximum Length: 60

  The county in the location address.
• MailingPostalCode: string
  Title: Mailing Address Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the location address.
• MailingProvince: string
  Title: Mailing Address Province

  Read Only: true

  Maximum Length: 60

  The province in the location address.
• MailingState: string
  Title: Mailing Address State

  Read Only: true

  Maximum Length: 60

  The state in the location address.
• MobileBusFlag: string
  Title: Mobile Business

  Read Only: true

  Maximum Length: 1

  Indicates whether the business is mobile.
• OraAmount: number
  Title: Credential Amount

  Read Only: true

  The amount associated with the credential.
• OraBusinessName: string
  Title: Credential Business Name

  Read Only: true

  Maximum Length: 200

  The associated business name.
• OraCertificateNumber: string
  Title: Credential Certificate Number

  Read Only: true

  Maximum Length: 200

  The certificate or license number associated with the credential.
• OraCurrency: string
  Title: Credential Currency

  Read Only: true

  Maximum Length: 3

  The currency associated with the amount.
• OraDescription: string
  Title: Credential Details

  Read Only: true

  Maximum Length: 250

  The description associated with the credential.
• OraExempt: string
  Title: Credential Exemption

  Read Only: true

  Maximum Length: 1

  Indicates whether the business is exempt from the credential.
• OraExemptReason: string
  Read Only: true

  Maximum Length: 200

  The reason for the credential exemption.
• OraExpirationDate: string (date)
  Title: Credential Expiration Date

  Read Only: true

  The expiration date for the certificate or license number.
• OraQualifierName: string
  Title: Credential Qualifier Name

  Read Only: true

  Maximum Length: 200

  The name of the qualifying individual.
• OraStartDate: string (date)
  Title: Credential Start Date

  Read Only: true

  The start date for the certificate or license number.
• OrganizationName: string
  Title: Applicant Business Name

  Read Only: true

  Maximum Length: 360

  The applicant???s business name (for example, a contractor???s business name).
• Originator: string
  Title: Originator

  Read Only: true

  Maximum Length: 3

  The originator of the business license application.
• ParcelId: integer (int64)
  Title: Location Parcel ID

  Read Only: true

  The identifier of the record parcel.
• PermitStatus: string
  Title: Activity Status

  Read Only: true

  Maximum Length: 100

  The overall status of the application.
• PersonFirstName: string
  Title: Applicant First Name

  Read Only: true

  Maximum Length: 150

  The applicant???s first name.
• PersonLastName: string
  Title: Applicant Last Name

  Read Only: true

  Maximum Length: 150

  The applicant???s last name.
• PersonMiddleName: string
  Title: Applicant Middle Name

  Read Only: true

  Maximum Length: 60

  The applicant???s middle name.
• PersonName: string
  Title: Applicant Full Name

  Read Only: true

  Maximum Length: 450

  The name of the license/business license applicant.
• PersonTitle: string
  Title: Applicant Title

  Read Only: true

  Maximum Length: 60

  The contact???s title.
• ReceivedDate: string (date-time)
  Title: Received Date

  Read Only: true

  The received date for the license application.
• RecordStatus: string
  Read Only: true

  Maximum Length: 15

  The record status.
• RecordType: string
  Title: License Type

  Read Only: true

  Maximum Length: 100

  The user-friendly name of the record type.
• RecordTypeId: string
  Title: Record Type ID

  Read Only: true

  Maximum Length: 30

  The identifier of the record type.
• RenewalDate: string (date-time)
  Title: Renewal Date

  Read Only: true

  The renewal date for the license or permit.
• Subclassification: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 80

  The subclassification of the business license application type.
• SubmitDate: string (date-time)
  Title: Submission Date

  Read Only: true

  The date the license transaction was submitted.
• SubmittedBy: string
  Title: Submitted by User ID

  Read Only: true

  Maximum Length: 64

  The user ID of the person who submitted the business license application.
• SystemStatus: string
  Title: Activity System Status

  Read Only: true

  Maximum Length: 15

  The system status of the business license application.
• TotalFees: number
  Title: Fees Total Amount

  Read Only: true

  The total amount of all fees for this application.
• TotalHold: number
  Title: Fees on Hold

  Read Only: true

  The total amount of fees on hold for this application.
• TotalOutstanding: number
  Title: Fees Outstanding Balance

  Read Only: true

  The total amount of fees outstanding for this application.
• TotalPaid: number
  Title: Fees Total Paid

  Read Only: true

  The total amount paid for this application.
• TotalPayable: number
  Title: Fees Total Payable

  Read Only: true

  The total amount of fees payable for this application.
• TotalPending: number
  Title: Fees in Pending Status

  Read Only: true

  The total amount of fees pending for this application.
• TotalWaived: number
  Title: Fees Waived

  Read Only: true

  The total amount of fees waived for this application.
• VersionType: string
  Title: Version Type

  Read Only: true

  Maximum Length: 1

  The version of the business license application.

{
    "type":"object",
    "properties":{
        "AboutToExpireDate":{
            "title":"About to Expire Date",
            "type":"string",
            "description":"The date an expiring license/permit notification is sent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcceptanceDate":{
            "title":"Acceptance Date",
            "type":"string",
            "description":"The accepted date for the business license application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityDescription":{
            "title":"Activity Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressId":{
            "title":"Location Address ID",
            "type":"integer",
            "description":"The reference key to the TCA location table.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for a public-sector agency (typically an alphanumeric ID for a city, county, or state, but it may also be the agency name).",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AmendmentType":{
            "title":"Amendment Type",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates whether an inactive application should be reactivated from the amendment intake form.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplAteDate":{
            "title":"Application About to Expire Date",
            "type":"string",
            "description":"The date an about-to-expire notification is sent for the permit application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplExpirationDate":{
            "title":"Application Expiration Date",
            "type":"string",
            "description":"The date the application expires.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicant":{
            "type":"integer",
            "description":"The party ID of the permit applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantAddressOne":{
            "title":"Applicant Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"Address line 1 for the business license applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantAddressTwo":{
            "title":"Applicant Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"Address line 2 for the business license applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantBizProfileId":{
            "type":"integer",
            "description":"The business profile used by the applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantCity":{
            "title":"Applicant City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the applicant???s address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantCountry":{
            "title":"Applicant Country",
            "maxLength":3,
            "type":"string",
            "description":"The country in the applicant???s address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantCounty":{
            "title":"Applicant County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the applicant???s address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantEmailAddressOne":{
            "title":"Applicant Email 1",
            "maxLength":320,
            "type":"string",
            "description":"The applicant???s primary email address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ApplicantEmailAddressTwo":{
            "title":"Applicant Email 2",
            "maxLength":320,
            "type":"string",
            "description":"The applicant???s secondary email address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ApplicantPhoneAreaCode":{
            "title":"Applicant Phone Area Code",
            "maxLength":10,
            "type":"string",
            "description":"The area code for the applicant???s phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The country code for the applicant???s phone number.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantPhoneExtension":{
            "title":"Applicant Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"The applicant???s phone extension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneNumber":{
            "title":"Applicant Phone Number",
            "maxLength":61,
            "type":"string",
            "description":"The applicant???s phone number.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ApplicantPostalCode":{
            "title":"Applicant Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the applicant???s address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantProfileId":{
            "type":"integer",
            "description":"The applicant???s user profile.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantProvince":{
            "title":"Applicant Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the applicant???s address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantState":{
            "title":"Applicant State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the applicant???s address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplyToInProcessTrans":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the value also applies to in-progress transactions.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AssignedSpecialistName":{
            "title":"Assigned Specialist Name",
            "maxLength":240,
            "type":"string",
            "description":"The user name of the specialist assigned to the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedSpecialistUserid":{
            "title":"Assigned Specialist User ID",
            "maxLength":64,
            "type":"string",
            "description":"The user ID of the specialist assigned to the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "AttributeCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The category of the business license type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BalanceDue":{
            "title":"Fees Balance Due",
            "type":"number",
            "description":"The fee balance due for this application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "BusAddressOne":{
            "title":"Business Address 1",
            "maxLength":240,
            "type":"string",
            "description":"Address line 1 for the business address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusAddressTwo":{
            "title":"Business Address 2",
            "maxLength":240,
            "type":"string",
            "description":"Address line 2 for the business address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusBusinessLegalName":{
            "title":"Business Legal Name",
            "maxLength":240,
            "type":"string",
            "description":"The legal name of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusBusinessName":{
            "title":"Business",
            "maxLength":100,
            "type":"string",
            "description":"The name of the applicant???s business (for example, a contractor???s business name).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusCity":{
            "title":"Business City",
            "maxLength":60,
            "type":"string",
            "description":"The city for the business address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusCountry":{
            "title":"Business Country",
            "maxLength":3,
            "type":"string",
            "description":"The country for the business address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusCounty":{
            "title":"Business County",
            "maxLength":60,
            "type":"string",
            "description":"The county for the business address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusDbaBusinessName":{
            "maxLength":100,
            "type":"string",
            "description":"The ???doing business as??? (DBA) name for the business.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusDescription":{
            "title":"Location Business Description",
            "maxLength":200,
            "type":"string",
            "description":"A field in the Business Information component of the form designer used to enter a description of the business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusOwnershipType":{
            "title":"Business Ownership Type",
            "maxLength":15,
            "type":"string",
            "description":"A field in the Business Information component of the form designer that describes the type of business ownership.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusPostalCode":{
            "title":"Business Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the business address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusProvince":{
            "title":"Business Province",
            "maxLength":60,
            "type":"string",
            "description":"The province for the business address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusStartDate":{
            "title":"Proposed Effective Date",
            "type":"string",
            "description":"The field used to enter the business establishment date in the Business Information component of the form designer.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusState":{
            "title":"Business State",
            "maxLength":60,
            "type":"string",
            "description":"The state for the business address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":80,
            "type":"string",
            "description":"The record classification (permit, business license, professional license, or planning and zoning).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionName":{
            "title":"Business License Condition",
            "maxLength":50,
            "type":"string",
            "description":"The condition associated with a business license application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created by User ID",
            "maxLength":64,
            "type":"string",
            "description":"The user ID of the person who created the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the business license application was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CredentialCode":{
            "title":"Credential Code",
            "maxLength":30,
            "type":"string",
            "description":"The credential type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CredentialName":{
            "title":"Credential Name",
            "maxLength":100,
            "type":"string",
            "description":"The credential name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":3,
            "type":"string",
            "description":"The currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelinquentDate":{
            "type":"string",
            "description":"The date the license becomes delinquent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "EffChangeDate":{
            "title":"Approved Effective Date",
            "type":"string",
            "description":"The effective change date of a business license record.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExemptReasonMeaning":{
            "title":"Credential Exemption Reason",
            "maxLength":80,
            "type":"string",
            "description":"The meaning/description of the credential exemption reason.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date the license or permit is no longer valid.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationGraceDate":{
            "title":"Grace Period Date",
            "type":"string",
            "description":"The expiration grace date for the business license application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationStatus":{
            "title":"Expiration Status",
            "maxLength":15,
            "type":"string",
            "description":"The expiration status of the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeDueUpdateDate":{
            "title":"Fees Due Updated Date",
            "type":"string",
            "description":"The identifier that captures the date when a due-status fee item is added or updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the value is inherited.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The date the license or permit was issued (used in the Application Information component of the Permit Designer).",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The last-updated date of the business license application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user ID of the person who last updated the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "LicensePeriod":{
            "title":"License Period",
            "maxLength":100,
            "type":"string",
            "description":"The period for which the business license is valid.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseStatus":{
            "title":"License Status",
            "maxLength":30,
            "type":"string",
            "description":"The overall status of the business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseSystemStatus":{
            "title":"License System Status",
            "maxLength":80,
            "type":"string",
            "description":"The system status of the business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpCredentialKey":{
            "type":"integer",
            "description":"The identifier of the business license credential record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"License ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The identifier of the business license record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LocAltPhoneExtn":{
            "title":"Location Alternate Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"The extension used after connecting to an internal phone system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocAltPhoneNumber":{
            "title":"Location Alternate Phone Number",
            "maxLength":61,
            "type":"string",
            "description":"The full phone number for the location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "LocAltPhoneType":{
            "title":"Location Alternate Phone Type",
            "maxLength":30,
            "type":"string",
            "description":"The phone type for the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocEmailAddress":{
            "title":"Location Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address for the business location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "LocPrimaryPhoneExtn":{
            "title":"Location Primary Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"The extension used after connecting to an internal phone system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocPrimaryPhoneNumber":{
            "title":"Location Primary Phone",
            "maxLength":61,
            "type":"string",
            "description":"The location phone number.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "LocPrimaryPhoneType":{
            "title":"Location Primary Phone Type",
            "maxLength":30,
            "type":"string",
            "description":"The phone type for the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationAddressOne":{
            "title":"Location Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"Parcel address line 1.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationAddressTwo":{
            "title":"Location Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"Parcel address line 2.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationCity":{
            "title":"Location City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationCountry":{
            "title":"Location Country",
            "maxLength":3,
            "type":"string",
            "description":"The country in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationCounty":{
            "title":"Location County",
            "maxLength":60,
            "type":"string",
            "description":"The county where the parcel address is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationPostalCode":{
            "title":"Location Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationProvince":{
            "title":"Location Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationState":{
            "title":"Location State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingAddress1":{
            "title":"Mailing Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"Location address line 1.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingAddress2":{
            "title":"Mailing Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"Location address line 2.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingCity":{
            "title":"Mailing Address City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingCountry":{
            "title":"Mailing Address Country",
            "maxLength":3,
            "type":"string",
            "description":"The country in the location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingCounty":{
            "title":"Mailing Address County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingPostalCode":{
            "title":"Mailing Address Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingProvince":{
            "title":"Mailing Address Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingState":{
            "title":"Mailing Address State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MobileBusFlag":{
            "title":"Mobile Business",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the business is mobile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OraAmount":{
            "title":"Credential Amount",
            "type":"number",
            "description":"The amount associated with the credential.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OraBusinessName":{
            "title":"Credential Business Name",
            "maxLength":200,
            "type":"string",
            "description":"The associated business name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OraCertificateNumber":{
            "title":"Credential Certificate Number",
            "maxLength":200,
            "type":"string",
            "description":"The certificate or license number associated with the credential.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OraCurrency":{
            "title":"Credential Currency",
            "maxLength":3,
            "type":"string",
            "description":"The currency associated with the amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OraDescription":{
            "title":"Credential Details",
            "maxLength":250,
            "type":"string",
            "description":"The description associated with the credential.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OraExempt":{
            "title":"Credential Exemption",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the business is exempt from the credential.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OraExemptReason":{
            "maxLength":200,
            "type":"string",
            "description":"The reason for the credential exemption.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "OraExpirationDate":{
            "title":"Credential Expiration Date",
            "type":"string",
            "description":"The expiration date for the certificate or license number.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OraQualifierName":{
            "title":"Credential Qualifier Name",
            "maxLength":200,
            "type":"string",
            "description":"The name of the qualifying individual.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OraStartDate":{
            "title":"Credential Start Date",
            "type":"string",
            "description":"The start date for the certificate or license number.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Applicant Business Name",
            "maxLength":360,
            "type":"string",
            "description":"The applicant???s business name (for example, a contractor???s business name).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Originator":{
            "title":"Originator",
            "maxLength":3,
            "type":"string",
            "description":"The originator of the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Location Parcel ID",
            "type":"integer",
            "description":"The identifier of the record parcel.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PermitStatus":{
            "title":"Activity Status",
            "maxLength":100,
            "type":"string",
            "description":"The overall status of the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"Applicant First Name",
            "maxLength":150,
            "type":"string",
            "description":"The applicant???s first name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Applicant Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The applicant???s last name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Applicant Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The applicant???s middle name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonName":{
            "title":"Applicant Full Name",
            "maxLength":450,
            "type":"string",
            "description":"The name of the license/business license applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Applicant Title",
            "maxLength":60,
            "type":"string",
            "description":"The contact???s title.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivedDate":{
            "title":"Received Date",
            "type":"string",
            "description":"The received date for the license application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The record status.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "RecordType":{
            "title":"License Type",
            "maxLength":100,
            "type":"string",
            "description":"The user-friendly name of the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "title":"Record Type ID",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RenewalDate":{
            "title":"Renewal Date",
            "type":"string",
            "description":"The renewal date for the license or permit.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":80,
            "type":"string",
            "description":"The subclassification of the business license application type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submission Date",
            "type":"string",
            "description":"The date the license transaction was submitted.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedBy":{
            "title":"Submitted by User ID",
            "maxLength":64,
            "type":"string",
            "description":"The user ID of the person who submitted the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "SystemStatus":{
            "title":"Activity System Status",
            "maxLength":15,
            "type":"string",
            "description":"The system status of the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalFees":{
            "title":"Fees Total Amount",
            "type":"number",
            "description":"The total amount of all fees for this application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "TotalHold":{
            "title":"Fees on Hold",
            "type":"number",
            "description":"The total amount of fees on hold for this application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "TotalOutstanding":{
            "title":"Fees Outstanding Balance",
            "type":"number",
            "description":"The total amount of fees outstanding for this application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "TotalPaid":{
            "title":"Fees Total Paid",
            "type":"number",
            "description":"The total amount paid for this application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "TotalPayable":{
            "title":"Fees Total Payable",
            "type":"number",
            "description":"The total amount of fees payable for this application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "TotalPending":{
            "title":"Fees in Pending Status",
            "type":"number",
            "description":"The total amount of fees pending for this application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "TotalWaived":{
            "title":"Fees Waived",
            "type":"number",
            "description":"The total amount of fees waived for this application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "VersionType":{
            "title":"Version Type",
            "maxLength":1,
            "type":"string",
            "description":"The version of the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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