Toshl Developer

Reviews

Reviews endpoint can be used to fetch entries that need to be reviewed for various reasons.

Resource representation

{
  "id": "42",
  "types": [
    "transfer",
    "income"
  ],
  "matches": [
    "43",
    "44"
  ],
  "accounts": [
    "42",
    "43"
  ]
}

Properties

id
readonly
string

Review id.

entry
read, write
object

Review entry

id
readonly
string

Entry id.

amount
read, write
number

Entry amount.

Minimum: > -1000000000000000
Maximum: < 1000000000000000
currency
read, write
object

Currency object

code
read, write
string

Entry currency code.

Regex: [A-Z_]{2,10}
rate
read, write
number

Entry exchange rate calculated according to entry account currency.

Minimum: > 0
main_rate
readonly
number

Entry exchange rate main currency calculated according to entry main currency.

fixed
read, write
boolean

If set to true, the exchange rate is fixed.

Default value: false
date
read, write
string

Review purchase date in YYYY-MM-DD format.

Format: date
desc
read, write
string

Review description.

Max length: 3072
account
read, write
string

Review account id.

types
readonly
array

Available review type options

Possible values: expense, income, transfer
matches
readonly
array

Potential matches for the review (if applicable)

accounts
readonly
array

Accounts that can be selected as transfer targets for review.

type
read, write
string

Selected type

Possible values: expense, income, transfer
match
read, write
string

Matched entry id

account
read, write
string

If none of the possible matches are the missing entry pair, selecting the account will create a new entry on the specified account and match them up.

completed
read, write
boolean

If review has already been completed.

* denotes required field/parameter.