Update PDF attributes including status
Update PDF attributes including status
Authorizations
Path Parameters
heron_id of the pdf
Body
The filename of the PDF
"my-favourite.pdf"
If fraud reason
True if fraud was detected in the PDF
Notes associated with PDF, e.g., rejected reason, failed reason
The reconciliation status a reviewer sets for the document.
reconciled— the reviewer confirmed the document reconciles.unreconciled— load the transactions but keep the document out of the reconciled scope, so default summaries and policy floors skip it.not_possible— there was nothing to reconcile against.
Send it with status=approved, or on its own to restamp a document whose transactions already loaded. Any other status, or no status on a document still in review, is a 400. unreconciled and not_possible also need unreconciled transaction loading enabled. Omit or null the field to leave the automatic status standing.
What you send is what a reviewer can decide, not always what gets stored: unreconciled is stored as failed, the same value an automatic check writes when it does not match. Read reconciliation_method to tell them apart — human marks a reviewer's ruling. Only the EUSQL transactions_all table exposes that field; the data source account summary route and its webhook report the status without it.
Restamping a loaded document changes nothing else: its status stays put and no event fires. Scoped summaries follow on the next read, policy data on the next evaluation.
reconciled overrides the stored status but not the pdf.processed event, so for a document whose automatic check failed that event keeps reporting is_reconciled: false.
reconciled, unreconciled, not_possible, null "unreconciled"
An optional field for your unique identifier for the PDF
140"my-favourite-pdf"
Status of PDF
new, parsing, parsed, processed, human_reviewing, approved, rejected, failed, transactions_loaded, transactions_unloaded "processed"