Get Report Parameters

This API fetches the required and optional parameters for generating reports based on a given reportTypeId. The response includes each parameter's name, type, order, required status, and available options, ensuring users have all the necessary details to generate reports accurately.

Request Parameters

Field Name	Type	Description
`reportTypeId`	integer	The unique identifier of the report type for which parameters are being retrieved.

Response Fields

Field Name	Description
`id`	The unique identifier of the report parameter.
`name`	The name of the report parameter.
`parameterType`	The type of the parameter (e.g., `DATE`, `ARRAY`, `MULTISELECT_ARRAY`, `TEXT`).
`order`	The sequence in which the parameter should be displayed.
`required`	Indicates whether the parameter is mandatory (`true`) or optional (`false`).
`options`	A list of selectable values for type `ARRAY` or `MULTISELECT_ARRAY` parameters.

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

[
  {
    "id": 8,
    "name": "START DATE",
    "parameterType": "DATE",
    "order": 1,
    "required": true,
    "options": []
  },
  {
    "id": 9,
    "name": "END DATE",
    "parameterType": "DATE",
    "order": 2,
    "required": true,
    "options": []
  },
  {
    "id": 10,
    "name": "TRANSACTION TYPE",
    "parameterType": "ARRAY",
    "order": 3,
    "required": true,
    "options": [
      "INWARD",
      "OUTWARD",
      "ALL"
    ]
  },
  {
    "id": 11,
    "name": "TRANSACTION STATUS",
    "parameterType": "ARRAY",
    "order": 4,
    "required": true,
    "options": [
      "CONFIRMED",
      "UNRESOLVED",
      "SENT_TO_GATEWAY_SUCCESS",
      "SENT_TO_GATEWAY_ERROR",
      "PENDING",
      "ALL"
    ]
  },
  {
    "id": 12,
    "name": "CLIENTS",
    "parameterType": "MULTISELECT_ARRAY",
    "order": 5,
    "required": false,
    "options": [
      {
        "id": 1,
        "name": "Sample Customer 4"
      },
      {
        "id": 2,
        "name": "Sample Customer 59"
      },
      {
        "id": 3,
        "name": "abc"
      },
      {
        "id": 4,
        "name": "Sample Organisation 24"
      },
      {
        "id": 5,
        "name": "monday street"
      },
      {
        "id": 6,
        "name": "tuesday street"
      },
      {
        "id": 7,
        "name": "Sample Customer 4"
      },
      {
        "id": 9,
        "name": "ABS Test"
      },
      {
        "id": 10,
        "name": "Sample Customer 1"
      },
      {
        "id": 11,
        "name": "Sample Customer 22"
      },
      {
        "id": 12,
        "name": "Sample Customer 32"
      },
      {
        "id": 13,
        "name": "Sample Customer 33"
      },
      {
        "id": 14,
        "name": "Sample Customer 23"
      },
      {
        "id": 15,
        "name": "Sample Customer 37"
      },
      {
        "id": 16,
        "name": "Sample Customer 39"
      },
      {
        "id": 17,
        "name": "Sample Customer 50"
      },
      {
        "id": 18,
        "name": "Sample Customer 56"
      },
      {
        "id": 19,
        "name": "Sample Customer 54"
      },
      {
        "id": 20,
        "name": "Sample Organisation 14"
      },
      {
        "id": 21,
        "name": "Sample Customer 31"
      },
      {
        "id": 22,
        "name": "abc"
      },
      {
        "id": 23,
        "name": "Sample Customer 39"
      },
      {
        "id": 24,
        "name": "Sample Customer 51"
      },
      {
        "id": 25,
        "name": "Sample Customer 26"
      },
      {
        "id": 26,
        "name": "Sample Customer 51"
      },
      {
        "id": 27,
        "name": "Sample Customer 26"
      },
      {
        "id": 29,
        "name": "Sample Organisation 18"
      },
      {
        "id": 33,
        "name": "abc"
      },
      {
        "id": 35,
        "name": "Sample Organisation 19"
      },
      {
        "id": 36,
        "name": "Sample Organisation 20"
      },
      {
        "id": 37,
        "name": "Sample Organisation 15"
      },
      {
        "id": 38,
        "name": "abc"
      },
      {
        "id": 39,
        "name": "abc"
      },
      {
        "id": 40,
        "name": "abc"
      },
      {
        "id": 41,
        "name": "abc"
      },
      {
        "id": 42,
        "name": "abc"
      },
      {
        "id": 43,
        "name": "abc"
      },
      {
        "id": 44,
        "name": "abc"
      },
      {
        "id": 45,
        "name": "Sample Customer 26"
      },
      {
        "id": 46,
        "name": "Sample Customer 41"
      },
      {
        "id": 47,
        "name": "Sample Customer 10"
      },
      {
        "id": 48,
        "name": "Sample Customer 19"
      },
      {
        "id": 49,
        "name": "MFB Test"
      },
      {
        "id": 50,
        "name": "Sample Organisation 11"
      },
      {
        "id": 51,
        "name": "Sample Organisation 5"
      },
      {
        "id": 52,
        "name": "Sample Customer 46"
      },
      {
        "id": 53,
        "name": "Sample Organisation 17"
      },
      {
        "id": 54,
        "name": "Sample Customer 48"
      },
      {
        "id": 55,
        "name": "Sample Customer 51"
      },
      {
        "id": 56,
        "name": "ajks,n"
      },
      {
        "id": 57,
        "name": "EJKFOEIRORPT"
      },
      {
        "id": 58,
        "name": "Sample Organisation 21"
      },
      {
        "id": 59,
        "name": "Sample Customer 26"
      },
      {
        "id": 60,
        "name": "Test Business"
      },
      {
        "id": 61,
        "name": "Sample Customer 51"
      },
      {
        "id": 62,
        "name": "Sample Customer 40"
      },
      {
        "id": 63,
        "name": "Sample Customer 51"
      },
      {
        "id": 64,
        "name": "Sample Customer 51"
      },
      {
        "id": 65,
        "name": "Sample Customer 51"
      },
      {
        "id": 66,
        "name": "Sample Customer 51"
      },
      {
        "id": 67,
        "name": "Sample Customer 44"
      },
      {
        "id": 68,
        "name": "Sample Customer 44"
      },
      {
        "id": 69,
        "name": "abc"
      },
      {
        "id": 70,
        "name": "abc"
      },
      {
        "id": 71,
        "name": "abc"
      },
      {
        "id": 72,
        "name": "abc"
      },
      {
        "id": 75,
        "name": "AM,NDF AS,MFNWKL"
      },
      {
        "id": 76,
        "name": "Sample Customer 53"
      },
      {
        "id": 77,
        "name": "Sample Customer 27"
      },
      {
        "id": 78,
        "name": "Sample Customer 43"
      },
      {
        "id": 79,
        "name": "Sample Organisation 23"
      },
      {
        "id": 80,
        "name": "Sample Customer 27"
      },
      {
        "id": 81,
        "name": "Sample Organisation 22"
      },
      {
        "id": 82,
        "name": "Sample Customer 67"
      },
      {
        "id": 83,
        "name": "Sample Organisation 10"
      },
      {
        "id": 84,
        "name": "Sample Organisation 16"
      },
      {
        "id": 85,
        "name": "endthistest"
      },
      {
        "id": 86,
        "name": "Sample Customer 39"
      },
      {
        "id": 87,
        "name": "Sample Customer 18"
      },
      {
        "id": 88,
        "name": "kwjdnw"
      },
      {
        "id": 89,
        "name": "Sample Customer 44"
      },
      {
        "id": 90,
        "name": "Test Business II"
      },
      {
        "id": 91,
        "name": "Sample Customer 28"
      },
      {
        "id": 93,
        "name": "Sample Customer 30"
      },
      {
        "id": 94,
        "name": "Sample Customer 27"
      },
      {
        "id": 95,
        "name": "Sample Customer 51"
      },
      {
        "id": 96,
        "name": "Sample Customer 64"
      },
      {
        "id": 98,
        "name": "Sample Customer 57"
      },
      {
        "id": 99,
        "name": "Sample Customer 14"
      },
      {
        "id": 100,
        "name": "Sample Customer 14"
      },
      {
        "id": 101,
        "name": "Sample Customer 42"
      },
      {
        "id": 102,
        "name": "Sample Customer 38"
      },
      {
        "id": 103,
        "name": "Sample Customer 61"
      },
      {
        "id": 104,
        "name": "Sample Customer 52"
      },
      {
        "id": 106,
        "name": "Sample Customer 35"
      },
      {
        "id": 107,
        "name": "Sample Customer 36"
      },
      {
        "id": 108,
        "name": "Sample Customer 34"
      },
      {
        "id": 109,
        "name": "Sample Customer 24"
      },
      {
        "id": 110,
        "name": "Sample Customer 20"
      },
      {
        "id": 111,
        "name": "Sample Customer 47"
      },
      {
        "id": 113,
        "name": "Sample Customer 49"
      },
      {
        "id": 114,
        "name": "Sample Customer 49"
      },
      {
        "id": 115,
        "name": "Sample Customer 29"
      },
      {
        "id": 116,
        "name": "Sample Customer 63"
      },
      {
        "id": 118,
        "name": "Sample Organisation 6"
      },
      {
        "id": 120,
        "name": "Sample Customer 21"
      },
      {
        "id": 121,
        "name": "Director Test 1"
      },
      {
        "id": 124,
        "name": "D1 E1"
      },
      {
        "id": 127,
        "name": "Sample Organisation 8"
      },
      {
        "id": 129,
        "name": "Sample Customer 14"
      },
      {
        "id": 130,
        "name": "Sample Customer 14"
      },
      {
        "id": 132,
        "name": "Sample Customer 25"
      },
      {
        "id": 134,
        "name": "Sample Customer 25"
      },
      {
        "id": 135,
        "name": "Sample Customer 14"
      },
      {
        "id": 137,
        "name": "Sample Customer 25"
      },
      {
        "id": 138,
        "name": "Sample Customer 45"
      },
      {
        "id": 141,
        "name": "Sample Organisation 8"
      },
      {
        "id": 142,
        "name": "Sample Organisation 8"
      },
      {
        "id": 146,
        "name": "Sample Customer 65"
      },
      {
        "id": 149,
        "name": "Tech start up"
      },
      {
        "id": 151,
        "name": "Sample Organisation 8"
      },
      {
        "id": 152,
        "name": "Sample Customer 66"
      },
      {
        "id": 157,
        "name": "Sample Customer 65"
      },
      {
        "id": 158,
        "name": "Sample Customer 65"
      },
      {
        "id": 160,
        "name": "Test Tester"
      },
      {
        "id": 161,
        "name": "Sample Customer 14"
      },
      {
        "id": 163,
        "name": "Sample Customer 58"
      },
      {
        "id": 165,
        "name": "Sample Customer 60"
      },
      {
        "id": 166,
        "name": "Sample Customer 62"
      },
      {
        "id": 167,
        "name": "Sample Customer 14"
      },
      {
        "id": 171,
        "name": "Sample Customer 16"
      },
      {
        "id": 173,
        "name": "Sample Customer 66"
      },
      {
        "id": 175,
        "name": "Sample Customer 15"
      },
      {
        "id": 179,
        "name": "Sample Customer 45"
      },
      {
        "id": 180,
        "name": "Sample Customer 55"
      },
      {
        "id": 181,
        "name": "Sample Customer 66"
      },
      {
        "id": 183,
        "name": "Sample Customer 66"
      }
    ]
  },
  {
    "id": 13,
    "name": "SAVINGS ACCOUNTS",
    "parameterType": "TEXT",
    "order": 5,
    "required": false,
    "options": []
  },
  {
    "id": 14,
    "name": "VIRTUAL ACCOUNTS",
    "parameterType": "TEXT",
    "order": 5,
    "required": false,
    "options": []
  }
]

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Request Parameters#

Response Fields#

Request

Request Code Samples

Responses

Request Parameters

Response Fields