File Statuses and Status Details Definitions
Definitions for all possible file statuses and status details; a mapping of legacy status and status details with the corresponding current ones.
We will give you as much information as possible throughout the file processing journey through statuses and status details. For example, in addition to telling you that a file is in REJECTED status we will tell you all rejection reasons applicable via the fileDetails field.
Possible status transitions
Possible status transitions diagram
Status and status detail definitions
| File.fileStatus | File.fileDetails | Definition |
|---|---|---|
QUEUED | READY_FOR_PROCESSING | Arcadia has started processing the bill. |
REJECTED | PROVIDER_UNIDENTIFIABLE | Arcadia is not able to obtain the provider name from the bill. |
SERVICE_TYPE_NOT_SUPPORTED | Arcadia does not currently support the service type of the bill. | |
LANGUAGE_NOT_SUPPORTED | Arcadia does not currently support the language of the bill. | |
REQUIRED_DATA_FIELDS_MISSING | Arcadia is not able to obtain one or more required fields from the bill. | |
BILL_INSUFFICIENTLY_LEGIBLE | Arcadia is not able to read the bill. This could be due to the structure of the bill, image quality, or the uploaded bill containing multiple statements (or invoices). | |
TIMED_OUT | Arcadia was not able to process the bill within 2 weeks, therefore the bill is timed out. | |
IN_PROGRESS | IDENTIFYING_PROVIDER | Arcadia was not able to automatically detect the provider. Our staff will try to identify the provider name from the bill. |
BILL_ANOMALY_FLAGGED | Arcadia has identified some anomalies on the bill and has started reviewing the bill to ensure accurate data extraction. | |
DATA_EXTRACTION_FAILURE_INVESTIGATION_STARTED | The bill has failed automated data extraction. The bill will be reviewed for further processing. | |
DATA_AUDIT_FAILURE_INVESTIGATION_STARTED | The bill has failed automated data quality audits. The bill will be reviewed for further processing. | |
COVERAGE_REQUEST | REQUEST_CREATED | Arcadia will develop an automated way to extract data from the bill. |
IN_PROGRESS | Arcadia has started the development process for automating data extraction for the bill. | |
SUCCESS | DATA_EXTRACTION_SUCCESSFUL | Arcadia was able to extract data from the bill submitted |
Webhooks behavior
For every status and status detail transition, we will send a webhook with the event type STATUS_CHANGE and subject type FILE as before. More details on webhook behaviors here.
Notice
The following section is only relevant to Utility Cloud customers who have been using the files processing capabilities before December 13, 2023.
New and legacy status and status detail mapping
From December 13, 2023, onwards, all files will have the updated status and status details, regardless of when they were uploaded.
If you have been using the files processing capabilities before December 13, 2023, you can use these mappings to understand how legacy statuses and status details map to the current statuses and status details.
New and legacy status mapping
| Legacy status name | New status name |
|---|---|
PENDING | QUEUED |
PENDING | IN_PROGRESS |
PENDING | COVERAGE_REQUEST |
FAILURE | REJECTED |
SUCCESS | SUCCESS |
New and legacy status detail mapping
How status mapping works
This is a best-effort rough mapping of status details between the legacy and the new ones. As the new statuses are more specific than the legacy statuses, legacy statuses details could apply to more than one new status detail. The table below shows the default mapping we are using.
File.fileDetails is now an array
The legacy
fileDetailswere typestring. The updatedfileDetailsare typearray, an array of strings. This means more than one status detail can be returned for a given status. Please see our API reference for more details.
| Legacy status detail name | New status detail name |
|---|---|
NewIn Progress | READY_FOR_PROCESSING |
Unsupported Bill FormatInput File Corrupted | PROVIDER_UNIDENTIFIABLE |
Unsupported Provider | SERVICE_TYPE_NOT_SUPPORTED |
Unsupported Language | LANGUAGE_NOT_SUPPORTED |
null | REQUIRED_DATA_FIELDS_MISSING |
“” | BILL_INSUFFICIENTLY_LEGIBLE |
File Processing Timed Out | TIMED_OUT |
Provider Not Supported | IDENTIFYING_PROVIDER |
Under Review | BILL_ANOMALY_FLAGGED |
Under Review | DATA_EXTRACTION_FAILURE_INVESTIGATION_STARTED |
Under Review | DATA_AUDIT_FAILURE_INVESTIGATION_STARTED |
null | REQUEST_CREATED |
null | IN_PROGRESS |
"" | DATA_EXTRACTION_SUCCESSFUL |
Updated 4 months ago