Capture immutable quarterly sources, mappings, adjustments and figures

POST/reporting/call-report/workpapers

Headers

Idempotency-KeystringRequired

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

adjustmentsarray of objectsOptional

5 child attributes

amountintegerRequired

Exact units of the integer or usd_cents figure

codestringRequired

evidence_refstringRequired

evidence_sha256stringRequired

reasonstringRequired

mapping_refstringRequired

mappingsarray of objectsRequired

6 child attributes

codestringRequired

Local figure key; MDRM binding is separately reviewed

itemstringRequired

mdrmstringOptional

schedulestringRequired

termsarray of objectsRequired

3 child attributes

coefficientintegerRequired

+1 or -1; non-integer values require one +1 term

keystringRequired

source_idstringRequired

unitstringRequired

profile_idstringRequired

rationalestringRequired

sourcesarray of objectsRequired

7 child attributes

as_ofstring · dateRequired

A business date, YYYY-MM-DD

evidence_refstringOptional

evidence_sha256stringOptional

idstringRequired

kindstringRequired

Gl_positions, gl_income_ytd, imported, or a declared local source kind

period_startstring · date or nullOptional

A business date, YYYY-MM-DD

valuesarray of objectsOptional

3 child attributes

keystringRequired

unitstringRequired

Usd_cents, integer, decimal, boolean, text

valuestringRequired

supersedesstringOptional

Returns

200 OK

content_sha256stringRequired

figuresarray of objectsRequired

8 child attributes

adjustmentstringRequired

base_valuestringRequired

codestringRequired

itemstringRequired

mdrmstringOptional

schedulestringRequired

unitstringRequired

valuestringRequired

idstringRequired

mapping_sha256stringRequired

missing_schedulesarray of stringsRequired

profile_sha256stringRequired

proposed_atstring · date-timeRequired

proposed_bystringRequired

report_datestring · dateRequired

A business date, YYYY-MM-DD

requestobjectRequired

7 child attributes

adjustmentsarray of objectsOptional

5 child attributes

amountintegerRequired

Exact units of the integer or usd_cents figure

codestringRequired

evidence_refstringRequired

evidence_sha256stringRequired

reasonstringRequired

mapping_refstringRequired

mappingsarray of objectsRequired

6 child attributes

codestringRequired

Local figure key; MDRM binding is separately reviewed

itemstringRequired

mdrmstringOptional

schedulestringRequired

termsarray of objectsRequired

3 child attributes

coefficientintegerRequired

+1 or -1; non-integer values require one +1 term

keystringRequired

source_idstringRequired

unitstringRequired

profile_idstringRequired

rationalestringRequired

sourcesarray of objectsRequired

7 child attributes

as_ofstring · dateRequired

A business date, YYYY-MM-DD

evidence_refstringOptional

evidence_sha256stringOptional

idstringRequired

kindstringRequired

Gl_positions, gl_income_ytd, imported, or a declared local source kind

period_startstring · date or nullOptional

A business date, YYYY-MM-DD

valuesarray of objectsOptional

3 child attributes

keystringRequired

unitstringRequired

Usd_cents, integer, decimal, boolean, text

valuestringRequired

supersedesstringOptional

reviewobject or nullOptional

7 child attributes

actorstringRequired

content_sha256stringRequired

decisionstringRequired

evidence_refstringRequired

rationalestringRequired

reviewed_atstring · date-timeRequired

scopestringRequired

Supplied_figures, never a filing attestation

source_snapshotsarray of objectsRequired

11 child attributes

as_ofstring · dateRequired

A business date, YYYY-MM-DD

captured_atstring · date-timeRequired

dataobjectRequired

evidence_refstringOptional

evidence_sha256stringOptional

idstringRequired

kindstringRequired

Gl_positions, gl_income_ytd, imported, or a declared local source kind

missingarray of objectsOptional

5 child attributes

categorystringRequired

keystringRequired

mdrmstringOptional

reasonstringRequired

referenceobjectRequired

3 child attributes

columnstringRequired

linestringRequired

schedulestringRequired

period_startstring · date or nullOptional

A business date, YYYY-MM-DD

sha256stringRequired

valuesarray of objectsOptional

3 child attributes

keystringRequired

unitstringRequired

Usd_cents, integer, decimal, boolean, text

valuestringRequired

submission_blockersarray of stringsRequired

submission_readybooleanRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503