Schemas

When the contract consumer was created

Which client created the contract consumer

The customer entitled to use the contract. Unique Entur specific number

The organisation ID the customer belongs to

Marks that this specific user has been disallowed from using this contract by the contract owner

Marks that this specific user's organisation is the owner of the contract

When the contract consumer was last changed

Which client changed the contract consumer last

The customer entitled to use the contract. External reference unique to organisation

The id of the contract consumed

The customer attempting to consume the contract

The id of the product consumed. This is on NetEX format and must match the product in use by the supplied contract.

The start date and time of travel.

The number of coupons consumed. Has no effect if the contract does not specify a number of available coupons. Defaults to 1.

The version of the product consumed. This is on NetEX format and if supplied must match the product version in use by the supplied contract.

The end date and time of travel. Defaults to firstTravelDate if not provided.

The order line reference. This is used to check if consumption has already been validated.

From when the contract can be consumed

When the contract was created

Which client created the contract

When the contract was last changed

Which client changed the contract last

The current values for a loyalty program

Which organisation the contract concerns

The contract status. A normal contract has status valid. It can be expired, refunded, cancelled, misused and valid

Unique contract identifier

When the contract was accepted by the customer

The list of customers allowed to use the contract

How many coupons the contract has. Default is cascaded from Loyalty Program Version. If set, the contract will be blocked for usage when all coupons are used. Coupons are registered via an OrderLineEvent.

The current total for this contract (earn/burn or giftcard)

When the contract expires

Optional external reference. Examples are membership number and employee number

A list of order line events related to this contract

If present, contract UUID of the parent contract. This field is usually set if the contract is created by a coupon usage, whereas this contract has a time constraint and the parent has a coupon constraint.

The list of keys validated against the customer claiming the contract

The remaining coupons for coupon based contracts. Derived from couponsLimit and orderLineEvents. The amount of remaining coupons are counted yearly and based of the earliest travel date.

If present, contains timed contracts that are dependent on this contract. See Contract response

The list of transactions for this contract (earn/burn or giftcard)

Default number of how many coupons can be used. May be overridden by contract coupon limit

The loyalty program the contract created by the coupon is connected to

The default start time of the contract created by a coupon usage. If set, the contract created by a coupon usage will start on the specified time of the travel date or when created

The duration of the of the contract created by a coupon usage. If set, the contract created by a coupon usage will set expiration date to the end of the duration. It will override loyalty program usageValidityPeriod

When the error occurred.

The http status code.

The http status reason.

The request URI.

The main error message.

The unique correlation id for the request.

Application specific error code

Optional list of error specifications.

The field of the associated object in the request related to the error.

The message explaining why the error occurred.

A list of rejected values.

When the loyalty program was created

Which client created the loyalty program

Loyalty program description. Supports any kind of text

What language the description is written in, ISO639-3

When the loyalty program was last changed

Which client changed the loyalty program last

Display name for loyalty program

A list of human readable descriptions in different languages. Only one language per description is allowed.

The end date of the loyaltyprogram. All contracts will expire when the loyaltyprogram expires. Supports ISO 8601 date format.

The id of the loyalty program

A human readable internal description of the loyalty program.

The type of loyalty program. Types include COUPONS, TIMED and POINTS. A time-based loyalty program specifies a duration a connected contract is valid. A point-based loyalty program has contracts keeping track of earning and burning of points. This also includes gift cards. A coupon-based loyalty programs specifies how many times a contract can be consumed. For compatibility reasons, UNMAPPED is also available for loyalty programs that has not yet been classified.

The organisation that owns this loyalty program.

The id of the product associated with this loyalty program.

The version of the product associated with this loyalty program.

The start date of the loyaltyprogram. If specified ahead in time, the loyaltyprogram will get status = draft. Supports ISO 8601 date format.

The current status of this loyalty program. Can be DRAFT, CURRENT, DEPRECATED

The version of this loyalty program.

Configuration for coupons. This is only set for loyalty program type COUPONS

Deprecated. See couponConfig instead. How many coupons (eg. the maximum amount of usages) the underlying contracts of the loyalty program has.

A word or code the customer can use to activate a loyalty program for themselves, set by the creator of the loyalty program

The duration of a contract associated with this loyaltyprogram. This is set for loyalty program types TIMED and POINTS. The default value is null, which means the contract has an unlimited duration. This field uses the ISO 8601 duration format and accept the units: Days and Time. For example; 'P3DT12H30M5S' represents a duration of three days, twelve hours, thirty minutes, and five seconds.

The order line event type. Can be one of 'PURCHASE' or 'CANCELLATION'. PURCHASE is used when the order line event describe purchase of a travel using a contract (not the same as isPurchased). CANCELLATION is when the order line event is a cancellation (can be the same as isCancelled)

Whether the order line event is a cancellation

Whether the order line event describes the purchase of a contract, or contract consumer

The order ID

The order line ID

The order line version

The organisation through which the order was placed

The actual paid price for this item, i.e. what did the user actually pay after rebate. Negative if this was a cancellation

When the order line event was saved

Codespace

How many coupons (usages) this event is using. This defaults to 1, but will be ignored if the contract in question does not use coupons.

If set, the effective date for cancellation.

The last date of travel, related to entitlement usage. Defaults to equal travelDate. Relevant for period tickets only.

If the order line is added manually, this field will have an explanation

The name of the product that this usage refers to. This should be supplied by the caller to indicate which item has been bought. This is displayed to the user in reports.

The original price for this item, i.e. i.e the original price without the travellers discount.

Tax savings for this order line

The first date of travel on this ticket. Will be used to decide when to report this usage to the Norwegian tax administration, if applicable. Defaults to the current date and time.

The Order id, used for lookup when trying to find the order in Enturs systems.

The order line Id for Entur orders.

All items for this page

Total items which could be returned

Total number of pages

Id of the policy

Key for which field that should be matching

If set, the tax distribution saving for that month is unknown. This is the case for all period tickets before may 2021. They need to be calculated manually

The month of the tax saving

The value of tax saved

The year of the tax saving

Amount amount. Format: -?\d*.\d\d Examples: 123.34 1.00 34000.00

When the amount was calculated

Currency of the amount

How much was the amount changed by this transaction? Positive value means deposit onto the card, negative withdrawal. Example: -130.00

Currency used in this transaction. Only one currency is allowed for all transactions on a single contract.

Timestamp for this transaction.

Identifying sellers email for this transaction.

External transaction id for the ongoing transaction.

Internal unique identifier for this transaction.

Identifying point of sale for this transaction.

External RRN for the payment.

A list of consumptions to verify

A code pertaining to the reason for rejection, if any. Code 3101 = OK.

True if all consumptions were valid, otherwise false

A short message detailing the reasoning behind the status.

The customerNumber for the customer now claiming the personnel ticket

Whether the claim was successful

The code of the personnel ticket to claim

The customerNumber referring to the customer who claims the personnel ticket

Id of the product connected to the contracts loyalty program

Version of the product connected to the contracts loyalty program

Contract UUID, used to identify a contract

Contract owner customer number

Contract owners first and last name

Contract consumable from date

Passenger category.

Display name for loyalty program

External contract reference if set.

Contract owners birth day

Contract expiration date

If present, contract UUID of the parent contract. This field is usually set if the contract is created by a coupon usage, whereas this contract has a time constraint and the parent has a coupon constraint.

Remaining coupons connected to the contract

How many coupons the contract has. Default is cascaded from Loyalty Program Version. If set, the contract will be blocked for usage when all coupons are used. Coupons are registered via an OrderLineEvent.

If present, a ticket is included in this right. It may be distributed or redistributed to this device.

Language code according to ISO 639-3

Text localized to the language given in languageCode

Loyalty program description. Supports any kind of text

The first name of the ticket holder

The surname of the ticket holder

The employee number

The id of the company

If the ticket holder is an employee or a family member

Type of the ticket right, possible values are 'bronse' and 'sølv'

When the ticket right was granted

Type of the ticket holder, possible values are 'Ansatt', 'Pensjonist' and 'Familie'

The hire end date for pensioners

Postal address line

Postal code

City in postal address

The company ID

The company name

The company postal address

The company postal code

A prefix to be prepended to all employee numbers connected to this company

Whether local employees are allowed

Whether the company allows the usage of e-tickets for its personnel tickets

Whether the company is deleted

Which character to separate elements within tax report: ','(default) or ';'

The year this category is valid

A personnel ticket product

Whether proof of disability has been registered

The year this information is valid for

Whether a disability proof has been registered this year

The id of the employee

Employee number

The employee's first name

The employee's surname

The employee's postal code

Whether the employee has been marked for deletion

The employee's ticket holder code

Companies are where employees are hired

Employment type. Examples include Employee, Part time, Temp

When the employee was born

The employee's social security number

The employee's postal address

A personnel ticket product

Whether a ticket should be created

When the employee was hired

Pay type - see the codes in the API documentation

When the employee left the company

Why the employee left the company

The employee's degree of disability. Default 0.

Employment percentage

Date for registered employment percentage

The pay level. This is calculated based on the employment percentage and the type of employment. Typically holds the same value as employment percentage, unless special circumstances apply

When the employee starts a leave

Any additional information

When the imported employee was last updated

The source for the last update

The employee's family members

The employee's ticket rights

The date of creation.

The source for the first creation

The registered categories on this employee

The status of yearly fees for the current and the next year

The status of disability proofs for the current and the next year

The employees customer number in ESS. Note this profile is owned by JBD and is the profile connected to the ticket right. A 'null'-value here may indicate that the ticket right is not yet synced to ESS.

Whether this yearly fee has been paid

The year this fee is valid

Whether this yearly fee has been paid

The code used for input

A description of the particular code's meaning

The code used for input

A description of the particular code's meaning

Year of registered low income

Whether low income is registered

The ID of the family member

The ID of the employee

The relation a family member has to an employee

The family member's first name

The family member's surname

Whether the family member has been marked for deletion

When the family member was born

The family members social security number

Whether a ticket should be created

Any additional information

A list of the family member's ticket rights

The family members ticket holder code

The date of creation.

The source for the first creation

The date the last time the family member was updated

The source for the last update

The low income registrations for the current and the next year

The employees customer number in ESS. Note this profile is owned by JBD and is the profile connected to the ticket right. A 'null'-value here may indicate that the ticket right is not yet synced to ESS.

The code used for input

A description of the particular code's meaning

Employee number

FIP ticket type

Issued date

Ticket number

The date the ticket is valid from

The date the ticket is valid to

Travel type

Company id

The FIP ticket type id

The FIP ticket type code

Description of the ticket type

Employee number

Company Id

Type of employment

Employment percentage

Whether the employee has been marked for deletion. Default false

When the employee was born

Birthdate-number og D-number, 5 digits

The employee's first name

The employee's surname

The employee's address line

The postal code for the employee's address

The employee's product

Whether a ticket should be created

When the employee was hired

Pay type - see the codes in the API documentation

When the employee left the company

Why the employee left the company

The employee's degree of disability. Default 0.

When the employee's disability was granted

Date for registered employment percentage

The pay level. This is calculated based on the employment percentage and the type of employment. Typically holds the same value as employment percentage, unless special circumstances apply

When the employee starts a leave

Employee number

The company the employee is employed by

The type of employment

When the employee was born

The employee's social security number. 5 digits.

The employee's first name

The employee's surname

The employee's postal address

The postal code for the employee's address

When the employee was hired

Employment percentage

Whether the employee has been marked for deletion. Default false

Whether a ticket should be created. Default false

Pay type - see the codes in the API documentation

When the employee left the company

Why the employee left the company

The employee's degree of disability. Default 0.

When the employee's disability was granted

Date for registered employment percentage

The pay level. This is calculated based on the employment percentage and the type of employment. Typically holds the same value as employment percentage, unless special circumstances apply

When the employee starts a leave

If present, this will perform an update of the employee

The id of the imported employee

Employee number

The company the employee is employed by

The employee's first name

The employee's surname

The type of employment

When the employee was born

The employee's social security number

The employee's postal address

The postal data for the employee's address

Whether a ticket should be created

When the employee was hired

Pay type - see the codes in the API documentation

When the employee left the company

Why the employee left the company

The employee's degree of disability. Default 0.

When the employee's disability was granted

Employment percentage

Date for registered employment percentage

The pay level. This is calculated based on the employment percentage and the type of employment. Typically holds the same value as employment percentage, unless special circumstances apply

When the employee starts a leave

Any additional information

Whether the employee has been marked for deletion

When the imported employee was last updated

The source for the last update

The date of creation.

The source for the first creation

Id of this manual order.

The Ticket type informs of which country it is valid in and what train class it covers.

When this manual order was first issued.

First date the ticket right should be available.

Last date the ticket right should be available.

Whether this manual order is deleted or not.

Any station pairs for this manual order.

All items for this page

Total items which could be returned

Total number of pages

All items for this page

Total items which could be returned

Total number of pages

All items for this page

Total items which could be returned

Total number of pages

All items for this page

Total items which could be returned

Total number of pages

All items for this page

Total items which could be returned

Total number of pages

All items for this page

Total items which could be returned

Total number of pages

All items for this page

Total items which could be returned

Total number of pages

The code used for input

A description of the particular code's meaning

Postal code

Postal place

Country, format ISO 3166-1 alpha-3

If the postal place has been deleted

The product id

Human readable product name

When the product is valid from

When the product is valid to

Rule id

Rule name

Id of this station pair

Station with NetEX and name

Station with NetEX and name

Station in NetEX format.

Station name

Whether the ticket right is ready to be sent to the ticketing system

When the ticket right was sync'ed

If the system has failed in sending the ticket right to the ticketing system, this will hold the error message. Default is null

How far the generation has progressed in percent from 0 to 100

When the report generation started

When the report generation finished

Error if the report generation fails

The ticket right id

The id of the ticket holder, either an employee or a family member

The id of the employee who is responsible

The date from when the ticket right is valid

The date from when the ticket right stops being valid

The Ticket type informs of which country it is valid in and what train class it covers.

When the ticketright was calculated

Any additional information

Rule describing who are eligible for what ticket right

All items for this page

Status fields related to synchronization with other services

Status fields related to synchronization with other services

A manual order. This may contain a list of station pairs.

The ticket right holder id

The personnel ticket code for the ticket rights holder

A ticket right granted to an employee or a family member

Ticket type id

Ticket type

Ticket type description

Country code

Whether or not this this ticket type is relevant for sending as input to a Manual order. If this = false (the default), it will not generate new tickets rights by manual order.

Whether or not this ticket type is compatible with station pairs when placing a manual order. The default = false.

Whether the ticket type is deleted.

The travel type id

The travel type code