Reports
Api for getting tax and FIP reports
Get a report from FIP as a CSV-file, between fromDate and toDate by setting ?format=csv
query Parameters
fromDatetoDateuseCreatedAtcompanyIdFilter report by company. If null all companies are reported
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get a report from FIP as a CSV-file, between fromDate and toDate by setting ?format=csv › Responses
OK
employeeNoEmployee number
companyCompany id
ticketNoTicket number
issueDateIssued date
validFromThe date the ticket is valid from
Travel type
validUntilThe date the ticket is valid to
FIP ticket type
Get a CSV report containing all FIP coupons and travel discount certificates created in specified year.
query Parameters
companyIdyearYear from 2021.
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get a CSV report containing all FIP coupons and travel discount certificates created in specified year. › Responses
OK
Get a tax savings report for a given month and year for requested company.
Get a tax savings report for a given month and year for requested company.Parameters fromDate and toDate are deprecated, use month and year
query Parameters
companyIdfromDateDeprecated. Use year and month
toDateDeprecated. Use year and month
yearYear from 2021. Default current year
monthMonth, from 1 to 12. Default current month
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get a tax savings report for a given month and year for requested company. › Responses
OK
Start the progress or get status for generating a tax savings report for a given month and year for requested company.
query Parameters
companyIdyearYear from 2021. Default current year
monthMonth, from 1 to 12. Default current month
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Responses
Accepted
startedWhen the report generation started
progressHow far the generation has progressed in percent from 0 to 100
errorError if the report generation fails
finishedWhen the report generation finished
Get a CSV report of apprentice ticket rights for a year
query Parameters
yearYear from 2021.
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get a CSV report of apprentice ticket rights for a year › Responses
OK
Get a CSV report of stop place ticket rights for a year
query Parameters
yearYear from 2021.
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get a CSV report of stop place ticket rights for a year › Responses
OK
Get total saving value for tax savings report for specified month
query Parameters
companyIdyearYear from 2021
monthMonth, from 1 to 12
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get total saving value for tax savings report for specified month › Responses
OK
Get list of active ticket right holders for a company as a CSV
query Parameters
companyIdpageperPageticketRightTypeticketRightHolderTypeincludeFamilyHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get list of active ticket right holders for a company as a CSV › Responses
OK
All items for this page
totalItemsTotal items which could be returned
totalPagesTotal number of pages