One entry: its legs, what it is now, and every correction it is part of

GET

/v1/entities/{entity_id}/entries/{entry_id}

const url = 'https://example.com/v1/entities/example/entries/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/entries/example

Return one entry with its legs, its current state and every correction it is part of (issue 0007).

Reviewing an entry means knowing what it is now: posted, corrected or reversed. That is not a column. It follows from the correction rows that name the entry and is derived in one place (views.entry_state).

corrections is the chain from whichever end this entry sits on, so a mirror links back to what it reversed rather than reading as a lone negative entry.

Parameters

Path Parameters

entry_id

required

Entry Id

string

entity_id

required

Entity Id

The entity this path is relative to

string

The entity this path is relative to

Responses

200

Successful Response

application/json

EntryResponse

object

entity_id

required

Entity Id

string

legal_name

required

Legal Name

string

base_currency

required

Base Currency

string

snapshot_seq

required

Snapshot Seq

integer

entry

required

Entry

object

required

string

required

string

narration

required

Narration

string

status

required

Status

string

origin

required

Origin

string

version

required

Version

integer

code

required

Code

string

comment

required

Comment

string

tags

required

Tags

Array<Array<string>>

created_at

required

Created At

string

created_by

required

Created By

string

postings

required

Postings

Array<object>

Posting

object

required

string

seq

required

Seq

integer

account_id

required

Account Id

string

account_path

required

Account Path

string

commodity

required

Commodity

string

amount_micros

required

Amount Micros

Signed integer micro-units (millionths) as a base-10 string; never a JSON number.

string

/^-?(0|[1-9][0-9]*)$/

memo

required

Any of:

string
null

string

tax_code

required

Any of:

string
null

string

links

required

Links

object

key

additional properties

string

version

required

Version

integer

reversed_by

required

Any of:

string
null

string

corrections

required

Corrections

Every correction this entry is part of, whichever end of it it is; issue 0007

Array<object>

CorrectionLink

One link in an entry’s correction chain, and which end of it this entry is.

role saves a reader re-deriving the relationship from three ids: original means this entry was corrected, mirror means it is the reversal, and replacement means it is what was posted in the original’s place. A reversal with no restatement has no replacement_id: “the books stopped saying this” rather than “the books say it differently now”.

object

required

string

role

required

Role

Original | mirror | replacement — which end of this correction the entry is

string

original_id

required

Original Id

string

mirror_id

required

Mirror Id

string

replacement_id

required

Any of:

string
null

string

reason

required

Reason

string

created_at

required

Created At

string

created_by

required

Created By

string

links

required

Links

object

key

additional properties

string

state

required

State

Posted | corrected | reversed | draft | void — what this entry is now

string

Example

{
  "entry": {
    "postings": [
      {
        "amount_micros": "-12000000"
      }
    ]
  }
}

400

Bad Request

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

401

Unauthorized

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

403

Forbidden

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

404

Not Found

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

409

Conflict

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

412

Precondition Failed

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

422

Unprocessable Content

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

500

Internal Server Error

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

503

Service Unavailable

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

One entry: its legs, what it is now, and every correction it is part of

Parameters

Path Parameters

Responses

200

Example

400

Example generated

401

Example generated

403

Example generated

404

Example generated

409

Example generated

412

Example generated

422

Example generated

500

Example generated

503

Example generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated