Get ReportConfiguration | Solvimon

curl https://test.api.solvimon.com/v1/report-configurations/ \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json"

{
  "report_code": "INVOICE",
  "override_columns": [
    "Discount Amount",
    "Tax Amount"
  ],
  "id": "a3f47b2e-9c4d-4f1a-8b2e-7d9f3c1a2b4e",
  "report_definition": {
    "report_code": "INVOICE",
    "category": "INVOICE",
    "name": "Monthly Invoice Summary",
    "description": "Summary report of all invoices generated monthly",
    "file_name_format": "invoice_summary_{YYYYMM}.csv",
    "run_types": [
      "scheduled",
      "manual"
    ],
    "target_resource_types": [
      "customer_account",
      "billing_record"
    ],
    "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
      },
      {
        "name": "Total Amount",
        "order": 4,
        "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
      }
    ]
  },
  "available_custom_field_columns": [
    {
      "name": "Customer Loyalty Tier",
      "custom_field": {
        "reference": "loyalty_tier",
        "resource_type": "PLATFORM",
        "integration_id": "int_7890",
        "integration_reference": "loyalty_program",
        "object_type": "customer_account",
        "id": "cf_123456",
        "name": "Loyalty Tier",
        "description": "Customer loyalty program tier",
        "multiple_values": false,
        "unique_value": true,
        "copy_value_to_invoice": false,
        "type": "STRING",
        "enum_values": [
          "Bronze",
          "Silver",
          "Gold",
          "Platinum"
        ]
      }
    },
    {
      "name": "Preferred Contact Method",
      "custom_field": {
        "reference": "contact_method",
        "resource_type": "PLATFORM",
        "integration_id": "int_7891",
        "integration_reference": "contact_preferences",
        "object_type": "customer_account",
        "id": "cf_654321",
        "name": "Preferred Contact Method",
        "description": "Customer's preferred method of contact",
        "multiple_values": false,
        "unique_value": true,
        "copy_value_to_invoice": false,
        "type": "STRING",
        "enum_values": [
          "Email",
          "Phone",
          "SMS"
        ]
      }
    }
  ]
}

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

Response

report_codeenum

override_columnslist of strings

idstring or nullRead-only

report_definitionobject or null

available_custom_field_columnslist of objects or nullRead-only

Errors

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors