Create a ReportGenerateRequest | Solvimon

curl -X POST https://api.solvimon.com/v1/report-generate-requests \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "generate_at": "2024-01-15T09:30:00Z",
  "report_code": "INVOICE",
  "parameter_values": [
    {
      "name": "report_date",
      "value": "string"
    }
  ],
  "report_configuration_id": "string"
}'

{
  "generate_at": "2024-01-15T09:30:00Z",
  "report_code": "INVOICE",
  "parameter_values": [
    {
      "name": "report_date",
      "value": "string"
    }
  ],
  "report_configuration_id": "string",
  "id": "string",
  "customer_id": "string",
  "invoice_id": "string",
  "status": "string",
  "report_subscription_id": "string",
  "run_type": "string",
  "export_location": {
    "integration_id": "string",
    "variant": "BIGQUERY",
    "stream_name": "string",
    "bigquery": {
      "dataset_id": "string"
    },
    "s3": {
      "bucket_path": "string",
      "path_format": "string",
      "format_type": "CSV"
    },
    "gcs": {
      "bucket_path": "string",
      "path_format": "string",
      "format_type": "CSV"
    }
  }
}

Requires the REPORT_GENERATE_REQUEST.CREATE permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1

version

Request

This endpoint expects an object.

generate_atdatetimeRequired

report_codeenumRequired

parameter_valueslist of objectsRequired

report_configuration_idstringRequired

Resource ID of type REPORT_CONFIGURATION

customer_idstring or nullOptional

Resource ID of type CUSTOMER

invoice_idstring or nullOptional

Resource ID of type INVOICE

report_subscription_idstring or nullOptional

export_locationobjectOptional

Response

Created

generate_atdatetime

report_codeenum

parameter_valueslist of objects

report_configuration_idstring

Resource ID of type REPORT_CONFIGURATION

idstring or nullRead-only

customer_idstring or null

Resource ID of type CUSTOMER

invoice_idstring or null

Resource ID of type INVOICE

statusstring or nullRead-only

report_subscription_idstring or null

run_typestring or nullRead-only

export_locationobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors