Update a report configuration | Solvimon

curl -X PATCH 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"
  ]
}'

{
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "report_code": "INVOICE",
  "report_definition": {
    "report_code": "INVOICE",
    "category": "FINANCIAL",
    "name": "Monthly Invoice Report",
    "description": "Generates detailed invoices for customers on a monthly basis",
    "file_name_format": "invoice_report_{date}.csv",
    "run_types": [
      "SCHEDULED",
      "ON_DEMAND"
    ],
    "target_resource_types": [
      "CUSTOMER_ACCOUNT",
      "INVOICE"
    ],
    "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": "report_date",
        "type": "DATE",
        "required": true
      }
    ],
    "scheduled_parameters": [
      {
        "name": "report_date",
        "type": "DATE",
        "required": true
      }
    ],
    "trigger_parameters": [
      {
        "name": "report_date",
        "type": "DATE",
        "required": true
      }
    ]
  },
  "override_columns": [
    "customer_name"
  ],
  "available_custom_field_columns": [
    {
      "name": "customer_loyalty_level",
      "custom_field": {
        "object_type": "CUSTOMER",
        "id": "cf1234567890",
        "reference": "LOYALTY_LEVEL",
        "name": "Loyalty Level",
        "description": "Customer loyalty program tier",
        "resource_type": "CUSTOMER_ACCOUNT",
        "multiple_values": false,
        "unique_value": true,
        "copy_value_to_invoice": true,
        "integration_id": "intg987654321",
        "integration_reference": "LOYALTY_PROGRAM",
        "type": "ENUM",
        "enum_values": [
          "Bronze",
          "Silver",
          "Gold",
          "Platinum"
        ]
      }
    }
  ]
}

Requires the REPORT.CONFIGURATION.UPDATE 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

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Request

This endpoint expects an object.

report_codeenumOptional

report_definitionobject or nullOptional

override_columnslist of stringsOptional

Response

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

Authentication

Path parameters

Headers

Request

Response

Errors