Skip to main content
GET
List revaluations
Filter by period_id to see every attempt for one accounting period, including a superseded retry. To check a job, list with its period_id and read data[0].status.

Authorizations

X-API-Key
string
header
required

Your organization API key. Some operations also need a key that is associated with a user; their pages say so.

Query Parameters

period_id
string

Accounting period ID (ap_…). Omit to list all periods.

Example:

"ap_507f1f77bcf86cd799439011"

status
enum<string>[]

Comma-separated statuses to filter to.

Available options:
started,
in_progress,
completed,
job_failed,
canceled,
hanged
limit
integer
default:25

Maximum number of records to return.

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

The next_cursor value from the previous page. Keep the other filters unchanged.

include_count
boolean
default:false

Set to true to include total_count.

Response

Successful result.

data
object[]
required

The records.

has_more
boolean
required

Whether another page is available.

next_cursor
string | null
required

Cursor for the next page, or null on the last page.

total_count
integer

Present only when include_count=true.