One close or reopen, read back, with a link to the snapshot it was recorded against
const url = 'https://example.com/v1/entities/example/closes/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/closes/exampleRead one close or reopen record, linking to the immutable snapshot behind it (issue 0005, criterion 6).
A close returns its snapshot link only once, in the 201. This route is the way back to it afterwards. The
lock carries the id of the close that set it (lock_close_id on the entity summary), so from any closed
period this is one hop.
Read-only, and shaped like /snapshots/{id} and /exports/{id}. A close record is an immutable row,
never updated or deleted, so it is fetched by id and there is no listing here. The history of closes belongs
to the reviewer loop (issue 0007).
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The entity this path is relative to
The entity this path is relative to
Responses
Section titled “Responses”Successful Response
One close or reopen, read back. links.snapshot is the immutable state it was recorded against.
object
The waivers this close was let through on, each with the check, the actor and the reason; empty on a reopen, which waives nothing
object
object
Example generated
{ "entity_id": "example", "legal_name": "example", "base_currency": "example", "snapshot_seq": 1, "id": "example", "kind": "example", "through": "example", "prior_through": "example", "snapshot_id": "example", "reason": "example", "overrides": [ {} ], "created_at": "example", "created_by": "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": {} }}