> 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/functions.md).

# Functions

The service for claims in secondary collection enables the secondary collection agent to modify and cancel claims. The agent can also return claims from secondary collection back to the claimant. Additionally, they can retrieve a list of claims based on specified search criteria, providing a good overview of the claims of a specific claimant in secondary collection. It is also possible to obtain a list of executed payments and information about the history of a claim. 

## Modify a Claim 

The AlterClaim operation modifies a previously created collection claim. The entire claim is submitted and updated according to new information. The claim identifier must consist of the prefix MI and one alphanumeric character. This is a direct operation, so an immediate response is provided on whether the modification was successful. 

## Modify Multiple Claims 

The AlterClaims operation modifies a list of previously created collection claims. The identifiers of the claims must consist of the prefix MI and one alphanumeric character. The operation returns a unique key that can be used to fetch the results of the modification using the GetClaimOperationResult operation. 

## Cancel a Claim 

The CancelClaim operation cancels an unpaid collection claim. Paid or partially paid claims cannot be canceled. The collection agent can cancel claims that have been transferred to secondary collection. The claim identifier must consist of the prefix MI and one alphanumeric character. A unique claim key is submitted. This is a direct operation, so an immediate response is provided on whether the cancellation was successful. 

## Cancel Multiple Claims 

The CancelClaims operation cancels a batch of unpaid collection claims. Paid or partially paid claims cannot be canceled. The collection agent can cancel claims that have been transferred to secondary collection. The identifiers of the claims must consist of the prefix MI and one alphanumeric character. The operation returns a unique key that can be used to fetch the results of the cancellation using the GetClaimOperationResult operation. 

## Return a Claim from Secondary Collection 

The SecondaryCollectionReturnClaim operation returns a collection claim that is in secondary collection or has been opened for the secondary collection agent to the claimant, using the original claim identifier with the fees and costs agreed upon by the claimant and the secondary collection agent. This is a direct operation, so an immediate response is provided on whether the operation was successful. 

## Return Multiple Claims from Secondary Collection 

The SecondaryCollectionReturnClaims operation returns one or more collection claims that are in secondary collection or have been opened for the collection agent to the claimant, using the original identifiers with the fees and costs agreed upon by the claimant and the secondary collection agent. The operation returns a unique key that can be used to fetch the results of the return using the GetClaimOperationResult operation. 

## Query Claim Batch 

The GetClaimOperationResult operation retrieves information about a specific claim batch based on a unique identifier, including the status of the claims in the batch. The unique identifier can be the output of the AlterClaims, CancelClaims, or SecondaryCollectionReturnClaims operations. In the 2013 schema, batches are processed concurrently, meaning a unique batch processing identifier is returned while the batch is being sent to RB, reducing response times for batch-related operations. The accounting system then calls GetClaimOperationResult to obtain information about the batch processing status. If the batch processing is incomplete, the response will indicate that the batch is "InProgress." 

## Retrieve a Claim 

The QueryClaim operation returns all details about a collection claim based on the unique claim key. The unique claim key consists of the claimant’s ID number, the claim number, and the due date of the collection claim. Information can only be retrieved for claims in secondary collection. 

## Retrieve Multiple Claims 

The QueryClaims operation returns a list of collection claims for a specific claimant in secondary collection based on the search criteria submitted. The operation also returns the total number of records in the list. Claims can be filtered by time period, debtor, claim status (e.g., paid, unpaid, canceled, or invalid). The number of records in the output can be limited by specifying a start and end record. Note that claims not marked for secondary collection cannot be retrieved. The QueryClaims and QuerySecondaryCollectionClaims functions are both used to retrieve claims for a specific claimant in secondary collection. 

## Retrieve Claims Marked for Secondary Collection 

The QuerySecondaryCollectionClaims operation returns a list of collection claims based on the specified claimant, along with the total number of records in the list. A maximum of 5,000 claims can be returned per request. This operation is used to retrieve claims marked for secondary collection. Each item in the list contains all details about the respective collection claim. 

## Retrieve Payments 

The QuerySecondaryCollectionPayments operation returns a list of payments that have been executed based on the submitted search criteria. The operation also returns the total number of records in the list. Payments can be filtered by the ID number of a specific claimant and time period. The number of records in the output can also be limited by specifying a range. Note that only payments for claims in secondary collection are included in the results. 

## Retrieve Claim History 

The QueryClaimTransactions operation returns the entire history of a claim based on its unique claim key. All changes made to the collection claim, along with details about the claim itself, are included in the output. Additionally, information about letters sent in relation to the claim is provided. Only claims in secondary collection can have their history retrieved.