Record that this line will not be booked, and why
const url = 'https://example.com/v1/entities/example/lines/example/ignore';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"reason":"example","id":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/v1/entities/example/lines/example/ignore \ --header 'Content-Type: application/json' \ --data '{ "reason": "example", "id": "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
Request Bodyrequired
Section titled “Request Bodyrequired”Record that this line will not be booked, and why.
An ignored line counts as explained, and the close checks take it as answered. That is why the reason is required: it is the whole content of the decision a reviewer reads later.
Example generated
{ "reason": "example", "id": "example"}Responses
Section titled “Responses”Successful Response
object
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
Signed integer micro-units (millionths) as a base-10 string; never a JSON number.
Unexplained | partly_explained | booked | linked | ignored | superseded_input
Signed integer micro-units (millionths) as a base-10 string; never a JSON number.
Signed integer micro-units (millionths) as a base-10 string; never a JSON number.
One thing somebody said about a line. The chain of these is the line’s history.
object
Booked | linked | ignored
object
Signed integer micro-units (millionths) as a base-10 string; never a JSON number.
Signed integer micro-units (millionths) as a base-10 string; never a JSON number.
One thing somebody said about a line. The chain of these is the line’s history.
object
Booked | linked | ignored
object
Signed integer micro-units (millionths) as a base-10 string; never a JSON number.
Signed integer micro-units (millionths) as a base-10 string; never a JSON number.
The entries this line is booked or linked to, oldest first
An entry a statement line is explained by, with the mirror that already reverses it, if any.
object
object
Signed integer micro-units (millionths) as a base-10 string; never a JSON number.
object
object
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" } ] } ] }}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": {} }}