Skip to main content
POST
Export a report

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Body

application/json
client_id
string
required

The client the report is about, from list_clients.

Required string length: 1 - 60
kind
enum<string>
required

balance_summary: every account and its balance on as_at. spending_summary: money out by category over a period. income_expenses: money in and out by month over a period.

Available options:
balance_summary,
spending_summary,
income_expenses
format
enum<string> | null

pdf (the default) or csv.

Available options:
pdf,
csv
as_at
string | null

A calendar day in Sydney, as YYYY-MM-DD.

period_start
string | null

A calendar day in Sydney, as YYYY-MM-DD.

period_end
string | null

A calendar day in Sydney, as YYYY-MM-DD.

Response

Created.

object
enum<string>
required
Available options:
report
id
string
required
client_id
string
required
client_name
string
required
kind
enum<string>
required

balance_summary: every account and its balance on as_at. spending_summary: money out by category over a period. income_expenses: money in and out by month over a period.

Available options:
balance_summary,
spending_summary,
income_expenses
format
enum<string>
required
Available options:
pdf,
csv
as_at
string | null
required
period_start
string | null
required
period_end
string | null
required
page_count
number | null
required
file_name
string
required
created_by_member_id
string | null
required
created_at
string
required

An ISO 8601 time in UTC.

download_url
string | null
required

Fetches the file without a key. Works for 15 minutes; get the report again for a new one.

download_expires_at
string | null
required

An ISO 8601 time in UTC.