reportSubscriptions

Trigger ReportSubscription by resourceId

Requires the REPORT_GENERATE_REQUEST.CREATE permission.

post/v{version}/report-subscriptions/{resourceId}/trigger

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/report-subscriptions/{resourceId}/trigger
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

resourceIdstring required

The ID of the resource for which the action is posted.

Headers

x-platform-idstring

Platform ID.

Request body

Response

Created

object_typestring nullable
idstring nullable
customer_idstring nullable

Resource ID of type CUSTOMER

invoice_idstring nullable

Resource ID of type INVOICE

generate_atstring date-time
report_code'INVOICE' | 'INVOICE_USAGE' | 'INVOICE_HEADER' | 'INVOICE_LINE' | 'INVOICE_TAX' | 'INVOICE_COMMITMENT' | 'E_INVOICING' | 'CHILD_PARENT_BREAKDOWN' | 'CHILD_PARENT_BREAKDOWN_PLATFORM' | 'NOT_MATCHED_METER_DATA' | 'DUPLICATE_METER_DATA' | 'METERING' | 'CUSTOMER' | 'PRODUCT' | 'PRICING_PLAN_SUBSCRIPTION' | 'PAYMENT' | 'PRICING' | 'REVENUE_RECOGNITION' | 'CLAUSES' | 'REPROCESS'
statusstring nullable
report_subscription_idstring nullable
report_configuration_idstring

Resource ID of type REPORT_CONFIGURATION

run_typestring nullable
format'CSV' | 'JSON_LINES' | 'PARQUET' | 'AVRO'

Changes

No recorded changes to this operation across all 1 revision of this API.