Transaction APIReports

Get ReportGenerateRequest

Requires the REPORT_GENERATE_REQUEST.VIEW permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1
version
resourceIdstringRequiredDefaults to
The ID of the resource to be requested.

Headers

x-platform-idstringOptional
Platform ID.

Response

OK
object_typestring or nullOptionalRead-only
idstring or nullOptionalRead-only
customer_idstring or nullOptional
Resource ID of type CUSTOMER
invoice_idstring or nullOptional
Resource ID of type INVOICE
generate_atdatetimeOptional
report_codeenumOptional
parameter_valueslist of objectsOptional
statusstring or nullOptionalRead-only
report_subscription_idstring or nullOptional
report_configuration_idstringOptional

Resource ID of type REPORT_CONFIGURATION

run_typestring or nullOptionalRead-only
export_locationobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error