Schemas

The NAME corresponding to the REF, if found in the CLEOS REF lookup table (best effort). NOTE: This may be set for REFs returned by CLEOS, the client is not expected to submit this value.

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

PriceContribution may be provided if a custom weight on Price is needed. The Amount will always be recalculated as the sum of PriceContributions.

If true, this annex root (and all sub-annexes) will be accounted with DEBED/CREDIT switched. Typically used for reversing older versions of the transaction. Default false.

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

The monetary amount in a 12.2 format (up to 12 digits before decimal, exactly 2 after)

The weight associated with the amount, if any, in a 12.4 format (up to 12 digits before decimal, optionally followed by 1-4 after). Thw weight is used for proportional clearing based a custom weight instead of PriceContributions. For example representing distance or time.

The standard tax code applicable to the amount, if any

The tax rate applicable to the amount, if any. NOTE: This must be consistent with the CLEOS configuration for the Tax Code (SEGMENT7)

The currency of the amount in ISO 4217 format. Default NOK if not provided

The local tax code applicable to the amount, if any. NOTE: This is normally not necessary to set but may be relevant in scenarios where the tax rate for a code changes

URI identifying the type of problem. NOTE: type about:blank may still be used for general errors.

Absolute URI to the the resource causing the error. Note that this is technically not a reference to the persistent error instance, but still useful default behaviour.

Server side timestamp of incident, used by cleos problem-types

Domain object references that caused the error on problem type cleos-ref. NOTE: These may be references to entities outside of CLEOS

Correlation ID for tracking the error, used by cleos problem-types. Typically based on the request header X-Correlation-Id

Reference to the PointOfSale (POS) for which the settlement is created.

Settlement Date for the settlement on the format YYYY.MM.DD

List of Generic Transactions associated with the settlement.

Reference to the Distribution Channel for which the settlement is created.

Context 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.

Settlement 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.

If this settlement is a correction of a previous settlement, the internal CLEOS ID of the settlement being corrected must be provided.

External Settlement Number provided by the Partner. If not provided, the settlementNo will be used as external reference as well.

Type of the transaction being submitted for clearing. This type MUST be assigned to the relevant Chart Of Accounts by the Cleos Administrator first.

OrderID is a unique identifier for the transaction within the Partner's system. It is used to track and manage the transaction throughout its lifecycle. Note that several transactions may refer to the same OrderID (eg both the sale and the payment transaction)

OrderVersion is a sequential version number for the transaction. It is used to track changes to the transaction over time.

Unique identifier of queued Settlement Import.

Status code indicating the result of the import operation. This will always be 0 (TO BE PROCESSED) on creation. 1 indicates SUCCESSFUL CLEARING

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

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

Indicates whether sequence errors will be ignored during import, typical for negative settlement sequences (corrections).

Message providing additional information on the import status.