Read one FR Y-9SP workpaper: captured sources, figures, coverage and review
GET
/reporting/fr-y9sp/workpapers/{id}Path parameters
idstringRequiredReturns
200 OK
content_sha256stringRequiredcoveragearray of objectsRequired10 child attributes
completebooleanRequiredexplainedintegerRequiredfiguresintegerRequireditemsarray of objectsRequired11 child attributes
captionstringRequiredfigure_codestringOptionalitemstringRequiredkeystringRequiredSCHEDULE:item, the item without its separators (SC:4a, SCM:M11f)
mdrmstringRequiredmissing_categorystringOptionalreasonstringOptionalschedulestringRequiredsource_kindstringOptionalstatusstringRequiredSupplied, explained or uncovered
unitstringRequiredUsd_cents, integer or boolean
missing_categoriesobjectRequiredperiodstringRequiredpositionsintegerRequiredschedulestringRequiredsuppliedintegerRequireduncoveredintegerRequiredfiguresarray of objectsRequired10 child attributes
adjustmentstringRequiredbase_valuestringRequiredcaptionstringRequiredcodestringRequireditemstringRequiredmdrmstringRequiredpositionstringRequiredschedulestringRequiredunitstringRequiredvaluestringRequiredidstringRequiredmapping_sha256stringRequiredprofile_sha256stringRequiredproposed_atstring · date-timeRequiredproposed_bystringRequiredreport_datestring · dateRequiredA business date, YYYY-MM-DD
requestobjectRequiredWorkpaperRequest proposes one report date's figures: the reviewed profile they are prepared under, the sources to capture, the mapping of source values onto declared form positions and any evidenced adjustment.
7 child attributes
adjustmentsarray of objectsOptional5 child attributes
amountintegerRequiredExact units of the cents or integer position
codestringRequiredevidence_refstringRequiredevidence_sha256stringRequiredreasonstringRequiredmapping_refstringRequiredmappingsarray of objectsRequired3 child attributes
codestringRequiredpositionstringRequiredtermsarray of objectsRequired3 child attributes
coefficientintegerRequired+1 or -1; a boolean position takes one +1 term
keystringRequiredsource_idstringRequiredprofile_idstringRequiredrationalestringRequiredsourcesarray of objectsRequired7 child attributes
as_ofstring · dateRequiredA business date, YYYY-MM-DD
evidence_refstringOptionalevidence_sha256stringOptionalidstringRequiredkindstringRequiredperiod_startstring · date or nullOptionalA business date, YYYY-MM-DD
valuesarray of objectsOptional3 child attributes
keystringRequiredunitstringRequiredvaluestringRequiredsupersedesstringOptionalreviewobject or nullOptional7 child attributes
actorstringRequiredcontent_sha256stringRequireddecisionstringRequiredevidence_refstringRequiredrationalestringRequiredreviewed_atstring · date-timeRequiredscopestringRequiredSupplied_figures, never a filing attestation
source_snapshotsarray of objectsRequired11 child attributes
as_ofstring · dateRequiredA business date, YYYY-MM-DD
captured_atstring · date-timeRequireddataobjectRequiredevidence_refstringOptionalevidence_sha256stringOptionalidstringRequiredkindstringRequiredmissingarray of objectsOptional5 child attributes
categorystringRequireditemstringRequiredkeystringRequiredmdrmstringRequiredreasonstringRequiredperiod_startstring · date or nullOptionalA business date, YYYY-MM-DD
sha256stringRequiredvaluesarray of objectsOptional3 child attributes
keystringRequiredunitstringRequiredvaluestringRequiredsubmission_blockersarray of stringsRequiredsubmission_readybooleanRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503