> 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/use-cases-and-functions.md). # Use cases and functions The service includes functions like creating, editing, and cancelling claims and also querying information on claims and claim payments. The operations are available for both single claims and claim batches and support claims in foreign currencies. It is also possible to mark claims for secondary collection and fetch the transaction history of a claim which includes all changes that have been made on the claim. The use cases and functions of the service are listed below. ## Create claims Users can create claims from their account systems via the B2B claims service. If the claim creation was successful, the claims will be created in RB’s centralized claim pool (ísl. kröfupottur RB) and will be visible to payors in the online interface of all banks in Iceland. Claimants also can view and edit their claims in Arion’s online bank, see chapter 3 for further details. ### *CreateClaim* The function *CreateClaim* creates a single claim and returns information on whether the creation was successful or not. ### *CreateClaims* The function *CreateClaims* creates multiple claims. The call returns a unique identifier for the claim batch that can be used in the *GetClaimOperationResult* function to fetch information on the operation result. ## Alter claims Claimants can edit individual fields on their claims from their account systems via the B2B claims service. If the claim edit was successful, the claims will be updated in RB’s centralized claim pool (ísl. kröfupottur RB) and the updates will be visible to payors in the online interface of all banks in Iceland. Claimants can also view and edit their claims in Arion’s online bank, see chapter 3 for further details. ### *AlterClaim* The function *AlterClaim* edits an existing claim and returns information on whether the edit was successful or not. The whole claim is submitted to the function with new values. ### *AlterClaims* The function *AlterClaims* edits a list of existing claims and returns a unique identifier for the claim batch that can be used in the *GetClaimOperationResult* function to fetch information on the operation result. ## Cancel claims Claimants can cancel claims from their account systems via the B2B claims service. If the claim cancelation was successful, the claims will be marked cancelled in RB’s centralized claim pool (ísl. kröfupottur RB) and will no longer visible to payors in the online interface of all banks in Iceland. Claimants can also cancel their claims in Arion’s online bank, see chapter 3 for further details. Note that it is not possible to cancel a claim that has been partially or fully paid. ### *CancelClaim* The function *CancelClaim* cancels an existing unpaid claim and returns information on whether the operation was successful. ### *CancelClaims* The function *CancelClaims* cancels a batch of unpaid claims and returns a unique identifier for the claim batch that can be used in the *GetClaimOperationResult* function to fetch information on the operation result. ## Re-create claims Claimants can re-create claims from their account systems via the B2B claims service. If the re-creation was successful, the claims will be re-created in RB’s centralized claim pool (ísl. kröfupottur RB) and will be visible to payors in the online interface of all banks in Iceland. Claimants also can re-create their claims in Arion’s online bank, see chapter 3 for further details. Note that for claims to be re-created, they need to have the status “canceled” and 4 years cannot have passed since their original creation. If their cancellation dates have passed, the cancelation dates must be corrected when re-creating the claims. ### *ReCreateClaim* The function *ReCreateClaim* re-creates a single claim that has previously been canceled and returns information on whether the operation was successful. ### *ReCreateClaims* The function *ReCreateClaims* re-creates multiple claims that have been canceled and returns a unique identifier for the claim batch that can be used in the *GetClaimOperationResult* function to fetch information on the operation result. ## Mark claims for secondary collection Claimants can mark claims for secondary collection from their account systems via the B2B claims service. If the operation was successful, the claims will be marked for secondary collection in RB’s centralized claim pool (ísl. kröfupottur RB) and the secondary collector will be able to make changes to the claims. For the claims to be marked for secondary collection, the claims must be unpaid and have a secondary collector assigned. The claims will receive a three-character identifier starting with “MI” corresponding to the secondary collector. ### *MarkClaimForSecondaryCollection* The function *MarkClaimForSecondaryCollection* marks a single claim for secondary collection and returns information on whether the operation was successful. ### *MarkClaimsForSecondaryCollection* The function *MarkClaimsForSecondaryCollection* marks multiple claims for secondary collection and returns a unique identifier for the claim batch that can be used in the *GetClaimOperationResult* function to fetch information on the operation result. ## Query claims Claimants can query claims from their account system via the B2B claims service. It is possible to query a single claim by its *ClaimKey* or multiple claims by using query parameters listed in chapter 4.7. When querying multiple claims, a list is returned with a maximum of 5000 claims. It is possible to limit the number of claims returned by adjusting the record range. By using different parameters when querying multiple claims, it is possible to produce lists of: * Paid claims * Unpaid claims * Canceled claims * Voided claims * Claims marked for secondary collection (ísl. milliinnheimta) * Claims marked for legal collection (ísl. löginnheimta) * Claims marked for primary collection (ísl. fruminnheimta) * Claims by time period * By due date (ísl. gjalddagi) * By final due date (ísl. eindagi) * By cancellation date * By creation date * Claims by claim template identifier (ísl. einkenni kröfusniðmáts) * Claims by payor ### *QueryClaim* The function *QueryClaim* returns information on a single claim. The claim identifier *ClaimKey* is used as a query parameter and consists of the kennitala of claimant, claim number and due date of the claim. ### *QueryClaims* The function *QueryClaims* returns information on multiple claims. It is possible to use multiple parameters to query from such as claim template identifier (ísl. auðkenni kröfusniðmáts), date range, payor, claim status and more. ## Query payments Claimants can query claim payments from their account system via the B2B claims service. It is possible to use multiple parameters to query from such as kennitala of claimant, claim template identifier (ísl. auðkenni kröfusniðmáts), disposal account and date range. It is also possible to limit the number of payments returned by adjusting the record range. ### *QueryPayments* The function *QueryPayments* returns a list of all payments that relate to the query parameters submitted. ## Query claim transactions Claimants can query claim transactions from their account system via the B2B claims service. The query returns the whole transaction history of a claim as a list. An example of a transaction could be a creation, a payment, or a collection reminder sent by bank (a complete list of transaction types can be found in chapter 4.11.3). ### *QueryClaimTransactions* The function *QueryClaimTransactions* returns the whole transaction history of a claim as a list. ## Query claim batch status By using the *operationId* returned when creating, re-creating, altering, or cancelling a batch, claimants can fetch the result of the operation. The query will return a batch status along with a list of claims where the operation was successful and a list of claims where the operation failed. Further details on the different batch statuses can be found in chapter 4.5. ### *GetClaimOperationResult* The function *GetClaimOperationResult* returns information on a claim batch status and the status of each individual claim within it. If the batch is still being processed, the function will return the status “InProgress” for the batch.