Jump to

• Request
• Response

Create a set of application payment details records

post

/fscmRestApi/resources/11.13.18.05/publicSectorPaymentsByTransactions

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : publicSectorPaymentsByTransactions-item-response

Type: object

Show Source

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

  Read Only: true

  The date when the notification about an expiring license or permit is sent.
• Address1: string
  Title: Applicant Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line of the applicant address.
• Address2: string
  Title: Applicant Address Line 2

  Read Only: true

  Maximum Length: 240

  The second line of the applicant address.
• AgencyId: integer (int32)
  Title: Agency ID

  Read Only: true

  The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
• AppAcceptDate: string (date-time)
  Title: Acceptance Date

  Read Only: true

  Identifies the accepted date for the application.
• Applicant: integer (int64)
  Read Only: true

  The party ID of the applicant.
• ApplicantPhoneNumber: string
  Title: Applicant Phone Number

  Read Only: true

  Maximum Length: 40

  The phone number of the applicant.
• ApplicantUserId: string
  Title: Applicant User ID

  Read Only: true

  Maximum Length: 255

  The user ID of the applicant.
• AssignedSpecialistEmail: string
  Title: Assigned Specialist Email

  Read Only: true

  Maximum Length: 255

  The email address of the specialist who is assigned to the application.
• AssignedSpecialistName: string
  Title: Assigned Specialist Name

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 30

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

  Read Only: true

  The balance amount due for the application.
• BusAddress1: string
  Title: Business Address 1

  Read Only: true

  Maximum Length: 240

  The address portion of the business??? address, indicated first line of address.
• BusAddress2: string
  Title: Business Address 2

  Read Only: true

  Maximum Length: 240

  The address portion of the business??? address, indicated first line of 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 enters his or her contracting business name.
• BusCity: string
  Title: Business City

  Read Only: true

  Maximum Length: 60

  The city portion of the business??? address.
• BusCountry: string
  Title: Business Country

  Read Only: true

  Maximum Length: 3

  The country portion of the business??? address.
• BusCounty: string
  Title: Business County

  Read Only: true

  Maximum Length: 60

  The county portion of the business??? address.
• BusDbaBusinessName: string
  Title: Doing Business As

  Read Only: true

  Maximum Length: 100

  The doing business as 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.
• BusinessEntityId: string
  Read Only: true

  Maximum Length: 50

  Meaningful identifier for the business entity.
• BusinessEntityKey: integer (int64)
  Read Only: true

  The unique identifier for the business entity.
• BusinessLocationId: string
  Read Only: true

  Maximum Length: 50

  Meaningful identifier for the business location.
• BusinessLocationKey: integer (int64)
  Read Only: true

  The unique identifier for the business location.
• BusPostalCode: string
  Title: Business Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code portion of the business??? address.
• BusProvince: string
  Title: Business Province

  Read Only: true

  Maximum Length: 60

  The province portion of the business??? address.
• BusState: string
  Title: Business State

  Read Only: true

  Maximum Length: 60

  The state portion of the business??? address.
• BusStatus: string
  Title: License Status

  Read Only: true

  Maximum Length: 10

  The current status of the business entity.
• City: string
  Title: Applicant City

  Read Only: true

  Maximum Length: 60

  The city in the applicant address.
• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 3

  The application record classification. The classifications can be permit, business license, professional license, or planning and zoning.
• ClassificationName: string
  Read Only: true

  Maximum Length: 50

  The meaning of the application record classification.
• Country: string
  Title: Applicant Country

  Read Only: true

  Maximum Length: 3

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

  Read Only: true

  Maximum Length: 60

  The county in the applicant address.
• CreatedBy: string
  Title: Created by User ID

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Identifies the date on which the application was created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description for the application.
• EmailAddress1: string
  Title: Applicant Email 1

  Read Only: true

  Maximum Length: 320

  The first email address of the applicant.
• EmailAddress2: string
  Title: Applicant Email 2

  Read Only: true

  Maximum Length: 320

  The second email address of the applicant.
• 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

  Identifies the expiration grace date for the application.
• ExpirationStatus: string
  Title: Expiration Status

  Read Only: true

  Maximum Length: 15

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

  Read Only: true

  The identifier that captures the date when the fee item with due status is added or updated.
• IssueDate: string (date-time)
  Title: Issue Date

  Read Only: true

  The date the application was issued. Used in the application information component of the Permit Designer.
• LicensePeriod: string
  Title: License Period

  Read Only: true

  Maximum Length: 100

  The duration in which the business license is valid.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Application ID

  Read Only: true

  Maximum Length: 50

  The identifier for the application record.
• LnpRecordKey: integer
  Read Only: true

  The unique identifier for the application record.
• LocationAddressOne: string
  Title: Location Address Line 1

  Read Only: true

  Maximum Length: 240

  Address Line 1 as part of the parcel address.
• LocationAddressTwo: string
  Title: Location Address Line 2

  Read Only: true

  Maximum Length: 240

  Address Line 2 as part of the parcel address.
• LocationCity: string
  Title: Location City

  Read Only: true

  Maximum Length: 60

  The city that is part of the parcel address.
• LocationCountry: string
  Title: Location Country

  Read Only: true

  Maximum Length: 3

  The country that is part of the parcel address.
• LocationCounty: string
  Title: Location County

  Read Only: true

  Maximum Length: 60

  The county in which the parcel address is located.
• LocationPostalcode: string
  Title: Location Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code that is part of the parcel address.
• LocationProvince: string
  Title: Location Province

  Read Only: true

  Maximum Length: 60

  The location information about the province in which the parcel address is located.
• LocationState: string
  Title: Location State

  Read Only: true

  Maximum Length: 60

  The state that is part of the parcel address.
• OrganizationName: string
  Title: Applicant Business Name

  Read Only: true

  Maximum Length: 360

  The business organization name of the applicant.
• Originator: string
  Title: Originator

  Read Only: true

  Maximum Length: 3

  Identifies the originator of the application.
• PaymentDate: string (date-time)
  Title: Payment Date

  Read Only: true

  Indicates the date for the fee payment.
• PaymentMethodCode: string
  Title: Payment Method

  Read Only: true

  Maximum Length: 30

  Indicates the payment method code for the fee payment.
• PaymentReferenceId: string
  Title: Payment Reference

  Read Only: true

  Maximum Length: 50

  The reference ID of the payment details for the application.
• PersonFirstName: string
  Title: Applicant First Name

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 450

  The full name of the applicant.
• PersonTitle: string
  Title: Applicant Title

  Read Only: true

  Maximum Length: 60

  The title of the contact.
• PostalCode: string
  Title: Applicant Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the applicant address.
• PrimaryFlag: string
  Read Only: true

  Maximum Length: 1

  The application's relationship type as primary application.
• PrimaryRecordId: string
  Read Only: true

  Maximum Length: 50

  The record id of the primary application.
• PrimaryRecordKey: integer (int64)
  Read Only: true

  The record key of the primary application.
• Province: string
  Title: Applicant Province

  Read Only: true

  Maximum Length: 60

  The province in the applicant address.
• ReceivedDate: string (date-time)
  Title: Received Date

  Read Only: true

  Identifies the received date for the application.
• RecordTypeCode: string
  Title: Application Type

  Read Only: true

  Maximum Length: 20

  The unique alphanumeric code or short name for the record type.
• RecordTypeId: string
  Read Only: true

  Maximum Length: 30

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 60

  The state in the applicant address.
• Status: string
  Title: Application Status

  Read Only: true

  Maximum Length: 15

  The status of the application.
• StatusCode: string
  Title: Application Status Code

  Read Only: true

  Maximum Length: 15

  The status code of the application.
• SubapplicationFlag: string
  Read Only: true

  Maximum Length: 1

  The application's relationship type as subapplication.
• Subclassification: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 10

  The subclassification code of the application type.
• SubclassificationName: string
  Read Only: true

  Maximum Length: 50

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  Identifies the user ID of the person who submitted the application.
• SystemStatus: string
  Title: Application System Status

  Read Only: true

  Maximum Length: 15

  Identifies the system status of the application.
• SystemStatusCode: string
  Title: Application System Status Code

  Read Only: true

  Maximum Length: 15

  Identifies the system status code of the application.
• TotalDue: number
  Read Only: true

  The total fees due for the application.
• TotalFees: number
  Title: Fees Total Amount

  Read Only: true

  The total fees for the application.
• TotalHold: number
  Title: Fees on Hold

  Read Only: true

  The total amount on hold status for the application.
• TotalOutstanding: number
  Title: Fees Outstanding Balance

  Read Only: true

  Identifies the total outstanding fee amount.
• TotalPaid: number
  Title: Fees Total Paid

  Read Only: true

  The total fees paid for the application.
• TotalPayable: number
  Title: Fees Total Payable

  Read Only: true

  The total payable amount for the application.
• TotalPaymentsInProcess: number
  Read Only: true

  The total payment amount that is under process for the application.
• TotalPending: number
  Title: Fees in Pending Status

  Read Only: true

  The total pending amount for the application.
• TotalWaived: number
  Title: Fees Waived

  Read Only: true

  The total fees waived for the application.
• Url: string
  Title: URL

  Read Only: true

  Maximum Length: 255

  The URL for the application.
• UrlLabel: string
  Title: Link to Business License Activity

  Read Only: true

  Maximum Length: 255

  The URL label for the application.
• VersionType: string
  Title: Version Type

  Read Only: true

  Maximum Length: 1

  The version of the permit. Values are original, amendment, and renewal.
• WfProcessId: number
  Read Only: true

  The unique identifier for a workflow process.

{
    "type":"object",
    "properties":{
        "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
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Identifies the date on which the application was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AboutToExpireDate":{
            "title":"About to Expire Date",
            "type":"string",
            "description":"The date when the notification about an expiring license or permit is sent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalDue":{
            "type":"number",
            "description":"The total fees due for the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantUserId":{
            "title":"Applicant User ID",
            "maxLength":"255",
            "type":"string",
            "description":"The user ID of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AppAcceptDate":{
            "title":"Acceptance Date",
            "type":"string",
            "description":"Identifies the accepted date for the application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submission Date",
            "type":"string",
            "description":"The date the application transaction was submitted.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalHold":{
            "title":"Fees on Hold",
            "type":"number",
            "description":"The total amount on hold status for the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Applicant Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The applicant middle name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AssignedSpecialistUserid":{
            "title":"Assigned Specialist User ID",
            "maxLength":"64",
            "type":"string",
            "description":"The user id of the specialist who is assigned to the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "title":"Payment Reference",
            "maxLength":"50",
            "type":"string",
            "description":"The reference ID of the payment details for the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:CommOrder":"2"
            },
            "x-queryable":true
        },
        "BusinessEntityKey":{
            "type":"integer",
            "description":"The unique identifier for the business entity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Originator":{
            "title":"Originator",
            "maxLength":"3",
            "type":"string",
            "description":"Identifies the originator of the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":"3",
            "type":"string",
            "description":"The application record classification. The classifications can be permit, business license, professional license, or planning and zoning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPaid":{
            "title":"Fees Total Paid",
            "type":"number",
            "description":"The total fees paid for the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UrlLabel":{
            "title":"Link to Business License Activity",
            "maxLength":"255",
            "type":"string",
            "description":"The URL label for the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PrimaryRecordKey":{
            "type":"integer",
            "description":"The record key of the primary application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Application Status",
            "maxLength":"15",
            "type":"string",
            "description":"The status of the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created by User ID",
            "maxLength":"64",
            "type":"string",
            "description":"Identifies the user ID of the person who created the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Applicant Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The applicant last name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PaymentDate":{
            "title":"Payment Date",
            "type":"string",
            "description":"Indicates the date for the fee payment.",
            "format":"date-time",
            "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
        },
        "LocationPostalcode":{
            "title":"Location Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code that is part of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SubmittedBy":{
            "title":"Submitted by User ID",
            "maxLength":"64",
            "type":"string",
            "description":"Identifies the user ID of the person who submitted the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"Applicant First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The applicant first name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "title":"Payment Method",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the payment method code for the fee payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for the application record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:CommOrder":"1"
            },
            "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
        },
        "ExpirationGraceDate":{
            "title":"Grace Period Date",
            "type":"string",
            "description":"Identifies the expiration grace date for the application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeDueUpdateDate":{
            "title":"Fees Due Updated Date",
            "type":"string",
            "description":"The identifier that captures the date when the fee item with due status is added or updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Applicant Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country in the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Applicant":{
            "type":"integer",
            "description":"The party ID of the applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LocationProvince":{
            "title":"Location Province",
            "maxLength":"60",
            "type":"string",
            "description":"The location information about the province in which the parcel address is located.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusinessEntityId":{
            "maxLength":"50",
            "type":"string",
            "description":"Meaningful identifier for the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description for the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"8",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusAddress2":{
            "title":"Business Address 2",
            "maxLength":"240",
            "type":"string",
            "description":"The address portion of the business??? address, indicated first line of address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusAddress1":{
            "title":"Business Address 1",
            "maxLength":"240",
            "type":"string",
            "description":"The address portion of the business??? address, indicated first line of address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AttributeCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The category of the application type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationAddressOne":{
            "title":"Location Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"Address Line 1 as part of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"URL",
            "maxLength":"255",
            "type":"string",
            "description":"The URL for the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "RecordTypeCode":{
            "title":"Application Type",
            "maxLength":"20",
            "type":"string",
            "description":"The unique alphanumeric code or short name for the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The identifier for a record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusState":{
            "title":"Business State",
            "maxLength":"60",
            "type":"string",
            "description":"The state portion of the business??? address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusStatus":{
            "title":"License Status",
            "maxLength":"10",
            "type":"string",
            "description":"The current status of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationState":{
            "title":"Location State",
            "maxLength":"60",
            "type":"string",
            "description":"The state that is part of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusDbaBusinessName":{
            "title":"Doing Business As",
            "maxLength":"100",
            "type":"string",
            "description":"The doing business as name for the business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusCounty":{
            "title":"Business County",
            "maxLength":"60",
            "type":"string",
            "description":"The county portion of the business??? address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The date the application was issued. Used in the application information component of the Permit Designer.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionType":{
            "title":"Version Type",
            "maxLength":"1",
            "type":"string",
            "description":"The version of the permit. Values are original, amendment, and renewal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationStatus":{
            "title":"Expiration Status",
            "maxLength":"15",
            "type":"string",
            "description":"Identifies the expiration status of the application.",
            "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
        },
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":"10",
            "type":"string",
            "description":"The subclassification code of the application type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress1":{
            "title":"Applicant Email 1",
            "maxLength":"320",
            "type":"string",
            "description":"The first email address of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "EmailAddress2":{
            "title":"Applicant Email 2",
            "maxLength":"320",
            "type":"string",
            "description":"The second email address of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Application Status Code",
            "maxLength":"15",
            "type":"string",
            "description":"The status code of the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Applicant Title",
            "maxLength":"60",
            "type":"string",
            "description":"The title of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusBusinessName":{
            "title":"Business",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the applicant's business. For example, a contractor enters his or her contracting business name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WfProcessId":{
            "type":"number",
            "description":"The unique identifier for a workflow process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicensePeriod":{
            "title":"License Period",
            "maxLength":"100",
            "type":"string",
            "description":"The duration in which the business license is valid.",
            "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"
            }
        },
        "BusCity":{
            "title":"Business City",
            "maxLength":"60",
            "type":"string",
            "description":"The city portion of the business??? address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LocationAddressTwo":{
            "title":"Location Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"Address Line 2 as part of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SystemStatusCode":{
            "title":"Application System Status Code",
            "maxLength":"15",
            "type":"string",
            "description":"Identifies the system status code of the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationCity":{
            "title":"Location City",
            "maxLength":"60",
            "type":"string",
            "description":"The city that is part of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "City":{
            "title":"Applicant City",
            "maxLength":"60",
            "type":"string",
            "description":"The city in the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Province":{
            "title":"Applicant Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "TotalOutstanding":{
            "title":"Fees Outstanding Balance",
            "type":"number",
            "description":"Identifies the total outstanding fee amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivedDate":{
            "title":"Received Date",
            "type":"string",
            "description":"Identifies the received date for the application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessLocationId":{
            "maxLength":"50",
            "type":"string",
            "description":"Meaningful identifier for the business location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"Applicant State",
            "maxLength":"60",
            "type":"string",
            "description":"The state in the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusCountry":{
            "title":"Business Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country portion of the business??? address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ClassificationName":{
            "maxLength":"50",
            "type":"string",
            "description":"The meaning of the application record classification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusPostalCode":{
            "title":"Business Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code portion of the business??? address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SubclassificationName":{
            "maxLength":"50",
            "type":"string",
            "description":"The subclassification meaning of the application type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Applicant Business Name",
            "maxLength":"360",
            "type":"string",
            "description":"The business organization name of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"The application's relationship type as primary application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationCountry":{
            "title":"Location Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country that is part of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "TotalPaymentsInProcess":{
            "type":"number",
            "description":"The total payment amount that is under process for the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Applicant Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code in the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "TotalPayable":{
            "title":"Fees Total Payable",
            "type":"number",
            "description":"The total  payable amount for the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalWaived":{
            "title":"Fees Waived",
            "type":"number",
            "description":"The total fees waived for the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "title":"Applicant County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SubapplicationFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"The application's relationship type as subapplication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedSpecialistName":{
            "title":"Assigned Specialist Name",
            "maxLength":"240",
            "type":"string",
            "description":"The user name of the specialist who is assigned to the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AssignedSpecialistEmail":{
            "title":"Assigned Specialist Email",
            "maxLength":"255",
            "type":"string",
            "description":"The email address of the specialist who is assigned to the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SystemStatus":{
            "title":"Application System Status",
            "maxLength":"15",
            "type":"string",
            "description":"Identifies the system status of the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Application ID",
            "maxLength":"50",
            "type":"string",
            "description":"The identifier for the application record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonName":{
            "title":"Applicant Full Name",
            "maxLength":"450",
            "type":"string",
            "description":"The full name of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "TotalPending":{
            "title":"Fees in Pending Status",
            "type":"number",
            "description":"The total pending amount for the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneNumber":{
            "title":"Applicant Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The phone number of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Applicant Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusinessLocationKey":{
            "type":"integer",
            "description":"The unique identifier for the business location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address1":{
            "title":"Applicant Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LocationCounty":{
            "title":"Location County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in which the parcel address is located.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PrimaryRecordId":{
            "maxLength":"50",
            "type":"string",
            "description":"The record id of the primary application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalFees":{
            "title":"Fees Total Amount",
            "type":"number",
            "description":"The total fees for the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusProvince":{
            "title":"Business Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province portion of the business??? address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BalanceDue":{
            "title":"Fees Balance Due",
            "type":"number",
            "description":"The balance amount due for the application.",
            "nullable":true,
            "readOnly":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