> 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-secondary-collection-claim-service/use-cases.md).

# Use Cases

## Modify Claim(s) 

A user in the accounting system modifies the conditions for the collection of claims and sends a batch of claims to the B2B Secondary Collection Claim Service. An example would be changing the interest rate rule or the due date. \
For a claim to be modified, it must be in secondary collection. The user receives a unique identifier for the batch and can query the batch to retrieve its status and any errors that occurred, if applicable. The claims are updated in the central Claims Pool at the Icelandic Banking Data Centre (RB), and the updates are reflected in the online banking systems of all commercial banks. 

A user in the accounting system modifies the conditions for a single claim and sends it to the B2B Secondary Collection Claim Service. The claim must be in secondary collection to be modified. The user immediately receives information about whether the update was successful or an error occurred. The claim is updated in the central Claims Pool at RB, and the update is reflected in the online banking systems of all commercial banks. 

## Cancel Claim(s) 

A user in the accounting system selects claims to be canceled and sends a batch of claims to the B2B Secondary Collection Claim Service. To cancel a claim, it must be unpaid and in secondary collection. The user receives a unique identifier for the batch and can query the batch to retrieve its status and any errors that occurred, if applicable. The claims are canceled in the central Claims Pool at RB, and the cancellations are reflected in the online banking systems of all commercial banks. A user in the accounting system selects a single claim to be canceled and sends it to the B2B Secondary Collection Claim Service. To cancel a claim, it must be unpaid and in secondary collection. The user immediately receives information about whether the cancellation was successful or an error occurred. The claim is canceled in the central Claims Pool at RB, and the cancellation is reflected in the online banking systems of all commercial banks. 

## Return Claim(s) from Secondary Collection 

A user in the accounting system selects claims to be returned from secondary collection and sends a batch of claims to the B2B Secondary Collection Claim Service. The user receives a unique identifier for the batch and can query the batch to retrieve its status and any errors that occurred, if applicable. A user in the accounting system selects a single claim to be returned from secondary collection and sends it to the B2B Secondary Collection Claim Service. The user immediately receives information about whether the operation was successful or an error occurred. 

## Queries

### View Claims 

A user in the accounting system submits search criteria. A list is returned containing all information about the claims found and the number of records in the list. If no claims are found, the list is empty. A maximum of 5,000 claims can be returned. Claims can be filtered by time period, debtor, or claim status (e.g., paid, unpaid, canceled, or invalid). The number of records in the output can also be limited by specifying a range. 

#### Examples of status lists that can be retrieved:

* Debtor list: All claims of a specific claimant in secondary collection 
* Paid claims of a specific claimant in secondary collection 
* Unpaid claims of a specific claimant in secondary collection 
* Canceled claims of a specific claimant in secondary collection 
* Invalid claims of a specific claimant in secondary collection 
* Claims of a specific claimant in secondary collection, filtered by time period: 
  * With due dates from and to 
  * With final payment dates from and to 
  * With cancellation dates from and to 
  * With creation dates from and to 
* Claims of a specific claimant in secondary collection, filtered by debtor

### View Claim 

A user in the accounting system submits the unique key of a claim to retrieve. All information about the claim is returned. Information can only be retrieved for claims in secondary collection. 

### View Claims Marked for Secondary Collection 

This operation is used to retrieve claims that have been marked for secondary collection. A user in the accounting system submits the ID number of the claimant whose claims are to be retrieved, along with other search criteria. A list is returned with all information about the claims found and the number of records in the list. If no claims are found, the list is empty. A maximum of 5,000 claims can be returned. 

### View a Claim Marked for Secondary Collection 

A user in the accounting system submits the unique key of a claim to retrieve. All information about the claim is returned. Information can only be retrieved for claims in secondary collection. 

### View Payments 

A user in the accounting system submits a query for payments related to claims. The user receives the total number of records returned by the query and a list of payments. Payments can be filtered by the claimant’s ID number and time period. The number of records in the output can also be limited by specifying a range. Information can only be retrieved for payments related to claims in secondary collection. 

### View Claim History 

A user in the accounting system submits the unique key of a claim to retrieve its history. The user receives a list of claim statuses linked to specific actions or transactions. Information about letters sent in relation to the claim is also returned. Information can only be retrieved for claims in secondary collection. 

### View Payment Batch Status 

A user in the accounting system submits the unique identifier of a payment batch, which is an output from operations such as modifying claims, canceling claims, or returning claims from secondary collection. The user receives a response about the batch’s status, which can be InProgress, Completed, or CompletedWithErrors. If the batch status is Completed or CompletedWithErrors, the output includes a list of claim numbers for successful operations and a list of claim numbers that encountered errors, along with the error details.