> For the complete documentation index, see [llms.txt](https://apidocs.arionbanki.is/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.arionbanki.is/b2b-2013-schema/b2b-services/b2b-claims-service/fields.md).

# Fields

This chapter contains information on the input and output fields of the B2B claims service.

## Service functions <a href="#toc130917534" id="toc130917534"></a>

List of functions within the B2B claims service:

<table data-header-hidden data-full-width="true"><thead><tr><th></th><th></th><th></th><th></th></tr></thead><tbody><tr><td>Function</td><td>Input</td><td>Output</td><td>Description</td></tr><tr><td>CreateClaim</td><td><a href="#_ref127889738">Claim</a></td><td><a href="#_ref127972825">ClaimOperationResult </a></td><td>Creates a claim</td></tr><tr><td>CreateClaims</td><td>Collection&#x3C;<a href="#_ref127889738">Claim</a>> </td><td><a href="#_ref127972779">operationId</a></td><td>Creates multiple claims</td></tr><tr><td>AlterClaim</td><td><a href="#_ref127889738">Claim </a></td><td><a href="#_ref127972825">ClaimOperationResult </a></td><td>Edits a claim. The whole claim is submitted with new values.</td></tr><tr><td>AlterClaims</td><td>Collection&#x3C;<a href="#_ref127889738">Claim</a>> </td><td><a href="#_ref127972779">operationId</a></td><td>Edits multiple claims.</td></tr><tr><td>CancelClaim</td><td><a href="#_ref127972751">ClaimKey (4.4)</a></td><td><a href="#_ref127972825">ClaimOperationResult</a></td><td>Cancels an unpaid claim.</td></tr><tr><td>CancelClaims</td><td>Collection&#x3C;<a href="#_ref127972751">ClaimKey</a>> </td><td><a href="#_ref127972779">operationId</a></td><td>Cancels multiple unpaid claims.</td></tr><tr><td>ReCreateClaim</td><td><a href="#_ref127889738">Claim </a></td><td><a href="#_ref127972825">ClaimOperationResult</a></td><td>Re-creates a claim that has been canceled.</td></tr><tr><td>ReCreateClaims</td><td>Collection&#x3C;<a href="#_ref127889738">Claim</a>> </td><td><a href="#_ref127972779">operationId</a></td><td>Re-creates multiple claims that have been canceled.</td></tr><tr><td>MarkClaimForSecondaryCollection</td><td><a href="#_ref127972751">ClaimKey</a></td><td><a href="#_ref127972825">ClaimOperationResult</a></td><td>Marks a claim for secondary collection (ísl. milliinnheimta).</td></tr><tr><td>MarkClaimsForSecondary Collection</td><td>Collection&#x3C;<a href="#_ref127972751">ClaimKey</a>> </td><td><a href="#_ref127972779">operationId</a></td><td>Marks multiple claims for secondary collection.</td></tr><tr><td>GetClaimOperationResult</td><td><a href="#_ref127972779">operationId</a></td><td><a href="#_ref127972825">ClaimOperationResult</a></td><td>Returns information on a claim batch along with the status on individual claims in the batch.</td></tr><tr><td>QueryClaim</td><td><a href="#_ref127972751">ClaimKey</a></td><td><a href="#_ref127972909">ClaimInfo</a></td><td>Returns information on a claim.</td></tr><tr><td>QueryClaims</td><td><a href="#_ref127972795">ClaimsQuery</a></td><td><a href="#_ref127972923">QueryClaimsResult</a></td><td>Returns information on multiple claims.</td></tr><tr><td>QueryPayments</td><td><a href="#_ref127972810">PaymentsQuery</a></td><td><a href="#_ref127972935">QueryPaymentsResult</a></td><td>Returns a list of payments on a claim that has been fully or partially paid.</td></tr><tr><td>QueryClaimTransactions</td><td><a href="#_ref127972751">ClaimKey</a></td><td><a href="#_ref127972966">ClaimTransactionsResult</a></td><td>Returns the whole transaction history of a claim (payments, updates, reminders sent, etc.)</td></tr></tbody></table>

## *Claim* <a href="#ref127889738" id="ref127889738"></a>

The class *Claim* is an input to the *CreateClaim, CreateClaims, AlterClaim, AlterClaims, ReCreateClaim* and *ReCreateClaims* functions and contains the information needed to create or edit a claim. The input parameters that are required are marked with an asterisk in the table below. When a claim is being edited, the fields “Key” and “PayorID” must not be changed. If a payment has been made to a claim, the “Amount” field must not be changed.

<table data-header-hidden data-full-width="false"><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Parameter</td><td>Description</td></tr><tr><td>Key* (4.4)</td><td>Unique identification for the claim.</td></tr><tr><td>PayorID*</td><td>Kennitala (National identification number) of payor.</td></tr><tr><td>CancellationDate*</td><td>Cancellation date of claim. Cannot be the same date as the due date or final due date.</td></tr><tr><td>Identifier*</td><td>Identifier (ísl. auðkenni) of the claim template (ísl. kröfusniðmát) for the claimant.</td></tr><tr><td>Amount*</td><td>Claim amount. Not possible to edit this parameter if a payment has been made on the claim.</td></tr><tr><td>Reference*</td><td>Alphanumerical reference number decided by the claimant.</td></tr><tr><td>FinalDueDate*</td><td>Final due date of claim (ísl. eindagi).</td></tr><tr><td>BillNumber</td><td>Optional bill number provided by claimant (ísl. seðilnúmer)</td></tr><tr><td>CustomerNumber</td><td>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.</td></tr><tr><td>NoticeAndPaymentFee</td><td>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.</td></tr><tr><td>DefaultCharge (4.2.2)</td><td>Information on the default charge on the claim (ísl. vanskilagjald).</td></tr><tr><td>OtherCosts</td><td>Other costs to be paid by the payor.</td></tr><tr><td>OtherDefaultCosts</td><td>Other default costs such as secondary collection costs (ísl. milliinnheimtugjöld).</td></tr><tr><td><a href="#_ref128127261">DefaultInterest</a> (4.2.3)</td><td>Information on how the default interest (ísl. dráttarvextir) is calculated. No interest fee will be added if this field is empty.</td></tr><tr><td><a href="#_ref128129074">CurrencyInformation</a> (4.2.4)</td><td>Information for claims to be paid in a foreign currency.</td></tr><tr><td>PermitOutOfSequencePayment</td><td>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”.</td></tr><tr><td>Discount (4.2.5)</td><td>Information on discount. No discount is added if value is empty.</td></tr><tr><td>IsPartialPaymentAllowed</td><td>Boolean value determining if partial payments are allowed. If empty, this value will be “false”.</td></tr><tr><td>BillPresentmentSystem (4.2.6)</td><td>Not implemented.</td></tr><tr><td>Printing (4.2.7)</td><td>Information on whether and how the claim is printed and sent out via mail. If the <em>Printing</em> field is edited after the claim has been printed, it will not be printed again.</td></tr></tbody></table>

### *NoticeAndPaymentFee* <a href="#ref128126952" id="ref128126952"></a>

The *NoticeAndPaymentFee* class contains information on the notice and payment fee (ísl. tilkynningar og greiðslugjald) of the claim.

| Parameter | Description                        |
| --------- | ---------------------------------- |
| Printing  | Fee amount when claim is printed   |
| Paperless | Fee amount when claim is paperless |

### *DateRestrictedCharge* <a href="#ref128127281" id="ref128127281"></a>

The *DateRestrictedCharge* class contains information on the default charge on the claim (ísl. vanskilagjald).

| Parameter     | Description                                                                                                                                                                                    |
| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| First         | <p>Contains information on the first default charge.</p><p>Of class type <a href="#discountordefaultchargebase"><em>DiscountOrDefaultChargeBase</em></a></p>                                   |
| Second        | <p>Contains information on the second default charge.</p><p>Of class type <a href="#discountordefaultchargebase"><em>DiscountOrDefaultChargeBase</em></a></p>                                  |
| 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 (see [DateRestrictedCharge](#_ref128127281)) or discount (see [*DiscountCharge*](#_ref128129391)). 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* <a href="#ref128127261" id="ref128127261"></a>

The class *DefaultInterest* contains information on how the default interest (ísl. dráttarvextir) should be calculated.

| Parameter   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Rule        | <p>Of type <em>DefaultInterestRule</em> (Enum)</p><p>Controls whether default interest should be calculated after a reference date and if so, how it is calculated.</p><ul><li><em>NoDefaultInterest</em> – No default interest will be applied</li><li><em>DefaultInterestAmount</em> – Default interest will be applied</li><li><em>DefaultInterestAmountAndDefaultCharge</em> – Default interest and default change will be applied</li></ul> |
| Percentage4 | Interest rate to be used for default interest. Note that this rate cannot be higher than the highest default interest allowed by the Central Bank of Iceland. If the default interest should be applied and this parameter is set to "0", the highest default interest allowed by the Central Bank of Iceland will be automatically applied.                                                                                                     |
| SpecialCode | Rule to be applied for the default interest. This value is a string with a code from the default interest rate rule table from RB (Dráttarvaxtareglur RB). See the complete list of codes available in the [rule table below](#ref129187046).                                                                                                                                                                                                    |

### *CurrencyInformation* <a href="#ref128129074" id="ref128129074"></a>

The class *CurrencyInformation* contains information for claims created in a foreign currency.

| Parameter     | Description                                                                                                                                                                                                                                                                                                                                                                         |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ReferenceRate | <p>Reference rate to be used.</p><p>Enum type <em>CurrencyInformationReferenceRate</em> with the following options:</p><ul><li><em>ExchangeRate</em> (ísl. almennt gengi)</li><li><em>NoteRate</em> (ísl. seðlagengi)</li><li><em>CentralBankMidRate</em> (ísl. miðgengi Seðlabanka Íslands)</li><li><em>CentralBankStatutoryRate</em> (ísl. lögboðið gengi, fundargengi)</li></ul> |
| Currency      | Three letter ISO 4217 code for the currency to be used (USD for example)                                                                                                                                                                                                                                                                                                            |
| PaymentRate   | <p>Spot rate (ísl. daggengi) to be used when issuing claim.</p><p>Enum type <em>CurrencyInformationPaymentRate</em> with the following options:</p><ul><li><em>DueDateRate</em> – Rate on due date</li><li><em>PaymentDateRate</em> – Rate on payment date</li></ul>                                                                                                                |

### *DiscountCharge* <a href="#ref128129391" id="ref128129391"></a>

The class *DiscountCharge* contains information on discount, either in a fixed value or a percentage.

| Parameter     | Description                                                                                                                                                                                     |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| First         | <p>Information on the first discount charge</p><p>Of class type <a href="#discountordefaultchargebase"><em>DiscountOrDefaultChargeBase</em></a></p>                                             |
| Second        | <p>Information on the second discount charge</p><p>Of class type <a href="#discountordefaultchargebase"><em>DiscountOrDefaultChargeBase</em></a></p>                                            |
| 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* <a href="#ref128129566" id="ref128129566"></a>

This functionality is not implemented.

### *Printing* <a href="#ref128129576" id="ref128129576"></a>

The class *Printing* contains information on how 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 (4.2.7.1) | Address of the claimant. If field is empty, the values from the national registry will be used.                        |
| PayorAddress (4.2.7.1)    | Address of payor. If field is empty, the values from the national registry will be used.                               |
| ItemRows                  | <p>A breakdown of the amount and fees of the claim.</p><p>Type Collection<<a href="#itemrow"><em>ItemRow</em></a>></p> |
| Comments                  | <p>List of comments printed at the bottom of the payment slip</p><p>Collection\<String></p>                            |

#### ***Address***

The class *Address* contains information on the address to be sent to

| 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 class *ItemRow* contains information on an individual amount or fee of the claim to be presented on the payment slip (see [Printing](#_ref128129576)).

| Parameter | Description                  |
| --------- | ---------------------------- |
| Text      | Description of fee or amount |
| Amount    | Amount                       |

## *ClaimInfo* <a href="#ref127972909" id="ref127972909"></a>

The class *ClaimInfo* contains comprehensive information on a single claim. The class is an output from the functions *QueryClaim* and *QueryClaims*.

| Parameter                               | Description                                                                                                                                                                   |
| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Key (4.4)                               | 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](#_ref128126952)   | 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 (4.2.2)                   | 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](#_ref128127261)       | Information on how the default interest (ísl. dráttarvextir) is caluclated. No interest fee will be added if this field is empty.                                             |
| CurrencyInformation (4.2.4)             | 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 (4.2.5)                        | 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](#_ref128129566) | Not implemented.                                                                                                                                                              |
| [Printing](#_ref128129576)              | 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* <a href="#ref127972751" id="ref127972751"></a>

The class *ClaimKey* is a unique key for a claim and does not change if a claim is edited. The *ClaimKey* is an input to the *CancelClaim, MarkClaimsForSecondaryCollection, QueryClaimTransactions* and *QueryClaim* functions. 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. 030166001234. |
| DueDate   | Due date of the claim                                                                                                                         |

## *ClaimOperationResult* <a href="#ref127972825" id="ref127972825"></a>

The class *ClaimOperationResult* contains information on a claim operation or the status of a batch claim. The class is an output in the *CreateClaim, AlterClaim, GetClaimOperationResult, ReCreateClaim* and *MarkClaimForSecondaryCollection* functions. If one or more claim raised an error, the batch could have the status *CompletedWithErrors,* in that case the successful claims will still be 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    | <p>Status of a claim batch that was operated on.</p><p>Of enum type <em>BatchStatus</em> with the following options:</p><ul><li>InProgress</li><li>Completed</li><li>CompletedWithErrors</li><li>NotConfirmed (Not implemented)</li></ul> |
| Success   | <p>List of claims in which the operation was successful.</p><p>Of type Collection<<em>ClaimResult></em> (4.5.1)</p>                                                                                                                       |
| Errors    | <p>List of claims in which the operation raised an error.</p><p>Of type Collection<<em>ClaimError></em> (4.5.2)</p>                                                                                                                       |

### *ClaimResult* <a href="#ref129195756" id="ref129195756"></a>

The class *ClaimResult* contains information on a claim in which an operation was successful on

| Parameter | Description                                                                                                                                                      |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Key (4.4) | Unique key for claim of class type *ClaimKey*                                                                                                                    |
| 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* <a href="#ref129195785" id="ref129195785"></a>

The class *ClaimError* contains information on a claim in which an operation raised an error on

| Parameter       | Description                                            |
| --------------- | ------------------------------------------------------ |
| Key (4.4)       | Unique key for claim of class type *ClaimKey*          |
| Error (4.5.2.1) | The error that was raised when operating on the claim. |

#### ***Error***

The class *Error* contains information the error code and message of an error raised by an operation

| Parameter | Description    |
| --------- | -------------- |
| Code      | Error code.    |
| Message   | Error message. |

## *operationId* <a href="#ref127972779" id="ref127972779"></a>

The string *operationId* is a unique identifier of a claim batch. It is used as an input to the *GetClaimOperationResult* function and and output for the *CreateClaims, AlterClaims, CancelClaims, ReCreateClaims* and *MarkClaimsForSecondaryCollection* functions.

## *ClaimsQuery* <a href="#ref127972795" id="ref127972795"></a>

The class *ClaimsQuery* is an input to the *QueryClaims* function. If more than one parameters are used in the query (payor and status = “Unpaid” for example), the query will return all of the claims have the status “Unpaid” for that payor. If no parameters are present, the query will return all of the claims of the claimant using the service.

| 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. Claims of all claim templates will be returned if this field is empty.                                          |
| Period (4.7.1) | Period and reference date to query claims from.                                                                                                                                        |
| Payor          | Kennitala (national registry ID number) of payor                                                                                                                                       |
| Status         | <p>Status of claim. Of enum type <em>ClaimStatus</em> with the following options:</p><ul><li>Unpaid</li><li>Paid</li><li>Cancelled</li><li>Invalid</li></ul>                           |
| State          | <p>Status of claim collection. Of enum type <em>ClaimState</em> with the following options:</p><ul><li>PrimaryCollection</li><li>SecondaryCollection</li><li>LegalCollection</li></ul> |
| RecordFrom     | Record entry number. Used to limit the number of claims returned.                                                                                                                      |
| RecordTo       | Record entry number. Used to limit the number of claims returned.                                                                                                                      |

### *ClaimsQueryDataSpan* <a href="#ref129197152" id="ref129197152"></a>

The class *ClaimsQueryDataSpan* contains information on the period in which to query from and what reference date should be used.

| Parameter             | Description                                                                                                                                                                                                                         |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| DateFrom              | Query from and including this date                                                                                                                                                                                                  |
| DateTo                | Query to and including this date                                                                                                                                                                                                    |
| DateSpanReferenceDate | <p>Reference date to query. Of enum type <em>DateSpanReferenceDate</em> with the following options:</p><ul><li>DueDate (ísl. gjalddagi)</li><li>FinalDueDate (ísl. eindagi)</li><li>CancellationDate</li><li>CreationDate</li></ul> |

## *QueryClaimsResult* <a href="#ref127972923" id="ref127972923"></a>

The class *QueryClaimsResult* contains a list of claims and the number of claims returned by the *QueryClaims* function.

| Parameter  | Description                                                 |
| ---------- | ----------------------------------------------------------- |
| TotalCount | Total count of claims returned by the query                 |
| Claims     | List of claims. Of class type Collection<*ClaimInfo* (4.3)> |

## *PaymentsQuery* <a href="#ref127972810" id="ref127972810"></a>

The class *PaymentsQuery* contains query parameters for the *QueryPayments* function. function. If more than one parameters are used in the query (Identifier and DisposalAccount for example), the query will return all payments that relate to both that account and that identifier (not other identifiers). If no parameters are present, the query will return all payments to all the claims of the claimant using the service.

| 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. Claims of all claim templates will be returned if this field is empty. |
| DisposalAccount     | Account to query from.                                                                                                                        |
| TransactionDateFrom | Query from and including this date                                                                                                            |
| TransactionDateTo   | Query to and including this date                                                                                                              |
| RecordFrom          | Record entry number. Used to limit the number of payments returned.                                                                           |
| RecordTo            | Record entry number. Used to limit the number of payments returned.                                                                           |

## *QueryPaymentsResult* <a href="#ref127972935" id="ref127972935"></a>

The class *QueryPaymentsResult* contains a list of payments and the number of payments returned by the *QueryPayments* function.

| Parameter  | Description                                                       |
| ---------- | ----------------------------------------------------------------- |
| TotalCount | Total count of payments returned by the query                     |
| Payments   | List of payments. Of class type Collection<*Payment* (4.11.24.3)> |

## *ClaimTransactionsResult* <a href="#ref127972966" id="ref127972966"></a>

The class *ClaimTransactionsResult* contains information on the history of all transactions made on a single claim. The class is an output from the *QueryClaimTransactions* function.

| Parameter    | Description                                                                 |
| ------------ | --------------------------------------------------------------------------- |
| Transactions | List of transactions. Of class type Collection<*ClaimTransaction* (4.11.1)> |

### *ClaimTransaction* <a href="#ref129201658" id="ref129201658"></a>

The class *ClaimTransaction* contains information on a transaction that has been made on a single claim. The *Claim* parameter will represent the claim after the transaction has been made. If the transaction includes a payment then information on the payment will be returned in the *Payment* parameter. The *ClaimTransaction* class will also include information on sent mail.

| Parameter                | Description                                                     |
| ------------------------ | --------------------------------------------------------------- |
| Claim (4.2)              | Information on the claim as stands after the transaction.       |
| Payment (4.11.2)         | Information on a payment if the transaction includes a payment. |
| TransactionType (4.11.3) | Type of transaction. Of enum type *ClaimTransactionType.*       |
| TransactionDate          | Date of transaction                                             |

### *Payment* <a href="#toc130917556" id="toc130917556"></a>

The *Payment* class contains information on a single payment

| Parameter                     | Description                                                                                                                                      |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Key                           | Unique key for claim of class type [*ClaimKey*](#_ref127972751)                                                                                  |
| PayorID                       | Kennitala (national registry ID number) of payor                                                                                                 |
| Amount                        | Claim amount                                                                                                                                     |
| FinalDueDate                  | Final due date (ísl. eindagi)                                                                                                                    |
| Identifier                    | Identifier of the claim template (ísl. kröfusniðmát) for the claimant.                                                                           |
| Reference                     | Alphanumerical reference number decided by the claimant.                                                                                         |
| CategoryCode                  | Category code (ísl. textalykill) that describes what kind of payment claim this is.                                                              |
| RedeemingBank                 | The bank that issued the claim                                                                                                                   |
| TransactionDate               | Transaction date of payment                                                                                                                      |
| BookingDate                   | Booking date of payment in the RB system                                                                                                         |
| ValueDate                     | The date in which default interest is calculated from.                                                                                           |
| PaymentType                   | <p>Payment type. Of enum type <em>PaymentType</em> which has the following options:</p><ul><li>Complete</li><li>Partial</li><li>Refund</li></ul> |
| AmountDeposited               | Amount that was deposited into the claimants account                                                                                             |
| TotalAmount                   | Total amount that was paid, including interest and fees.                                                                                         |
| CapitalGainsTax               | Deducted capital gains tax (ísl. fjármagnstekjuskattur)                                                                                          |
| BillNumber                    | Optional bill number (ísl. seðilnúmer) provided by claimant.                                                                                     |
| CustomerNumber                | Unique customer number of payor in the claimants accounting system.                                                                              |
| NoticeChargeAmount            | Notice charge amount paid (ísl. tilkynningargjald)                                                                                               |
| DefaultChargeAmount           | Default charge amount paid (ísl. vanskilagjald)                                                                                                  |
| OtherCostsAmount              | Other costs paid                                                                                                                                 |
| OtherDefaultCostAmount        | Other default cost paid (ísl. annar vanskilakostnaður)                                                                                           |
| DefaultInterestAmount         | Default interest amount paid (ísl. dráttarvextir)                                                                                                |
| DiscountAmount                | Discounted amount                                                                                                                                |
| Currency (4.11.2.1)           | Currency rate information, used for claims in foreign currency                                                                                   |
| BatchNumber                   | Batch number of payment                                                                                                                          |
| SecondaryCollectionIdentifier | Identifier of secondary collection (ísl. milliinnheimtuaðila), if applicable                                                                     |
| LegalCollectionIdentifier     | Identifier of legal collection (ísl. löginnheimtuaðila), if applicable                                                                           |

#### **CurrencyExchangeRate**

The class *CurrencyExchangeRate* contains information for the currency exchange rate for a payment. Used for claims in foreign currencies.

| Parameter | Description                                                            |
| --------- | ---------------------------------------------------------------------- |
| Currency  | Currency of the claim. Three letter ISO 4217 code (“USD” for example). |
| Rate      | The currency exchange rate                                             |

### ClaimTransactionType <a href="#ref129202073" id="ref129202073"></a>

The enum type *ClaimTransactionType* contains codes to classify transaction types, used in the *ClaimTransaction* class.

| Code                             | Description                                                                                                                                                                                |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Creation                         | Creation of claim                                                                                                                                                                          |
| Cancellation                     | <p>Cancelation of claim.</p><p>Can be initiated by claimant or an applied rule.</p>                                                                                                        |
| 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.                                                                                                                              |

## RB’s default interest rate rules (Dráttarvaxtareglur RB) <a href="#ref129187046" id="ref129187046"></a>

These codes represent rules decided by RB to be applied for the default interest.

<table data-header-hidden data-full-width="true"><thead><tr><th></th><th></th><th></th><th></th></tr></thead><tbody><tr><td>Default interest<br>rule</td><td>Calculation of no. of days</td><td>Reference date of calculation</td><td>Description</td></tr><tr><td>[empty]</td><td>360/360</td><td>Due date</td><td><p>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.</p><p>If default interest is imposed, it is calculated from due date to payment date</p></td></tr><tr><td>1</td><td>-</td><td>-</td><td>No penalty interest is imposed</td></tr><tr><td>2</td><td>360/360</td><td>Final due date</td><td>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</td></tr><tr><td>3</td><td>-</td><td>Final due date</td><td><p>1% penalty interest imposed per day. State claims.</p><p>If default interest is imposed, it is calculated from the final due date to the payment date.</p></td></tr><tr><td>4</td><td>actual/360</td><td>Due date</td><td>Same as default interest rule “2” except that the reference date of calculation is the due date.</td></tr><tr><td>5</td><td>actual/360</td><td>Due date</td><td>Same as default interest rule [empty] except that the number of days used in the calculation is actual/360.</td></tr><tr><td>6</td><td>actual/360</td><td>Final due date</td><td>Same as default interest rule “2” except that the number of days used in the calculation is actual/360</td></tr><tr><td>7</td><td>360/360</td><td>Due date</td><td>Same as default interest rule “4” except that the number of days used in the calculation is 360/360.</td></tr><tr><td>8</td><td>360/360</td><td>Due date</td><td><p>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.</p><p>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.</p></td></tr><tr><td>9</td><td>actual/360</td><td>Due date</td><td>Same as default interest rule “8” except that the number of days used in the calculation is actual/360.</td></tr><tr><td>B</td><td>360/360</td><td>Due date</td><td><p>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.</p><p>If default interest is imposed, it is calculated from the due date to the payment date.</p></td></tr><tr><td>C</td><td>-</td><td>Due date</td><td>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.</td></tr></tbody></table>

The reference time for calculation is always from 21:00 -21:00 for default interest rules 2,4,6,7,8,9,B.\
The reference time for calculation is always from 24:00 -24:00 for default interest rules \[empty] and 5

## *IOBSFault* <a href="#ref121929177" id="ref121929177"></a>

The Class *IOBSFault* has information on errors that can be raised.

| Output            | Description                                    |
| ----------------- | ---------------------------------------------- |
| GeneralErrorCode  | General error code                             |
| GeneralErrorText  | General error text, e.g., Business logic error |
| BanksErrorCode    | Technical error code from service provider     |
| BanksErrorText    | Technical error text from service provider     |
| GeneralSourceCode | Error code from source system                  |
| GeneralSourceText | Error text from source system                  |

| GeneralErrorCode | GeneralErrorText                       | Description                                                   |
| ---------------- | -------------------------------------- | ------------------------------------------------------------- |
| 0001             | Service is unavailable                 | The service is unavailable                                    |
| 1000             | An error occurred                      | General error message, with possible details                  |
| 1100             | Access to the operation is not present | The function is restricted and access is needed.              |
| 1200             | Data could not be validated            | Input data could not be validated according to the XML Schema |
| 1300             | Business logic error                   | General error in business logic                               |

{% code title="An example of an error:" lineNumbers="true" fullWidth="true" %}

```xml
<Fault>
    <Action>http://IcelandicOnlineBanking/2013/10/15/CreateClaim</Action>
    <Code>System.ServiceModel.FaultCode</Code>
    <Reason>Niðurfellingardagur eldri en gjalddagi.</Reason>
    <Detail>
        <IOBSFault>
            <GeneralErrorText>Business logic error.</GeneralErrorText>
            <GeneralErrorCode>1300</GeneralErrorCode>
            <BanksErrorText>Niðurfellingardagur eldri en gjalddagi.</BanksErrorText>
            <BanksErrorCode>13004</BanksErrorCode>
            <GeneralSourceText>Niðurfellingardagur eldri en gjalddagi.</GeneralSourceText>
            <GeneralSourceCode>00416</GeneralSourceCode>
        </IOBSFault>
    </Detail>
</Fault>
```

{% endcode %}
