Skip to main content
POST
/
report
/
generate
curl --request POST \
  --url https://operator-financial-reporting.staging.ezprk.dev/report/generate \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "operatorId": 123,
  "reportFormat": "JSON",
  "startDate": "2025-01-14",
  "endDate": "2025-01-15",
  "additionalFields": [
    "CUSTOMER_PHONE",
    "EMAIL"
  ]
}
'
{
  "message": "Your task to generate report has been accepted. Check for the report status after 60 seconds.",
  "retryAfter": 60,
  "_links": {
    "self": {
      "href": "https://operator-financial-reporting.staging.ezprk.dev/report/generate/{reportIdentifier}"
    }
  }
}

Authorizations

​
X-Authorization
string
header
required

For the header value, use the format: Bearer YOUR-JWT-TOKEN. You can get the token from the auth/v1 endpoint.

Body

application/json

Request body containing parameters for report generation

Report generation request parameters

​
operatorId
integer<int64>
required

The ID of the operator for which the report is being generated

​
reportFormat
enum<string>
required

The format of the report

Available options:
JSON,
CSV
​
startDate
string<date>
required

The start date of the data period for the report (format yyyy-MM-dd)

Example:

"2025-01-14"

​
endDate
string<date>
required

The end date of the data period for the report (format yyyy-MM-dd)

Example:

"2025-01-15"

​
additionalFields
enum<string>[]

Additional fields to include in the report

Available options:
ORDER_ID,
SUPPLIER_NAME,
CLIENT_ID,
CUSTOMER_PHONE,
EMAIL,
LPN,
LPN_STATE,
PROMOTION_CODE,
CLEARING_PERIOD,
PAYMENT_ID,
PAYMENT_REFERENCE,
PAYMENT_AMOUNT_VAT_AMOUNT,
PARKING_AMOUNT,
PARKING_AMOUNT_INITIAL,
PARKING_AMOUNT_VAT_AMOUNT,
TRANSACTION_FEE,
TRANSACTION_FEE_INITIAL,
TRANSACTION_FEE_VAT_AMOUNT,
IS_EXTENSION,
VAT_PERCENTAGE,
CURRENCY,
PAID_MINUTES,
INSERT_DATE,
CREDIT_CARD_TYPE,
MASKED_CARD_NUMBER,
CREDIT_CARD_ZIP,
START_PARKING_ON_LOCAL,
STOP_PARKING_ON_LOCAL,
DURATION_IN_MINUTES,
TIME_ZONE,
COUNTRY_CODE,
ZONE_ID,
ZONE_DESCRIPTION,
LOCATION,
STATION,
DEPARTMENT_LOCATION,
SPACE_NUMBER,
PARKMOBILE_PARKING_DISCOUNT,
PARKMOBILE_TRANSACTION_FEE_DISCOUNT,
CLIENT_PARKING_DISCOUNT,
CLIENT_TRANSACTION_FEE_DISCOUNT,
GROUPED_PARKING_RIGHT_ID,
IS_MULTI_TIER,
PRODUCT_TYPE,
EXTERNAL_PARKING_ACTION_ID,
CONTRACT_OWNER,
MARKET_FACILITATOR,
CITY_TAX,
COUNTY_TAX,
STATE_TAX,
VIRTUAL_ACCESS_CODE,
ADD_ON,
VENUE_NAME,
EVENT_NAME,
STATUS,
RECONCILIATION_ID,
WAIVED_FEE_EXCL_TAX,
WAIVED_FEE_TAX,
WAIVED_FEE_INCL_TAX

Response

202 - application/hal+json

The API link to check the report generation status which has the report identifier. It also returns the time to wait before checking the status