smart-extract-documentation
v4.1.1
v4.1.1
  • SmartExtract
  • API Reference
    • Data Extraction API
      • Authentication
      • SmartExtract JSON API
    • Admin API
      • API Key Management
      • Extraction Logs API
  • smart-extract.js
    • Integration Overview
    • SmartExtract API
    • SmartExtractSimple API
    • Styling and Customisations
    • Pre-Fillling Extraction Form
    • Performing Multiple Extraction
    • Code Examples
      • SmartExtract API Examples
      • SmartExtractSimple API Examples
  • Appendix
Powered by GitBook
On this page
  • Asset Type
  • Document Type
  • Error Codes

Appendix

Asset Type

While extracting data from documents SmartExtract needs to know the asset type to extract and parse information correctly. SmartExtract supports number of asset types, following is a list of valid asset types that can be consumed by SmartExtract:

type ValidAssetType = 
'MULTIFAMILY' |
'STORAGE' |
'CONDO' |
'MOBILE_HOME_PARK' |
'HEALTHCARE' |
'HOTEL' |
'OFFICE' |
'RETAIL' |
'INDUSTRIAL' |
'PARKING_GARAGE'

Document Type

Similar to Asset Type, SmartExtract also needs to know the type of document that is being extracted. Following is a list of valid document types that can be consumed by SmartExtract:

export type DocumentType =
  'OPERATING_STATEMENT' |
  'OPERATING_STATEMENT_BUDGET' |
  'OPERATING_STATEMENT_PROFORMA' |
  'RENT_ROLL' |
  'CASH_FLOW'

Error Codes

Error Code
Error Message
Reason

601

Invalid document type, input document must be an operating statement or rent roll

Unknown document type

602

Unsupported file format, must be Excel or Pdf

603

Error while trying to map the amount column.

Error while parsing indented Excel format

604

Error while trying to map the amount column.

Error while extracting indented amount directly

605

Invalid document type, input document must be an operating statement or rent roll

Invalid document_type in the tagging data

606

Invalid asset type, must be one of multifamily, office, retail, hotel or senior housing

607

The statement starting period date is not provided

608

The statement ending period date is not provided

609

The pdf file seems corrupted, text box coordinates are in incorrect format

610

Document Writing Direction could not be resolved

611

Unable to read excel file due to applied conditional formatting on the sheet

612

Couldn't resolve first data row

613

Couldn't find the header row and first data row

614

Non-OCR document extraction gave empty page results for tagged pages

PreviousSmartExtractSimple API Examples

Last updated 1 year ago