Create a report configuration | Solvimon

curl -X POST https://test.api.solvimon.com/v1/report-configurations \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "report_code": "INVOICE"
}'

{
  "object_type": "report_configuration",
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "report_code": "INVOICE",
  "report_definition": {
    "object_type": "report_definition",
    "report_code": "INVOICE",
    "category": "INVOICE",
    "name": "Standard Invoice Report",
    "description": "Detailed report of invoices including line items and taxes",
    "file_name_format": "invoice_report_{date}.csv",
    "run_types": [
      "manual",
      "scheduled"
    ],
    "target_resource_types": [
      "INVOICE",
      "CUSTOMER"
    ],
    "columns": [
      {
        "name": "Invoice Number",
        "order": 1,
        "default": true,
        "optional": false
      },
      {
        "name": "Customer Name",
        "order": 2,
        "default": true,
        "optional": false
      },
      {
        "name": "Invoice Date",
        "order": 3,
        "default": true,
        "optional": false
      }
    ],
    "one_off_parameters": [
      {
        "name": "from_date",
        "type": "LOCALE_DATE",
        "required": true
      },
      {
        "name": "to_date",
        "type": "LOCALE_DATE",
        "required": true
      }
    ],
    "scheduled_parameters": [
      {
        "name": "report_date",
        "type": "LOCALE_DATE",
        "required": true
      }
    ],
    "trigger_parameters": [
      {
        "name": "invoice_id",
        "type": "INVOICE_ID",
        "required": true
      }
    ]
  },
  "override_columns": [
    "Discount Amount",
    "Tax Amount"
  ],
  "available_custom_field_columns": [
    {
      "name": "Customer Segment",
      "custom_field": {
        "object_type": "custom_field",
        "id": "cf1234567890",
        "reference": "customer_segment",
        "name": "Customer Segment",
        "description": "Segment classification of the customer",
        "resource_type": "CUSTOMER",
        "multiple_values": false,
        "unique_value": false,
        "copy_value_to_invoice": false,
        "integration_id": "intg987654321",
        "integration_reference": "segment_integration",
        "type": "ENUM",
        "enum_values": [
          "Retail",
          "Wholesale",
          "Enterprise"
        ]
      }
    }
  ]
}

Requires the REPORT_CONFIGURATION.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

Headers

x-platform-idstringOptional

Platform ID.

Request

This endpoint expects an object.

report_codeenumRequired

report_definitionobject or nullOptional

override_columnslist of stringsOptional

Response

Created

object_typestring or nullRead-only

idstring or nullRead-only

report_codeenum

report_definitionobject or null

override_columnslist of strings

available_custom_field_columnslist of objects or nullRead-only

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error