Skip to content
Exhale

The import waiting from a chat

GET
/api/v1/import/review
curl --request GET \
  --url http://127.0.0.1:8484/api/v1/import/review

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
review
object
channel
required

The chat it came from, e.g. telegram

string
createdAt
required
string format: date-time
id
required

Changes when another file replaces the review

string
off
object
key
additional properties
boolean
outcomes
required
Array<object> | null
object
action
required
string
Allowed values: create duplicate error
id
string
message
string
name
required
string
result
required
object
items
required
Array<object> | null
object
account
string
altPrice
string
altUnit
string
Allowed values: month year
autoConfirm
boolean
cancelUrl
string
category
string
currency
string
dayRule
string
Allowed values: day weekday last-weekday
endDate
string
interval
integer format: int64
name
required
string
nextCharge
string
notes
string
noticeDays
integer format: int64
payer
string
paymentMethod
string
price
required
string
remark
string
reminderDays
Array<integer> | null
renewal
string
Allowed values: auto manual
startedOn
string
status
string
Allowed values: active paused cancelled
tags
Array<string> | null
trialEndsOn
string
unit
string
Allowed values: day week month year
url
string
weekendShift
string
Allowed values: none next previous
match
object
$schema

A URL to the JSON Schema for this object.

string format: uri
from
required
string
matches
required
Array<object> | null
object
action
required
string
Allowed values: mark_paid already_paid
charge
required
object
amount
required
object
currency
required
string
minor
required
integer format: int64
cancelBy
string
cancelPassed
required
boolean
chargedAmount
object
currency
required
string
minor
required
integer format: int64
daysUntil
required
integer format: int64
decision
string
delayed
required
boolean
dueDate
required
string
id
required
string
kind
required
string
Allowed values: renewal trial expiry
logo
string
note
string
originalDate
required
string
paymentMethod
string
resolvedAt
string format: date-time
status
required
string
subscriptionId
required
string
subscriptionName
required
string
updatedAt
required
string format: date-time
version
required
integer format: int64
paid
required
object
currency
required
string
minor
required
integer format: int64
priceChange
object
changePercent
required
string
charged
required
object
currency
required
string
minor
required
integer format: int64
expected
required
object
currency
required
string
minor
required
integer format: int64
yearlyDelta
required
object
currency
required
string
minor
required
integer format: int64
transaction
required
object
amount
required
string
currency
string
date
required
string
description
required
string
missing
required
Array<object> | null
object
amount
required
object
currency
required
string
minor
required
integer format: int64
cancelBy
string
cancelPassed
required
boolean
chargedAmount
object
currency
required
string
minor
required
integer format: int64
daysUntil
required
integer format: int64
decision
string
delayed
required
boolean
dueDate
required
string
id
required
string
kind
required
string
Allowed values: renewal trial expiry
logo
string
note
string
originalDate
required
string
paymentMethod
string
resolvedAt
string format: date-time
status
required
string
subscriptionId
required
string
subscriptionName
required
string
updatedAt
required
string format: date-time
version
required
integer format: int64
to
required
string
unmatched
required
integer format: int64
model
string
notes
required
Array<string> | null
source
required
string
waiting
required
boolean

Example 

{
  "$schema": "https://example.com/api/schemas/ImportReviewOut.json",
  "review": {
    "outcomes": [
      {
        "action": "create"
      }
    ],
    "result": {
      "items": [
        {
          "altUnit": "month",
          "dayRule": "day",
          "renewal": "auto",
          "status": "active",
          "unit": "day",
          "weekendShift": "none"
        }
      ],
      "match": {
        "$schema": "https://example.com/api/schemas/StatementMatch.json",
        "matches": [
          {
            "action": "mark_paid",
            "charge": {
              "kind": "renewal"
            }
          }
        ],
        "missing": [
          {
            "kind": "renewal"
          }
        ]
      }
    }
  }
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example 

{
  "$schema": "https://example.com/api/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}