GET
List exchange rates
Organization space Accounting module For: Accountant · Permission: exchange_rates.list Conditions
  • The accounting module must be included in the plan of the organization.
  • Exchange rates belong to the organization, not to a book.
  • The caller needs an accounting access grant on at least one book of the organization. This is checked before validation.
  • Results are cursor-paginated (per_page 1 to 100, default 15), newest valid_from first unless sort_by (valid_from, created_at) and sort_order are sent.
Part of Set up the books.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 100
cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string> | null

Field the list is sorted by.

Available options:
valid_from,
created_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
source_currency_code
string | null

Three-letter currency code, case-insensitive (it is upper-cased), of the currency being converted from. Keeps only rates with this source currency.

Required string length: 3
target_currency_code
string | null

Three-letter currency code, case-insensitive, of the currency converted to. Keeps only rates with this target currency.

Required string length: 3
direction
enum<string> | null

Money flow the rate applies to: incoming or outgoing. Keeps only rates of this direction.

Available options:
incoming,
outgoing
active_on
string<date-time> | null

Date (ISO 8601). Keeps only rates in force on that day: started on or before it and not closed, or closed on or after it.

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, source_currency_code, source_currency_exponent, target_currency_code, target_currency_exponent, direction, rate, valid_from, valid_to, created_by, created_by_type, created_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

Resource.

data
ExchangeRateResource · object[]
required

Items of this page.

meta
object
required

Pagination details.