Transaction APIReports

Create a ReportGenerateRequest

Requires the REPORT_GENERATE_REQUEST.CREATE 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

Headers

x-platform-idstringOptional
Platform ID.

Request

This endpoint expects an object.
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
report_subscription_idstring or nullOptional
report_configuration_idstringOptional

Resource ID of type REPORT_CONFIGURATION

export_locationobjectOptional

Response

Created
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
409
Conflict Error
500
Internal Server Error