Finalize Record

Creates the finalized record in the database. Use this method after calling Create Partial Record to submit the completed record. See Creating Records for more information about calling Finalize Record in tandem with Create Partial Record.

The Create Partial Record API triggers the business rules engine event ApplicationSubmitAfter.

Note: The Finalize Record API does not include custom forms and custom tables in the request body. To add or update custom forms and custom tables, use the Update Record Custom Forms and Update Record Custom Tables between the Create Partial Record and Finalize Record requests.

Resource Information

Scoperecords

Deprecated scope name:   finalize_record
App Type All
Authorization Type Access token
URI /v4/records/{recordId}/finalize?lang={lang}
HTTP Method POST
Automation Version(s) 7.3.2

Request Information

Field or Parameter Type Required Values Description Automation Version
fields string No   Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored. 7.3.2
lang String No   Indicates the language applied. 7.3.2
actualProductionUnit double No   Actual cost per production unit. 7.3.2
appearanceDate dateTime No   The date for a hearing appearance. 7.3.2
appearanceDayOfWeek string No   The day for a hearing appearance. 7.3.2
assignedDate dateTime No   The date of the assigned action. 7.3.2
assignedToDepartment string No Get All Departments The department responsible for the action. 7.3.2
assignedUser string No   The staff member responsible for the action. 7.3.2
booking Boolean No true | false Indicates whether or not there was a booking in addition to a citation. 7.3.2
closedByDepartment string No Get All Departments The department responsible for closure. 7.3.2
closedByUser string No   The staff member responsible for closure. 7.3.2
closedDate dateTime No   The closure date. 7.3.2
completedByDepartment string No Get All Departments The department responsible for completion. 7.3.2
completedByUser string No   The staff member responsible for completion. 7.3.2
completedDate dateTime No   The date of completion. 7.3.2
constructionType constructionType{} No Get All Record Construction Types The US Census Bureau construction type code. 7.3.2
constructionType.text string No   The localized display text. 7.3.2
constructionType.value string No   The value for the specified parameter. 7.3.2
costPerUnit double No   The cost for one unit. 7.3.2
createdBy string No   The unique user id of the individual that created the entry. 7.3.2
customId string No   An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application. 7.3.2
defendantSignature Boolean No true | false Indicates whether or not a defendant's signature has been obtained. 7.3.2
description string No   The description of the record or item. 7.3.2
enforceDepartment string No Get All Departments The name of the department responsible for enforcement. 7.3.2
enforceUser string No   Name of the enforcement officer. 7.3.2
enforceUserId string No   ID number of the enforcement officer. 7.3.2
estimatedCostPerUnit double No   The estimated cost per unit. 7.3.2
estimatedDueDate dateTime No   The estimated date of completion. 7.3.2
estimatedProductionUnit double No   The estimated number of production units. 7.3.2
estimatedTotalJobCost double No   The estimated cost of the job. 7.3.2
firstIssuedDate dateTime No   The first issued date for license. 7.3.2
housingUnits long No   The number of housing units. 7.3.2
id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
infraction Boolean No true | false Indicates whether or not an infraction occurred. 7.3.2
inPossessionTime double No   The application level in possession time of the time tracking feature. 7.3.2
inspectorDepartment string No Get All Departments The name of the department where the inspector works. 7.3.2
inspectorId string No Get All Inspectors The ID number of the inspector. 7.3.2
inspectorName string No Get All Inspectors The name of the inspector. 7.3.2
jobValue double No   The value of the job. 7.3.2
misdemeanor Boolean No true | false Indicates whether or not a misdemeanor occurred. 7.3.2
module string No Get All Modules Use to filter by the module. 7.3.2
name string No   The full name for the application contact. 7.3.2
numberOfBuildings long No   The number of buildings. 7.3.2
offenseWitnessed Boolean No true | false Indicates whether or not there was a witness to the alleged offense. 7.3.2
priority priority{} No Get All Priorities The priority level assigned to the record. 7.3.2
priority.text string No   The localized display text. 7.3.2
priority.value string No   The value for the specified parameter. 7.3.2
publicOwned Boolean No true | false Indicates whether or not the public owns the item. 7.3.2
recordClass string No   General information about the record. 7.3.2
renewalInfo renewalInfo{} No   Defines the parameters related to renewal of a record. 7.3.2
renewalInfo.expirationDate dateTime No   The date when the condition expires. 7.3.2
renewalInfo.expirationStatus renewalInfo.expirationStatus{} No Get All Record Expiration Statuses Indicates whether the expiration is enabled or disabled. 7.3.2
renewalInfo.expirationStatus.text string No   The localized display text. 7.3.2
renewalInfo.expirationStatus.value string No   The value for the specified parameter. 7.3.2
reportedChannel reportedChannel{} No   The incoming channel through which the applicant submitted the application. 7.3.2
reportedChannel.text string No   The localized display text. 7.3.2
reportedChannel.value string No   The value for the specified parameter. 7.3.2
reportedType reportedType{} No   The type of complaint or incident being reported. 7.3.2
reportedType.text string No   The localized display text. 7.3.2
reportedType.value string No   The value for the specified parameter. 7.3.2
scheduledDate dateTime No   The date when the inspection gets scheduled. 7.3.2
severity severity{} No   Indicates the severity of the condition. 7.3.2
severity.text string No   The localized display text. 7.3.2
severity.value string No   The value for the specified parameter. 7.3.2
shortNotes string No   A brief note about the record subject. 7.3.2
status status{} No   The record status. 7.3.2
status.text string No   The localized display text. 7.3.2
status.value string No   The value for the specified parameter. 7.3.2
statusReason statusReason{} No   The reason for the status setting on the record. 7.3.2
statusReason.text string No   The localized display text. 7.3.2
statusReason.value string No   The value for the specified parameter. 7.3.2
totalJobCost double No   The combination of work order assignments (labor) and costs. 7.3.2
type type{} No   The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
type.alias string No   The record type alias. 7.3.2
type.category string No   The 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
type.filterName string No   The name of the record type filter which defines the record types to be displayed for the citizen user. 7.3.2
type.group string No   The 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
type.id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
type.module string No Get All Modules Use to filter by the module. 7.3.2
type.subType string No   The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
type.text string No   The localized display text. 7.3.2
type.type string No   The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
type.value string No   The value for the specified parameter. 7.3.2
undistributedCost double No   The undistributed costs for this work order. 7.3.2
recordId string Yes Get All Records Search Records Get My Records The unique ID associated with a record. 7.3.2

Response Information

Field Type Description Automation Version
result result{}   7.3.2
result.actualProductionUnit double Estimated cost per production unit. 7.3.2
result.appearanceDate dateTime The date for a hearing appearance. 7.3.2
result.appearanceDayOfWeek string The day for a hearing appearance. 7.3.2
result.assignedDate dateTime The date of the assigned action. 7.3.2
result.assignedToDepartment string The department responsible for the action. 7.3.2
result.assignedUser string The staff member responsible for the action. 7.3.2
result.balance Double The balance of the account. 7.3.2
result.booking Boolean Indicates whether or not there was a booking in addition to a citation. 7.3.2
result.closedByDepartment string The department responsible for closure. 7.3.2
result.closedByUser string The staff member responsible for closure. 7.3.2
result.closedDate dateTime The closure date. 7.3.2
result.completedByDepartment string The department responsible for completion. 7.3.2
result.completedByUser string The staff member responsible for completion. 7.3.2
result.completedDate dateTime The date of completion. 7.3.2
result.constructionType result.constructionType{} The US Census Bureau construction type code. 7.3.2
result.constructionType.text string The localized display text. 7.3.2
result.constructionType.value string The value for the specified parameter. 7.3.2
result.costPerUnit double The cost for one unit. 7.3.2
result.createdBy string The unique user id of the individual that created the entry. 7.3.2
result.createdByCloning string Indictes whether or not the record was cloned. 7.3.2
result.customId string An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application. 7.3.2
result.defendantSignature Boolean Indicates whether or not a defendant's signature has been obtained. 7.3.2
result.description string The description of the record or item. 7.3.2
result.enforceDepartment string The name of the department responsible for enforcement. 7.3.2
result.enforceUser string Name of the enforcement officer. 7.3.2
result.enforceUserId string ID number of the enforcement officer. 7.3.2
result.estimatedCostPerUnit double The estimated cost per unit. 7.3.2
result.estimatedDueDate dateTime The estimated date of completion. 7.3.2
result.estimatedProductionUnit double The estimated number of production units. 7.3.2
result.estimatedTotalJobCost double The estimated cost of the job. 7.3.2
result.firstIssuedDate dateTime The first issued date for license. 7.3.2
result.housingUnits long The number of housing units. 7.3.2
result.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.infraction Boolean This defines whether or not an infraction occurred. 7.3.2
result.initiatedProduct string The Accela Automation product area where the application is submitted: "AA" : Classic Accela Automation. "ACA" : Accela Citizen Access. "AIVR" : Accela Integrated Voice Response. "AMO" : Accela Mobile Office. "AV360" : Accela Asset Management, Accela Land Man. 7.3.2
result.inPossessionTime double The application level in possession time of the time tracking feature. 7.3.2
result.inspectorDepartment string The name of the department where the inspector works. 7.3.2
result.inspectorId string The ID number of the inspector. 7.3.2
result.inspectorName string The name of the inspector. 7.3.2
result.jobValue double The value of the job. 7.3.2
result.misdemeanor Boolean Indicates whether or not a misdemeanor occurred. 7.3.2
result.module string Use to filter by the module. 7.3.2
result.name string The full name for the application contact. 7.3.2
result.numberOfBuildings long The number of buildings. 7.3.2
result.offenseWitnessed Boolean Indicates whether or not there was a witness to the alleged offense. 7.3.2
result.openedDate dateTime The date when the system created the record. 7.3.2
result.overallApplicationTime double The amount of elapsed time from the time tracking start date to the completion of the application. 7.3.2
result.priority result.priority{} The priority level assigned to the record. 7.3.2
result.priority.text string The localized display text. 7.3.2
result.priority.value string The value for the specified parameter. 7.3.2
result.publicOwned Boolean A flag that indicates whether or not the public owns the item. 7.3.2
result.recordClass string General information about the record. 7.3.2
result.renewalInfo result.renewalInfo{} Defines the parameters related to renewal of a record. 7.3.2
result.renewalInfo.expirationDate dateTime The date when the condition expires. 7.3.2
result.renewalInfo.expirationStatus result.renewalInfo.expirationStatus{} Indicates whether the expiration is enabled or disabled. 7.3.2
result.renewalInfo.expirationStatus.text string The localized display text. 7.3.2
result.renewalInfo.expirationStatus.value string The value for the specified parameter. 7.3.2
result.reportedChannel result.reportedChannel{} The incoming channel through which the applicant submitted the application. 7.3.2
result.reportedChannel.text string The localized display text. 7.3.2
result.reportedChannel.value string The value for the specified parameter. 7.3.2
result.reportedDate dateTime The date when a complaint or incident is reported. 7.3.2
result.reportedType result.reportedType{} The type of complaint or incident being reported. 7.3.2
result.reportedType.text string The localized display text. 7.3.2
result.reportedType.value string The value for the specified parameter. 7.3.2
result.scheduledDate dateTime The date when the inspection gets scheduled. 7.3.2
result.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
result.severity result.severity{} Indicates the severity of the condition. 7.3.2
result.severity.text string The localized display text. 7.3.2
result.severity.value string The value for the specified parameter. 7.3.2
result.shortNotes string A brief note about the record subject. 7.3.2
result.status result.status{} The record status. 7.3.2
result.status.text string The localized display text. 7.3.2
result.status.value string The value for the specified parameter. 7.3.2
result.statusDate dateTime The date when the current status changed. 7.3.2
result.statusReason result.statusReason{} The reason for the status setting on the record. 7.3.2
result.statusReason.text string The localized display text. 7.3.2
result.statusReason.value string The value for the specified parameter. 7.3.2
result.totalFee Double The total amount of the fees invoiced to the record. 7.3.2
result.totalJobCost double The combination of work order assignments (labor) and costs. 7.3.2
result.totalPay Double The total amount of pay. 7.3.2
result.trackingId long The application tracking number (IVR tracking number). 7.3.2
result.type result.type{} The record type. If this type field is within the record type definition, it specifies the 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.alias string The record type alias. 7.3.2
result.type.category string The 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.filterName string The name of the record type filter which defines the record types to be displayed for the citizen user. 7.3.2
result.type.group string The 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.type.module string Use to filter by the module. 7.3.2
result.type.subType string The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.text string The localized display text. 7.3.2
result.type.type string The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.value string The value for the specified parameter. 7.3.2
result.undistributedCost double The undistributed costs for this work order. 7.3.2
result.value string The value for the specified parameter. 7.3.2
status integer The record status. 7.3.3