Skip to main content
GET
List invoices and receipts

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

Query Parameters

document_type
string

Restrict to invoices or receipts.

status
string

Restrict by status.

from
string

Only documents at or after this ISO-8601 time.

to
string

Only documents at or before this ISO-8601 time.

page
integer
default:1

The page parameter

Response

Success

schema_version
string

Version of this payload's shape.

account_id
integer

The account.

load_state
string

loaded or empty.

freshness
object

Where this answer came from and how current it is. Billing reads several systems, so every response says which one it used — treat state other than fresh as a reason to be careful with the numbers rather than a failure.

filters
object

The filters in force, echoed back.

invoices
object[]

Invoices and receipts, newest first.

pagination
object

Page, per-page, totals and has_more.