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",
  "override_columns": [
    "customer_name",
    "invoice_total"
  ]
}'

{
  "report_code": "INVOICE",
  "override_columns": [
    "customer_name",
    "invoice_total"
  ],
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "report_definition": {
    "report_code": "INVOICE",
    "category": "INVOICE",
    "name": "Standard Invoice Report",
    "description": "Detailed report of invoices including customer and payment information",
    "file_name_format": "invoice_report_{date}.csv",
    "run_types": [
      "DAILY",
      "MONTHLY"
    ],
    "target_resource_types": [
      "INVOICE",
      "CUSTOMER"
    ],
    "columns": [
      {
        "name": "invoice_id",
        "order": 1,
        "default": true,
        "optional": false
      },
      {
        "name": "customer_name",
        "order": 2,
        "default": true,
        "optional": false
      },
      {
        "name": "invoice_total",
        "order": 3,
        "default": true,
        "optional": true
      }
    ],
    "one_off_parameters": [
      {
        "name": "report_date",
        "type": "LOCALE_DATE",
        "required": true
      }
    ],
    "scheduled_parameters": [
      {
        "name": "from_date",
        "type": "LOCALE_DATE",
        "required": true
      },
      {
        "name": "to_date",
        "type": "LOCALE_DATE",
        "required": true
      }
    ],
    "trigger_parameters": [
      {
        "name": "invoice_id",
        "type": "INVOICE_ID",
        "required": true
      }
    ]
  },
  "available_custom_field_columns": [
    {
      "name": "custom_invoice_note",
      "custom_field": {
        "reference": "customInvoiceNote",
        "resource_type": "INVOICE",
        "integration_id": "intg-987654321",
        "integration_reference": "custom_invoice_note_ref",
        "object_type": "Invoice",
        "id": "cf1234567890",
        "name": "Custom Invoice Note",
        "description": "Additional notes added to the invoice",
        "multiple_values": false,
        "unique_value": false,
        "copy_value_to_invoice": true,
        "type": "STRING",
        "enum_values": []
      }
    }
  ]
}

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

Request

This endpoint expects an object.

report_codeenumRequired

override_columnslist of stringsRequired

report_definitionobject or nullOptional

Response

Created

report_codeenum

override_columnslist of strings

idstring or nullRead-only

report_definitionobject or null

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

Authentication

Path parameters

Headers

Request

Response

Errors