Skip to content
Haddon

What tax are we not reclaiming, and why: with a total per commodity

GET
/v1/entities/{entity_id}/unrecovered-tax
curl --request GET \
  --url 'https://example.com/v1/entities/example/unrecovered-tax?state=unrecovered'

List unrecovered-tax records in one state, with a total per commodity. Defaults to unrecovered.

totals is per commodity and never summed across commodities: two currencies are two answers. The from/to filters apply to the entry date.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
entity_id
required
Entity Id

The entity this path is relative to

string

The entity this path is relative to

Query Parameters

Section titled “Query Parameters”
state
State

Unrecovered | recovered | forgone

string
default: unrecovered

Unrecovered | recovered | forgone

from
Any of:
string

Inclusive, on the entry date

to
Any of:
string

Inclusive, on the entry date

limit
Any of:
integer
cursor
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
UnrecoveredPage
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
items
required
Items
Array<object>
UnrecoveredItem
object
record
required
UnrecoveredRecord
object
id
required
Id
string
entry_id
required
Entry Id
string
posting_id
required
Any of:
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]*)$/
state
required
State

Unrecovered | recovered | forgone

string
tax_code
required
Any of:
string
reason
required
Reason
string
recoverable_until
required
Any of:
string
recovered_entry_id
required
Any of:
string
supersedes_id
required
Any of:
string
created_at
required
Created At
string
created_by
required
Created By
string
entry
required
Entry
object
id
required
Id
string
dt
required
Dt
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
id
required
Id
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
tax_code
required
Any of:
string
links
required
Links
object
key
additional properties
string
links
required
Links
object
key
additional properties
string
next_cursor
required
Any of:
string
state
required
State
string
totals
required
Totals

Per commodity, never summed across them

object
key
additional properties
string

Example 

{
  "items": [
    {
      "record": {
        "amount_micros": "-12000000"
      },
      "entry": {
        "postings": [
          {
            "amount_micros": "-12000000"
          }
        ]
      }
    }
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/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
next_action
Any of:
object
key
additional properties
any

Example generated

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

401

Section titled “401”

Unauthorized

Media typeapplication/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
next_action
Any of:
object
key
additional properties
any

Example generated

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

403

Section titled “403”

Forbidden

Media typeapplication/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
next_action
Any of:
object
key
additional properties
any

Example generated

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

404

Section titled “404”

Not Found

Media typeapplication/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
next_action
Any of:
object
key
additional properties
any

Example generated

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

409

Section titled “409”

Conflict

Media typeapplication/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
next_action
Any of:
object
key
additional properties
any

Example generated

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

412

Section titled “412”

Precondition Failed

Media typeapplication/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
next_action
Any of:
object
key
additional properties
any

Example generated

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

422

Section titled “422”

Unprocessable Content

Media typeapplication/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
next_action
Any of:
object
key
additional properties
any

Example generated

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

500

Section titled “500”

Internal Server Error

Media typeapplication/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
next_action
Any of:
object
key
additional properties
any

Example generated

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

503

Section titled “503”

Service Unavailable

Media typeapplication/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
next_action
Any of:
object
key
additional properties
any

Example generated

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