Close it: recovered after all, naming the entry that did it, or deliberately forgone

POST

/v1/entities/{entity_id}/unrecovered-tax/{record_id}/resolve

curl --request POST \
  --url https://example.com/v1/entities/example/unrecovered-tax/example/resolve \
  --header 'Content-Type: application/json' \
  --data '{ "outcome": "example", "reason": "example", "recovered_entry_id": "example" }'

Close a record as recovered (naming the recovering entry) or forgone (the reason stands alone).

Without forgone the list would only grow. When a claim window closes, or an amount is not worth the paperwork, the record would otherwise go on saying money is recoverable when it is not.

Parameters

Path Parameters

record_id

required

Record Id

string

entity_id

required

Entity Id

The entity this path is relative to

string

The entity this path is relative to

Request Body^required

Media typeapplication/json

UnrecoveredResolution

Close a record.

recovered names the entry that recovered it. forgone names nothing, so its reason has to explain it (the window closed, or the claim was not worth making).

object

outcome

required

Outcome

Recovered | forgone

string

reason

required

Reason

string

>= 1 characters

recovered_entry_id

Any of:

string

string

<= 255 characters

null

null

Example ^generated

{
  "outcome": "example",
  "reason": "example",
  "recovered_entry_id": "example"
}

Responses

201

Successful Response

Media typeapplication/json

UnrecoveredResponse

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

record

required

UnrecoveredRecord

object

id

required

Id

string

entry_id

required

Entry Id

string

posting_id

required

Any of:

string

string

null

null

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

string

null

null

reason

required

Reason

string

recoverable_until

required

Any of:

string

string

null

null

recovered_entry_id

required

Any of:

string

string

null

null

supersedes_id

required

Any of:

string

string

null

null

created_at

required

Created At

string

created_by

required

Created By

string

history

required

History

Every record about this entry, oldest first

Array<object>

UnrecoveredRecord

object

id

required

Id

string

entry_id

required

Entry Id

string

posting_id

required

Any of:

string

string

null

null

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

string

null

null

reason

required

Reason

string

recoverable_until

required

Any of:

string

string

null

null

recovered_entry_id

required

Any of:

string

string

null

null

supersedes_id

required

Any of:

string

string

null

null

created_at

required

Created At

string

created_by

required

Created By

string

links

required

Links

object

key

additional properties

string

Example

{
  "record": {
    "amount_micros": "-12000000"
  },
  "history": [
    {
      "amount_micros": "-12000000"
    }
  ]
}

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

string

null

null

next_action

Any of:

object

object

key

additional properties

any

null

null

Example ^generated

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

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

string

null

null

next_action

Any of:

object

object

key

additional properties

any

null

null

Example ^generated

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

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

string

null

null

next_action

Any of:

object

object

key

additional properties

any

null

null

Example ^generated

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

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

string

null

null

next_action

Any of:

object

object

key

additional properties

any

null

null

Example ^generated

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

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

string

null

null

next_action

Any of:

object

object

key

additional properties

any

null

null

Example ^generated

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

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

string

null

null

next_action

Any of:

object

object

key

additional properties

any

null

null

Example ^generated

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

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

string

null

null

next_action

Any of:

object

object

key

additional properties

any

null

null

Example ^generated

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

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

string

null

null

next_action

Any of:

object

object

key

additional properties

any

null

null

Example ^generated

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

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

string

null

null

next_action

Any of:

object

object

key

additional properties

any

null

null

Example ^generated

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