Initiate report generation

Generates a report based on the provided parameters. Requested data period must not be older than 14 months from current date.

Required fields

Mandatory fields to be passed in the request body:
Field Type Description
operatorId integer The ID of the operator for which the report is being generated
reportFormat string The format of the report (JSON or CSV)
startDate string The start date of the data period for the report (yyyy-MM-dd)
endDate string The end date of the data period for the report (yyyy-MM-dd)

Additional fields

Following fields (columns) can be requested by passing them to the `additionalFields` parameter in the request body.
Field Description
ORDER_ID Invoice billing ID
SUPPLIER_NAME Name of the parking operator
CLIENT_ID EPIC customer ID or parkmobile user id
CUSTOMER_PHONE Phone number of the user
EMAIL Email of the user
CLEARING_PERIOD The settlement date in YYYYMM format
PAYMENT_ID ID for the parking
PAYMENT_REFERENCE Payment service provider reference
PAYMENT_AMOUNT_VAT_AMOUNT VAT of the payment amount that the consumer payed. The total sum of VAT amounts
PARKING_AMOUNT Parking amount from payment parking
PARKING_AMOUNT_INITIAL Parking_amount incl. VAT. Defined as the total parking_fee excl all credits and discounts. Also excluding reinvoicing so there should only be one record per parking
PARKING_AMOUNT_VAT_AMOUNT Parking VAT amount from payment parking
TRANSACTION_FEE Transaction fee amount from payment parking
TRANSACTION_FEE_INITIAL Transaction fee incl. VAT. Used in remittance report
TRANSACTION_FEE_VAT_AMOUNT Transaction fee VAT amount from payment parking
IS_EXTENSION Whether the transaction is an extension or an initial parking
VAT_PERCENTAGE VAT percentage from payment parking, applicable in Canada/Europe
CURRENCY Currency used for the parking transaction
PAID_MINUTES How many minutes the user paid for parking
INSERT_DATE Invoice billing insert time local
CREDIT_CARD_TYPE Type of credit card used for payment. Amex, Discover, MasterCard, N/A, PayPal, VISA, Wallet
MASKED_CARD_NUMBER Masked card number used for payment
CREDIT_CARD_ZIP Zip code of the credit card
TIME_ZONE Time zone from payment parking
COUNTRY_CODE Supplier country abbreviation
ZONE_ID ID associated with the parking zone
ZONE_DESCRIPTION Description of the zone (typically city, state)
LOCATION Concatenated location info from station, department_location, station_label, and department_location_label
STATION Zone attribute value
DEPARTMENT_LOCATION Zone attribute value
SPACE_NUMBER Parking space number
PARKMOBILE_PARKING_DISCOUNT Represent the discount offered by EasyPark on parking fee and the user can see the discount
PARKMOBILE_TRANSACTION_FEE_DISCOUNT Represent the discount offered by EasyPark on transaction fee and the user can see the discount
CLIENT_PARKING_DISCOUNT Represent the discount offered by the supplier on parking fee and the user can see the discount
CLIENT_TRANSACTION_FEE_DISCOUNT Represent the discount offered by the supplier on transaction fee and the user can see the discount
GROUPED_PARKING_RIGHT_ID ID of multiple transactions that are part of a session grouping
IS_MULTI_TIER Indicates whether a transaction has applied tiered pricing
Securityjwt
Request
Request Body schema: application/json

Request body containing parameters for report generation

operatorId
required
integer <int64>

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

reportFormat
required
string

The format of the report

Enum: "JSON" "CSV"
startDate
required
string <date>

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

endDate
required
string <date>

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

additionalFields
Array of strings

Additional fields to include in the report

Items Enum: "ORDER_ID" "SUPPLIER_NAME" "CLIENT_ID" "CUSTOMER_PHONE" "EMAIL" "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" "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"
Responses
202

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

post/report/generate
Request samples
application/json

Example of a report generation request. The report will be generated in JSON format, for the operator 123, for the period between 2025-01-14 and 2025-01-15, with additional fields CUSTOMER_PHONE and EMAIL.

{
  • "operatorId": 123,
  • "reportFormat": "JSON",
  • "startDate": "2025-01-14",
  • "endDate": "2025-01-15",
  • "additionalFields": [
    • "CUSTOMER_PHONE",
    • "EMAIL"
    ]
}
Response samples
application/hal+json

The report generation has been accepted and the user can check the status after 60 seconds.

{}