Upload a source document
Who does this: XBRL Preparer · XBRL Reviewer · Senior Accountant · Platform Admin When: A filing is at
DRAFTand you need to ingest a financial-statement DOCX or PDF. Result:XbrlSourceDocument,XbrlLineItem, andXbrlTagMapping(unconfirmed) rows populated. Filing transitions toMAPPING_IN_PROGRESS.
Before you start
- [ ] Filing at
DRAFT(see Create an XBRL filing). - [ ] A DOCX or PDF with textual tables (a rasterised scan will yield zero line items).
- [ ] File size ≤ 10 MB.
- [ ] You hold
INGEST_XBRL_DOCUMENT.
Steps
- Open the filing detail page → Documents tab.
- Click Upload source document.
- Drop the DOCX or PDF into the drag-drop zone.
- The handler:
- Persists the bytes to S3
- Computes SHA-256 (dedup)
- Inserts
XbrlSourceDocumentwithparseStatus = PENDING - Enqueues
ingest-fs-document→extract-line-items→suggest-tag-mappings
- Within ~30–60 seconds the Documents tab refreshes with
parseStatus = PARSEDand the Mappings tab populates with rows.
How to know it worked
XbrlSourceDocument.parseStatus = PARSED.- Line items appear on the Mappings tab grouped by
statement. - Filing status badge moved through
DRAFT → DOCUMENTS_INGESTED → MAPPING_IN_PROGRESS. - Activity log threads
xbrl.document.uploaded→xbrl.document.parsed→xbrl.mappings.suggested.
Common situations
| If you see… | It means… | What to do |
|---|---|---|
parseStatus = FAILED and zero line items | DOCX/PDF was rasterised or has no extractable tables | See Zero line items. Ask the client for a textual file or use Pull from FS engagement |
Line items extracted but mostly empty valueCurrent | Table layout edge case in the parser | See DOCX table not parsed |
Suggestion confidence is all LOW | Source headings don't align to standard statement names | See All low confidence |
413 Payload Too Large | File > 10 MB | Strip non-statement appendices and re-upload |
Re-uploading
Re-uploading the same bytes is idempotent (sha256 dedup). Re-uploading a different file from MAPPING_IN_PROGRESS is allowed but drops all line items and mappings — the UI prompts to confirm.
Related runbooks
- Confirm tag mappings — next step
- Pull from FS engagement — Phase 3 cross-product
- X-02 userflow
- XBRL Filing SOP §6 / Step 2.0