Recognition / amortization schedule for a document
Demo-parity customer route for an explicitly allowlisted active or test company. /qa callers additionally require the QA application marker and persisted test lifecycle. Returns the recognition or amortization schedule for a contract / invoice document line: the schedule type and a list of period entries with running cumulative amounts and posted/pending status. { immediate: true } is returned only when the company posts through the subledger core and no schedule exists for the document in the selected entity. Every other schedule-less case returns { status, reason } and makes no recognition claim: unavailable/document_not_found for a document outside the selected entity (unknown and sibling-entity documents are indistinguishable), not_scheduled/no_business_event for a document with no business event, and unavailable/schedule_authority_not_entity_scoped when the only schedule authority is not keyed to the selected entity.
Request
- Base URL: https://api.medianfi.com/api/v1
- URL: https://api.medianfi.com/api/v1/companies/{companyId}/books/schedules/recognition
- Auth: HTTP bearer
Query parameters
Concrete legal entity to read. Mutually exclusive with reportingScopeId/scopeAsOf. Omission is accepted only when the actor is authorized to exactly one concrete entity.
The invoice/bill document id. Resolved to its recognition schedule only after the document is authorized for the selected legal entity. It is then matched against business_events.metadata.sourceDocumentId, and the schedule keys on that event id (event_schedules.source_event_id).
Zero-based line index for multi-line documents (reserved for future use; currently only the first schedule per document is returned).
Response
Recognition schedule payload
Changes
No recorded changes to this operation across all 1 revision of this API.