| Function | Input | Output | Description |
|---|---|---|---|
| AlterClaim | Claim | ClaimOperationResult | Modifies a previously created claim. The entire claim is submitted new values |
| AlterClaims | Claim | operationId | Modifies a list of previously created claims |
| CancelClaim | ClaimKey | ClaimOperationResult | Cancels an unpaid claim. |
| CancelClaims | ClaimKey | operationId | Cancels multiple unpaid claims. |
| GetClaimOperationResult | operationId | ClaimOperationResult | Returns information on a claim batch along with the status on individual claims in the batch. |
| QueryClaim | ClaimKey | ClaimInfo | Returns information on a claim. |
| QueryClaims | ClaimsQuery | QueryClaimsResult | Returns information on multiple claims. |
| QueryClaimTransactions | ClaimKey | ClaimTransactionsResult | Returns the whole transaction history of a claim (payments, updates, reminders sent, etc.) |
| QuerySecondaryCollectionClaims | SecondaryCollectionClaimsQuery | QueryClaimsResult | Retrieves information about claims for the specified claimant. Used to fetch claims marked for secondary collection. |
| QuerySecondaryCollectionPayments | SecondaryCollectionPaymentsQuery | QueryPaymentsResult | Returns a list of individual payments for claims that have been partially or fully paid. |
| SecondaryCollectionReturnClaim | Claim | ClaimOperationResult | Returns a collection claim that is in secondary collection or opened for the secondary collection agent back to the claimant. |
| SecondaryCollectionReturnClaims | Claim | OperationId | Returns one or more secondary collection claims or opened claims back to the claimant with original identifiers and agreed fees and costs. |
| Parameter | Description |
|---|---|
| Key* | Unique identification for the claim. |
| PayorID* | Kennitala (National identification number) of payor. |
| CancellationDate* | Cancellation date of claim. Cannot be the same date as the due date or final due date. |
| Identifier* | Identifier (ísl. auðkenni) of the claim template (ísl. kröfusniðmát) for the claimant. |
| Amount* | Claim amount. Not possible to edit this parameter if a payment has been made on the claim. |
| Reference* | Alphanumerical reference number decided by the claimant. |
| FinalDueDate* | Final due date of claim (ísl. eindagi). |
| BillNumber | Optional bill number provided by claimant (ísl. seðilnúmer) |
| CustomerNumber | Customer number of payor. Unique key that identifies the payor to the claimant. Required if a direct debit contract (ísl. beingreiðslusamningur) is to be made for the claim. |
| NoticeAndPaymentFee | The notice and payment fee (ísl. tilkynningar og greiðslugjald) for both paperless and printed communication. No fee will be added if this field is empty. |
| DefaultCharge | Information on the default charge on the claim (ísl. vanskilagjald). |
| OtherCosts | Other costs to be paid by the payor. |
| OtherDefaultCosts | Other default costs such as secondary collection costs (ísl. milliinnheimtugjöld). |
| DefaultInterest | Information on how the default interest (ísl. dráttarvextir) is calculated. No interest fee will be added if this field is empty. |
| CurrencyInformation | Information for claims to be paid in a foreign currency. |
| PermitOutOfSequencePayment | Boolean value determining if it is possible to pay the claim if an older unpaid due date exists. If empty, this value will be “false”. |
| Discount | Information on discount. No discount is added if value is empty. |
| IsPartialPaymentAllowed | Boolean value determining if partial payments are allowed. If empty, this value will be “false”. |
| BillPresentmentSystem | Not implemented. |
| Printing | Information on whether and how the claim is printed and sent out via mail. If the Printing field is edited after the claim has been printed, it will not be printed again. |
Contains information on the first default charge.
Of class type DiscountOrDefaultChargeBase
| | Second |Contains information on the second default charge.
Of class type DiscountOrDefaultChargeBase
| | ReferenceDate | Reference date to use to calculate when the first and second default charge should occur. Of Enum type ReferenceDate with DueDate (ísl, gjalddagi) and FinalDueDate (ísl. eindagi) as options. | ### DiscountOrDefaultChargeBase The DiscountOrDefaultChargeBase class contains information on the [first and second default charge](#daterestrictedcharge) or [discount](#discountcharge). Note that the value must comply with regulation 37/2009. The value can be either an amount or a percentage. | Parameter | Description | | --------- | ---------------------------------------------------------------------------- | | Days | Number of days from the reference date when the default charge should occur. | | Value | Amount or percentage of the default charge. | ### DefaultInterest The DefaultInterest class contains information on how default interest (ísl. dráttarvextir) is calculated. | Parameter | Description | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Rule |Of type DefaultInterestRule (Enum)
Controls whether default interest should be calculated after a reference date and if so, how it is calculated.
Reference rate to be used.
Enum type CurrencyInformationReferenceRate with the following options:
Spot rate (ísl. daggengi) to be used when issuing claim.
Enum type CurrencyInformationPaymentRate with the following options:
Information on the first discount charge
Of class type DiscountOrDefaultChargeBase
| | Second |Information on the second discount charge
Of class type DiscountOrDefaultChargeBase
| | ReferenceDate | Reference date to use to calculate when the first and second discount charge should occur. Of Enum type ReferenceDate with DueDate (ísl, gjalddagi) and FinalDueDate (ísl. eindagi) as options. | | IsPostRefDate | Boolean value indicating whether the number of days specified are after the reference date (or before it by choosing false). | ### BillPresentmentSystem This functionality is not implemented. ### Printing The Printing class contains information if the claim is printed and sent out via mail. If this parameter is edited after the claim has been printed, it will not be printed again. If this is empty, the claim will not be printed and sent by mail. | Parameter | Description | | --------------------------- | ------------------------------------------------------------------------------------------------------------ | | [ClaimantAddress](#address) | Address of the claimant. If field is empty, the values from the national registry will be used. | | [PayorAddress](#address) | Address of payor. If field is empty, the values from the national registry will be used. | | ItemRows |A breakdown of the amount and fees of the claim.
Type Collection ItemRow
| | Comments | List of comments printed at the bottom of the payment slip. | #### Address The Address class contains postal address information. | Parameter | Description | | -------------- | ---------------------- | | Name | Name of recipient | | AddressLine1 | First part of address | | AddressLine2 | Second part of address | | PostCodeNumber | Post code | | City | City | | Region | Region | | Country | Country | #### ItemRow The ItemRow class contains information about the breakdown of the claim. | Parameter | Description | | --------- | ---------------------------- | | Text | Description of fee or amount | | Amount | Amount | ## ClaimInfo The ClaimInfo class is the output of the methods QueryClaim and QueryClaims. It contains all the information about a single claim. | Parameter | Description | | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Key](#claimkey) | Unique identification for the claim. | | PayorID | Kennitala (National identification number) of payor. | | CancellationDate | Cancellation date of claim. Cannot be the same date as the due date or final due date. | | Identifier | Identifier of the claim template (ísl. kröfusniðmát) for the claimant. | | Amount | Claim amount. Not possible to edit this parameter if a payment has been made on the claim. | | Reference | Alphanumerical reference number decided by the claimant. | | FinalDueDate | Final due date of claim (ísl. eindagi). | | BillNumber | Optional bill number provided by claimant (ísl. seðilnúmer) | | CustomerNumber | Customer number of payor. Unique key that identifies the payor to the claimant. Required if a direct debit contract (ísl. beingreiðslusamningur) is to be made for the claim. | | [NoticeAndPaymentFee](#noticeandpaymentfee) | The notice and payment fee (ísl. tilkynningar og greiðslugjald) for both paperless and printed communication. No fee will be added if this field is empty. | | [DefaultCharge](#daterestrictedcharge) | Information on the default charge on the claim (ísl. vanskilagjald). | | OtherCosts | Other costs to be paid by the payor. | | OtherDefaultCosts | Other default costs such as secondary collection costs (ísl. milliinnheimtugjöld). | | [DefaultInterest](#defaultinterest) | Information on how the default interest (ísl. dráttarvextir) is caluclated. No interest fee will be added if this field is empty. | | [CurrencyInformation](#currencyinformation) | Information for claims to be paid in a foreign currency. | | PermitOutOfSequencePayment | Boolean value determining if it is possible to pay the claim if an older unpaid due date exists. If empty, this value will be “false”. | | [Discount](#discountcharge) | Information on discount. No discount is added if value is empty. | | IsPartialPaymentAllowed | Boolean value determining if partial payments are allowed. If empty, this value will be “false”. | | [BillPresentmentSystem](#billpresentmentsystem) | Not implemented. | | [Printing](#printing) | Information on whether and how the claim is printed and sent out via mail. | | Status | Status of claim. Can be “Unpaid”, “Paid”, “Cancelled” and “Invalid”. | | State | Status of claim collection. Can be “PrimaryCollection”, “SecondaryCollection” and “LegalCollection”. | | CategoryCode | Optional category code (ísl. textalykill) that describes what kind of payment claim this is. | | TotalAmountDue | Total amount of payment due. | | NoticeChargeAmount | Notice charge amount due (ísl. tilkynningargjald). | | DefaultChargeAmount | Default charge amount due (ísl. vanskilagjald). | | OtherCostsAmount | Other costs due. | | OtherDefaultCostsAmount | Other default costs due (ísl. annar vanskilakostnaður). | | DefaultInterestAmount | Default interest amount due (ísl. áfallnir dráttarvextir). | | DiscountAmount | Discount applied if claim is paid in its current state. | | SecondaryCollectionIdentifier | Identifier of secondary collection (ísl. milliinnheimtuaðila) if applicable. On the format “MIx” where “x” is a single letter or number. | | LegalCollectionIdentifier | Identifier of legal collection (ísl. löginnheimtuaðila) if applicable. On the format “LIx” where “x” is a single letter or number. | | IsPartiallyPaid | Boolean value stating whether a partial payment has been made on the claim. | ## ClaimKey The ClaimKey class is the input for the methods CancelClaim, QueryClaimTransactions, and QueryClaim. ClaimKey is a unique identifier for a claim and does not change, even if the claim itself is modified. **All parameters of the class are mandatory.** | Parameter | Description | | --------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | Claimant | Kennitala (national registry ID number) of the claimant. | | Account | Claim identifier containing branch ID (first 4 digits), account type (next 2 digits) and the claim number (last 6 digits). E.g. 030126001234. | | DueDate | Due date of the claim | ## ClaimOperationResult The ClaimOperationResult class is the output of the methods AlterClaim, CancelClaim, GetClaimOperationResult, and SecondaryCollectionReturnClaim. It contains the classes BatchStatus, ClaimResult, and ClaimError. If any claim in a batch encounters an error, the batch status is returned as CompletedWithErrors, while successfully processed claims are created. | Parameter | Description | | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ID | Unique operation identifier of a single claim or unique batch identifier for batch processing. Can be empty if an error occurred. | | Status |Status of a claim batch that was operated on.
Of enum type BatchStatus with the following options:
List of claims in which the operation was successful.
Of type Collection ClaimResult
| | Errors |List of claims in which the operation raised an error.
Of type Collection ClaimError
| ### ClaimResult Provides information about a collection claim that was successfully processed. | Parameter | Description | | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Key](#claimkey) | Unique key for claim. | | Print | Boolean value stating whether the claim should be printed at the bank. Claims on a direct debit contract (ísl. beingreiðslusamningur) do not need to be printed. | ### ClaimError Provides information about a collection claim that encountered an error. | Parameter | Description | | ---------------- | ------------------------------------------------------ | | [Key](#claimkey) | Unique key for claim. | | [Error](#error) | The error that was raised when operating on the claim. | #### Error Includes the error code and message describing what failed during the operation. | Parameter | Description | | --------- | ------------- | | Code | Error code | | Message | Error message | ## OperationId The OperationId string is a unique identifier for a claim batch. It is the input for the GetClaimOperationResult method and the output for the methods AlterClaims, CancelClaims, and SecondaryCollectionReturnClaims. ## ClaimsQuery The ClaimsQuery class is the input for the QueryClaims function. It includes the ClaimsQueryDataSpan class. If more than one parameters are used (e.g. Payor and Status = Unpaid), the query will return all claims with "Unpaid" status for that payor. If no unpaid claims exist for that payer, the query will return an empty list. | Parameter | Description | | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Claimant | Kennitala (national registry ID number) of claimant. The kennitala must match the kennitala of the user that is using the service. | | Identifier | Identifier of the claim template (ísl. kröfusniðmát) for the claimant. Only claims in secondary collection can be looked up, i.e., claims marked with MI. | | Period | Of type collection [ClaimsQueryDataSpan](#claimsquerydataspan). Period and reference date to query claims from. | | Payor | Kennitala (national registry ID number) of payor | | Status |Status of claim. Of enum type ClaimStatus with the following options:
Reference date to query. Of enum type DateSpanReferenceDate with the following options:
Payment type. Of enum type PaymentType which has the following options:
Cancelation of claim.
Can be initiated by claimant or an applied rule.
| | Update | Update to claim | | Payment | Payment to claim. Can be both partial and complete payments. | | RefundClaimCreation | Creation of a refund claim. Claim amount is transferred from claimant to payor. This is only possible if a direct debit contract is in place and the claimant needs to refund their payor. | | ReAdjustment | Readjustment of claim (ísl. bakfærsla). | | PaymentReAdjustment | Readjustment of payment. When a complete payment is readjusted, the payment transaction is sorted as ReAdjustment but the readjustment itself gets this transaction type. | | PartialPaymentReAdjustment | Readjustment of a partial payment. When a partial payment is readjusted, the payment transaction is sorted as ReAdjustment but the readjustment itself gets this transaction type. | | TransferFromOldBank | Claim is transferred from one bank to another. | | TransferToNewBank | Claim is transferred from one bank to another. | | OptionalClaimCancellationByPayor | Cancellation of an optional claim by payor. | | RefundPayment | Refund payment | | CollectionReminderSentByBank | Collection reminder (ísl. innheimtuviðvörun) is sent by bank. | ## SecondaryCollectionClaimsQuery The SecondaryCollectionClaimsQuery class is the input for the QuerySecondaryCollectionClaims method. It contains the information needed to retrieve claims for a specific claimant that are marked for secondary collection. If filtering by multiple criteria, they must align—for example, searching for paid claims of a specific claimant, and no paid claims exist in secondary collection, the method will return an empty list. | Parameter | Description | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Claimant | Kennitala (national registry ID number) of claimant. | | CollectionDateFrom | Query from and including this date | | CollectionDateTo | Query to and including this date | | Status |Status of claim. Of enum type ClaimStatus with the following options:
| Calculation of no. of days | Reference date of calculation | Description | |
|---|---|---|---|
| [empty] | 360/360 | Due date | If the final due date and due date are the same day and fall on a non-banking day, the claim may be paid without default interest before 21:00 of the following banking day. If default interest is imposed, it is calculated from due date to payment date |
| 1 | - | - | No penalty interest is imposed |
| 2 | 360/360 | Final due date | If the final due date falls on a non-banking day and payment is effected before 21:00 of the previous banking day no default interest is imposed. But after that, default interest is imposed as if the payment was effected on the following banking day. If the final due date falls on a day before non-banking day and the payment is effected after 21:00 default interest is imposed as if the payment was effected on the following banking day |
| 3 | - | Final due date | 1% penalty interest imposed per day. State claims. If default interest is imposed, it is calculated from the final due date to the payment date. |
| 4 | actual/360 | Due date | Same as default interest rule “2” except that the reference date of calculation is the due date. |
| 5 | actual/360 | Due date | Same as default interest rule [empty] except that the number of days used in the calculation is actual/360. |
| 6 | actual/360 | Final due date | Same as default interest rule “2” except that the number of days used in the calculation is actual/360 |
| 7 | 360/360 | Due date | Same as default interest rule “4” except that the number of days used in the calculation is 360/360. |
| 8 | 360/360 | Due date | If the final due date and due date are the same day and fall on a non-banking day, the claim may be paid without default interest before 21:00 of the following banking day. If the final due date and due date are not the same day and the final due date falls on a non-banking day and payment is effected before 21:00 of the previous banking day, no default interest is imposed. But after that default interest is imposed as if the payment was effected on the following banking day. If the final due date falls on a day before non-banking day and the payment is effected after 21:00, default interest is imposed as if the payment was effected on the following banking day. |
| 9 | actual/360 | Due date | Same as default interest rule “8” except that the number of days used in the calculation is actual/360. |
| B | 360/360 | Due date | If the final due date falls on a non-banking day, the claim may be paid without default interest before 21:00 of the following banking day. If default interest is imposed, it is calculated from the due date to the payment date. |
| C | - | Due date | 5% penalty interest imposed per day. State claims TIF. If default interest is imposed, it is calculated from the due date to the payment date. |