Company statements
Retrieve a statement
GET
/
company_statements
/
{id}
/
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
id
string
requiredObject ID (UUID)
Response
200 - application/json
format
string
Statement format, available formats: csv
, xlsx
.
Maximum length:
32
timezone
string
Timezone to localize statement-specific timestamps
is_test
boolean
Indicates this is a test object, created using test API keys or using Billing section of UI while in test mode.
company_uid
string
ID of the Company.
query_string
string
Query parameters used to generate statement.
status
string
Status of statement generation e.g. pending
, processing
, success
.
download_url
string
Download URL of a statement.
began_on
integer
Date and time for the beginning of statement generation process.
finished_on
integer
Date and time for finishing the statement generation process.
created_on
integer
Object creation time
updated_on
integer
Object last modification time
type
string
Statement request type
id
string
ID of a statement