One statement line: its live explanation, its whole history and what of it is unexplained

GET

/v1/entities/{entity_id}/lines/{line_id}

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

Parameters

Path Parameters

line_id

required

Line 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

LineResponse

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

line

required

Line

What has become of one statement line.

status is derived from the live explanation, never stored, so there is exactly one answer. unexplained_micros is the remainder, reported in every state including a fully explained line, where it is "0". history is every explanation ever written for this line, oldest first.

object

line_id

required

Line Id

string

statement_id

required

Statement Id

string

statement_live

required

Statement Live

boolean

line_no

required

Line No

integer

source_key

required

Source Key

string

required

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]*)$/

commodity

required

Commodity

string

account_id

required

Account Id

string

description

required

Description

string

reference

required

Any of:

string
null

string

raw

required

Raw

string

status

required

Status

string

allocated_micros

required

Allocated Micros

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

string

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

unexplained_micros

required

Unexplained Micros

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

string

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

explanation

required

Any of:

LineExplanation
null

LineExplanation

One thing somebody said about a line. The chain of these is the line’s history.

object

explanation_id

required

Explanation Id

string

line_id

required

Line Id

string

kind

required

Kind

Booked | linked | ignored

string

reason

required

Reason

string

entry_id

required

Any of:

string
null

string

correction_id

required

Any of:

string
null

string

supersedes_id

required

Any of:

string
null

string

allocations

required

Allocations

Array<object>

LineAllocation

object

allocation_id

required

Allocation Id

string

posting_id

required

Posting Id

string

entry_id

required

Entry Id

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]*)$/

allocated_micros

required

Allocated Micros

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

string

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

created_at

required

Created At

string

created_by

required

Created By

string

history

required

History

Array<object>

LineExplanation

One thing somebody said about a line. The chain of these is the line’s history.

object

explanation_id

required

Explanation Id

string

line_id

required

Line Id

string

kind

required

Kind

Booked | linked | ignored

string

reason

required

Reason

string

entry_id

required

Any of:

string
null

string

correction_id

required

Any of:

string
null

string

supersedes_id

required

Any of:

string
null

string

allocations

required

Allocations

Array<object>

LineAllocation

object

allocation_id

required

Allocation Id

string

posting_id

required

Posting Id

string

entry_id

required

Entry Id

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]*)$/

allocated_micros

required

Allocated Micros

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

string

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

created_at

required

Created At

string

created_by

required

Created By

string

entries

Entries

The entries this line is booked or linked to, oldest first

Array<object>

LineEntry

An entry a statement line is explained by, with the mirror that already reverses it, if any.

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

reversed_by

Any of:

string
null

string

links

required

Links

object

key

additional properties

string

result

Any of:

object
null

object

key

additional properties

any

Example

{
  "line": {
    "amount_micros": "-12000000",
    "allocated_micros": "-12000000",
    "unexplained_micros": "-12000000",
    "explanation": {
      "allocations": [
        {
          "amount_micros": "-12000000"
        }
      ],
      "allocated_micros": "-12000000"
    },
    "history": [
      {
        "allocations": [
          {
            "amount_micros": "-12000000"
          }
        ],
        "allocated_micros": "-12000000"
      }
    ],
    "entries": [
      {
        "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 statement line: its live explanation, its whole history and what of it is unexplained

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