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.

category
read, write
string

Entry category id.

tags
read, write
array

An array of tag ids.

types
readonly
array

Available review type options

Possible values: expense, income, transfer, repeat
matches
readonly
array

Potential matches for the review (if applicable)

repeats
readonly
array

Matching repeats.

id
readonly
string

Repeat id.

start
read, write
string

Repeat start date.

Format: date
end
read, write
string

Repeat end date. If end date is not specified the end parameter is omitted. count can be specified instead of end.

Format: date
template_start
readonly
string

Template start date. Only present if entry is a repeat template.

Format: date
template_end
readonly
string

Template end date. Only present if entry is a repeat template.

Format: date
frequency
read, write
string

Repeat frequency.

Possible values: daily, weekly, monthly, yearly
interval
read, write
integer

Repeat interval. For example: repeating every two months -> frequency: monthly, interval: 2.

Minimum: >= 1
Maximum: =< 255
count
read, write
integer

How many times to repeat entry.

Minimum: >= 1
byday
read, write
string

A comma separated list of weekdays (MO,TU..). Each weekday can have be preceded by a positive or negative number (1MO - 1st monday of the month/year, -1MO - last monday of the month/year).

bymonthday
read, write
string

A comma separated list of month days (1-31). Each month day can have a plus(+) or minus(-) prefix.

bysetpos
read, write
string

A comma separater list of the nth occurance within bymonthday. If you wish to set a repeat to occur on the last day of the month, set frequency to monthly, bymonthday to 28,29,30,31 and bysetpos to -1.

iteration
readonly
integer

Repeat iteration number. First entry in the repeat has iteration=0.

Minimum: >= 0
template
readonly
boolean

Set to true if this entry is a template for all future repeating entries in this repeat.

entries
read, write
array

List of entry ids that were used to create the repeat (used only for confirming detected repeats).

type
read, write
string

Repeat type.

Possible values: automatic, confirm, confirmed
accounts
readonly
array

Accounts that can be selected as transfer targets for review.

type
read, write
string

Selected type

Possible values: expense, income, transfer, repeat
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.

repeat
read, write
object

A repeat object.

id
readonly
string

Repeat id.

start *
read, write
string

Repeat start date.

Format: date
end
read, write
string

Repeat end date. If end date is not specified the end parameter is omitted. count can be specified instead of end.

Format: date
template_start
readonly
string

Template start date. Only present if entry is a repeat template.

Format: date
template_end
readonly
string

Template end date. Only present if entry is a repeat template.

Format: date
frequency *
read, write
string

Repeat frequency.

Possible values: daily, weekly, monthly, yearly
interval *
read, write
integer

Repeat interval. For example: repeating every two months -> frequency: monthly, interval: 2.

Minimum: >= 1
Maximum: =< 255
count
read, write
integer

How many times to repeat entry.

Minimum: >= 1
byday
read, write
string

A comma separated list of weekdays (MO,TU..). Each weekday can have be preceded by a positive or negative number (1MO - 1st monday of the month/year, -1MO - last monday of the month/year).

bymonthday
read, write
string

A comma separated list of month days (1-31). Each month day can have a plus(+) or minus(-) prefix.

bysetpos
read, write
string

A comma separater list of the nth occurance within bymonthday. If you wish to set a repeat to occur on the last day of the month, set frequency to monthly, bymonthday to 28,29,30,31 and bysetpos to -1.

iteration
readonly
integer

Repeat iteration number. First entry in the repeat has iteration=0.

Minimum: >= 0
template
readonly
boolean

Set to true if this entry is a template for all future repeating entries in this repeat.

entries
read, write
array

List of entry ids that were used to create the repeat (used only for confirming detected repeats).

type
read, write
string

Repeat type.

Possible values: automatic, confirm, confirmed
completed
read, write
boolean

If review has already been completed.

* denotes required field/parameter.