API docs by Redocly

Host-to-Host Integration API (0.0.1)

Download OpenAPI specification:

This is the formal specification of the Host-to-Host API of the Multi Service Tolls system. This specification defines the interface of how to access the MST tolling services, including setting up customers and vehicles, ordering products, and managing toll domains. Refer to the "H2H DataModel" excel sheets for further explanations of fields, parameter usage, and examples. Contact the MST Sales department (info@multiservicetolls.com) for information about connectivity and access credentials.

Copyright 2020 Multi Service Tolls. All rights reserved.

Search customers

Get the list of customers

Authorizations:
ApiKeyAuth
query Parameters
customer_name
string [ 1 .. 50 ] characters

The name of customer

vat_number
string [ 1 .. 20 ] characters

VAT number

alternative_vat_number
string [ 1 .. 20 ] characters

Alternative VAT number

coc_number
string [ 1 .. 20 ] characters

CoC number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Query transactions

Returns a list of transactions. Open query not permitted. You can't use batch seq number together with date range.

Authorizations:
ApiKeyAuth
query Parameters
start_date
string (ttt_date) ^[0-9]{4}-[0-9]{2}-[0-9]{2}
Example: start_date=2018-07-09

Loading date to start the query from

end_date
string (ttt_date) ^[0-9]{4}-[0-9]{2}-[0-9]{2}
Example: end_date=2018-07-09

Loading date to end the query at

batch_seq_nr
string (seq_nr) non-empty ^[0-9]+$
Example: batch_seq_nr=325

Batch Sequence Number

page_nr
integer (page_nr)
Example: page_nr=1

Page of results to return (only for use with base_seq_nr)

Responses

Response samples

Content type
application/json
{
  • "sender": "MSTS",
  • "receiver": "string",
  • "datetime": "2018-07-09 08:18:28",
  • "message": "OK",
  • "customer_currency": "EUR",
  • "total_pages": 1,
  • "total_count": 1,
  • "total_amount": 0,
  • "page_nr": 1,
  • "page_count": 1,
  • "page_amount": 0,
  • "transactions": [
    ]
}

Retrieve a transaction

Authorizations:
ApiKeyAuth
path Parameters
transaction_id
required
integer
Example: 14593

Responses

Response samples

Content type
application/json
{
  • "sender": "MSTS",
  • "receiver": "string",
  • "datetime": "2018-07-09 08:18:28",
  • "message": "OK",
  • "customer_currency": "EUR",
  • "total_pages": 1,
  • "total_count": 1,
  • "total_amount": 0,
  • "page_nr": 1,
  • "page_count": 1,
  • "page_amount": 0,
  • "transactions": [
    ]
}

Retrieve a single field for a transaction

Authorizations:
ApiKeyAuth
path Parameters
transaction_id
required
integer
Example: 14593
field_name
required
string
Enum: "transaction_id" "partner_haulier_id" "supplier_name" "transaction_country" "transaction_domain" "purchase_datetime" "entry_point_name" "entry_datetime" "exit_point_name" "exit_datetime" "device_product_type" "device_product_number" "transaction_product_id" "transaction_product_name" "license_plate_number" "vehicle_country" "original_currency" "original_net_amount" "original_gross_amount" "original_vat_percentage" "customer_currency" "transaction_net_amount" "transaction_gross_amount" "exempt_amount" "msts_fee_amount" "msts_vat_amount" "msts_vat_percentage" "total_gross_amount" "transaction_status" "loading_date" "batch_seq_nr" "invoice_number" "invoice_date" "specification_page_id" "specification_page_name" "transaction_debit_or_credit" "original_transaction_id" "original_invoice_number" "original_invoice_date" "credit_comment" "customer_name" "customer_vat_number" "packed_ascii_license_plate_no" "vehicle_type" "fleet_code" "driver_group" "vehicle_axles" "total_axles" "euronorm" "vehicle_weight" "total_weight" "certification_date" "loadfile_datetime" "loadfile_type" "loadfile_seq_nr" "tsp_name" "route" "distance_km" "duration" "supplier_licence_plate_number" "supplier_vehicle_country" "supplier_vehicle_class" "supplier_vehicle_euronorm" "supplier_tariff_code" "original_base_amount" "original_air_external_cost" "original_noise_external_cost" "original_quantity" "original_base_price" "original_rate_percentage" "original_exchange_rate" "original_vat_country" "original_vat_percentage" "original_vat_amount" "customer_exchange_rate" "customer_vat_amount" "msts_vat_country" "msts_vat_percentage" "total_net_amount" "total_vat_amount" "transaction_sent_datetime" "transaction_sent_seq_nr" "settlement_sent_datetime" "settlement_sent_seq_nr" "supplier_transaction_id" "supplier_obu_id" "supplier_product_id" "supplier_invoice_id" "supplier_customer_id" "loadfile_id" "eurovignet_number" "eurovignet_trace_number" "italian_toll_exempt_amount" "belgian_roll_road_type" "spanish_portuguese_details" "french_toll_cost_details" "french_toll_commercial_condition" "french_toll_entry_acquisition_type" "french_toll_exit_acquisition_type" "french_toll_battery_status" "toll_collect_kostenstelle" "toll_collect_tarifversion" "toll_collect_ortsklasse" "toll_collect_zeitklasse" "toll_collect_achsklasse" "toll_collect_gweichtsklasse" "toll_collect_emissionsklasse" "toll_collect_betreiber_id" "toll_collect_verfahren"

Responses

Response samples

Content type
application/json
{
  • "sender": "MSTS",
  • "receiver": "string",
  • "datetime": "2018-07-09 08:18:28",
  • "message": "OK",
  • "transaction_id": 14593,
  • "field_name": "license_plate_number",
  • "field_value": "17-BBT-8"
}

Get new transactions

Returns a newly created batch of transactions. Only returns the first page of transactions, subsequent pages are to be requested via /transactions with batch_seq_nr and page_nr.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "sender": "MSTS",
  • "receiver": "string",
  • "datetime": "2018-07-09 08:18:28",
  • "message": "OK",
  • "batch_seq_nr": "325",
  • "customer_currency": "EUR",
  • "total_pages": 1,
  • "total_count": 1,
  • "total_amount": 0,
  • "page_nr": 1,
  • "page_count": 1,
  • "page_amount": 0,
  • "transactions": [
    ]
}

Query settled transactions

Returns a list of settled transactions. Open query not permitted. You can't use batch seq number together with date range

Authorizations:
ApiKeyAuth
query Parameters
start_date
string (ttt_date) ^[0-9]{4}-[0-9]{2}-[0-9]{2}
Example: start_date=2018-07-09

Invoice date to start the query from

end_date
string (ttt_date) ^[0-9]{4}-[0-9]{2}-[0-9]{2}
Example: end_date=2018-07-09

Invoice date to end the query at

batch_seq_nr
string (seq_nr) non-empty ^[0-9]+$
Example: batch_seq_nr=325

Batch Sequence Number

page_nr
integer (page_nr)
Example: page_nr=1

Page of results to return (only for use with base_seq_nr)

Responses

Response samples

Content type
application/json
{
  • "sender": "MSTS",
  • "receiver": "string",
  • "datetime": "2018-07-09 08:18:28",
  • "message": "OK",
  • "customer_currency": "EUR",
  • "total_pages": 1,
  • "total_count": 1,
  • "total_amount": 0,
  • "page_nr": 1,
  • "page_count": 1,
  • "page_amount": 0,
  • "transactions": [
    ]
}

Get new settlements

Returns a newly created batch of settlements. Only returns the first page of transactions, subsequent pages are to be requested via /transactions with batch_seq_nr and page_nr.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "sender": "MSTS",
  • "receiver": "string",
  • "datetime": "2018-07-09 08:18:28",
  • "message": "OK",
  • "batch_seq_nr": "325",
  • "customer_currency": "EUR",
  • "total_pages": 1,
  • "total_count": 1,
  • "total_amount": 0,
  • "page_nr": 1,
  • "page_count": 1,
  • "page_amount": 0,
  • "transactions": [
    ]
}

Query PDF invoices

Returns links to PDF invoices.

Authorizations:
ApiKeyAuth
query Parameters
start_date
required
string (ttt_date) ^[0-9]{4}-[0-9]{2}-[0-9]{2}
Example: start_date=2018-07-09

Invoice date to start the query from

end_date
required
string (ttt_date) ^[0-9]{4}-[0-9]{2}-[0-9]{2}
Example: end_date=2018-07-09

Invoice date to end the query at

Responses

Response samples

Content type
application/json
{
  • "sender": "MSTS",
  • "receiver": "string",
  • "datetime": "2018-07-09 08:18:28",
  • "message": "OK",
  • "pdf_invoices": [
    ]
}

Retrieve PDF invoices by Invoice ID

Returns links to PDF invoices.

Authorizations:
ApiKeyAuth
path Parameters
invoice_id
required
string (invoice_id) non-empty ^[0-9]+$
Example: 562

Unique ID for an invoice

Responses

Response samples

Content type
application/json
{
  • "sender": "MSTS",
  • "receiver": "string",
  • "datetime": "2018-07-09 08:18:28",
  • "message": "OK",
  • "pdf_invoices": [
    ]
}

Query Don't Bill transactions

Returns a list of transactions which are in Don't Bill status. Open query not permitted. You can't use batch seq number together with date range.

Authorizations:
ApiKeyAuth
query Parameters
start_date
string (ttt_date) ^[0-9]{4}-[0-9]{2}-[0-9]{2}
Example: start_date=2018-07-09

Loading date to start the query from

end_date
string (ttt_date) ^[0-9]{4}-[0-9]{2}-[0-9]{2}
Example: end_date=2018-07-09

Loading date to end the query at

batch_seq_nr
string (seq_nr) non-empty ^[0-9]+$
Example: batch_seq_nr=325

Batch Sequence Number

page_nr
integer (page_nr)
Example: page_nr=1

Page of results to return (only for use with base_seq_nr)

Responses

Response samples

Content type
application/json
{
  • "sender": "MSTS",
  • "receiver": "string",
  • "datetime": "2018-07-09 08:18:28",
  • "message": "OK",
  • "customer_currency": "EUR",
  • "total_pages": 1,
  • "total_count": 1,
  • "total_amount": 0,
  • "page_nr": 1,
  • "page_count": 1,
  • "page_amount": 0,
  • "transactions": [
    ]
}

Get new don't bill transactions

Returns a newly created batch of Don't Bill transactions. Only returns the first page of transactions, subsequent pages are to be requested via /dailytrx with batch_seq_nr and page_nr.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "sender": "MSTS",
  • "receiver": "string",
  • "datetime": "2018-07-09 08:18:28",
  • "message": "OK",
  • "batch_seq_nr": "325",
  • "customer_currency": "EUR",
  • "total_pages": 1,
  • "total_count": 1,
  • "total_amount": 0,
  • "page_nr": 1,
  • "page_count": 1,
  • "page_amount": 0,
  • "transactions": [
    ]
}