Create and manage settlements to be cleared by CLEOS
Get a settlement by id.
Get the details of a settlement to see its status or any errors that occurred during clearing.
path Parameters
idHeaders
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 settlement by id. › Responses
Ok
idUnique identifier of queued Settlement Import.
posRefstatusStatus code indicating the result of the import operation. This will always be 0 (TO BE PROCESSED) on creation. 1 indicates SUCCESSFUL CLEARING
commentssettlementNoRepresentation of an amount with relevant metadata such as currency and tax information. The Annex will be considered without Price Contribution if amount is 0.00
Representation of an amount with relevant metadata such as currency and tax information. The Annex will be considered without Price Contribution if amount is 0.00
ignoreSequenceIndicates whether sequence errors will be ignored during import, typical for negative settlement sequences (corrections).
settlementDatestatusDescriptionMessage providing additional information on the import status.
externalSettlementNocorrectedSettlementIdSubmit a Generic Settlement for asynchronous clearing. Read the Developer Guide before using.
Creates a GenericSettlementImport, in queue for for clearing. Use the returned result for further queries based on the assigned ID
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
Submit a Generic Settlement for asynchronous clearing. Read the Developer Guide before using. › Request Body
posRefReference to the PointOfSale (POS) for which the settlement is created.
settlementDateSettlement Date for the settlement on the format YYYY.MM.DD
List of Generic Transactions associated with the settlement.
distributionChannelRefReference to the Distribution Channel for which the settlement is created.
idContext map containing additional key-value pairs relevant for the settlement. Only simple key-value pairs are supported (String, Number, Boolean) with a max length of 100 characters per value.
Optional comments associated with the settlement. Used for audit trail and additional information relevant for clearing.
msgSubjectIdsettlementNoSettlement Sequence Number. This must be a continuous sequence for the settlement not to fail clearing. Negative sequences are typically used for corrections that are out of sequence. If not specified, the next number in a negative sequence will automatically be assigned based previous correction on the same POS.
correctionForSmntIdIf this settlement is a correction of a previous settlement, the internal CLEOS ID of the settlement being corrected must be provided.
externalSettlementNoExternal Settlement Number provided by the Partner. If not provided, the settlementNo will be used as external reference as well.
Submit a Generic Settlement for asynchronous clearing. Read the Developer Guide before using. › Responses
Created
idUnique identifier of queued Settlement Import.
posRefstatusStatus code indicating the result of the import operation. This will always be 0 (TO BE PROCESSED) on creation. 1 indicates SUCCESSFUL CLEARING
commentssettlementNoRepresentation of an amount with relevant metadata such as currency and tax information. The Annex will be considered without Price Contribution if amount is 0.00
Representation of an amount with relevant metadata such as currency and tax information. The Annex will be considered without Price Contribution if amount is 0.00
ignoreSequenceIndicates whether sequence errors will be ignored during import, typical for negative settlement sequences (corrections).
settlementDatestatusDescriptionMessage providing additional information on the import status.
externalSettlementNocorrectedSettlementId