Close eligibility through a date: per check, a status, a reason and the outstanding items
const url = 'https://example.com/v1/entities/example/close-checks?through=example';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/v1/entities/example/close-checks?through=example'Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The entity this path is relative to
The entity this path is relative to
Query Parameters
Section titled “Query Parameters”The close date this would close through (YYYY-MM-DD)
The close date this would close through (YYYY-MM-DD)
Check keys to preview an override of; the reason belongs on the close itself, not on a preview
Check keys to preview an override of; the reason belongs on the close itself, not on a preview
Responses
Section titled “Responses”Successful Response
object
object
Every check positively passed; a recorded override does NOT make this true
Nothing blocks: every check passed or a recorded override waives it
object
Pass | fail | unevaluable; only ‘pass’ is a positive answer
One specific thing that would have to change for a check to pass.
Amounts inside detail are integer micro strings, as everywhere else.
object
object
An override, matched to the check it let through and to what that check found at that moment.
Overrides that name no currently-blocking check; a close would refuse them
Close over one named blocking check: the check, and why. There is no id to pre-create and no wildcard.
An override is matched against the checks as the server has just evaluated them, so it can only name a failure that is real at this moment. A blanket bypass cannot be expressed. Each override is stored on the close record with the check’s status and outstanding count as they stood, the acting principal and this reason.
object
The check key this override answers, e.g. ‘statement_coverage’
Why this period is being closed with that check unsatisfied
The period lock as this evaluation read it. Its version is the expected_version a close or reopen sends back, so the answer to ‘would this close?’ carries what performing it needs
object
Example generated
{ "entity_id": "example", "legal_name": "example", "base_currency": "example", "snapshot_seq": 1, "through": "example", "window_start": "example", "prior_through": "example", "months": [ { "additionalProperty": "example" } ], "eligible": true, "may_close": true, "checks": [ { "check": "example", "title": "example", "requirement": "example", "status": "example", "reason": "example", "blocking": true, "outstanding": [ { "kind": "example", "message": "example", "detail": {} } ], "outstanding_truncated": 1, "waiver": { "check": "example", "through": "example", "reason": "example", "actor": "example", "status_at_close": "example", "reason_at_close": "example", "outstanding_at_close": 1 } } ], "blocking_checks": [ "example" ], "unmatched_overrides": [ { "check": "example", "reason": "example" } ], "lock": { "through": "example", "version": 1, "close_id": "example" }, "links": { "additionalProperty": "example" }}Bad Request
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Unauthorized
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Forbidden
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Not Found
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Conflict
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Precondition Failed
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Unprocessable Content
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Internal Server Error
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Service Unavailable
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}