Create a Recall

A recall is a process where a client chooses to withdraw a claim, either partially or entirely, from the debt collection process. This allows clients to stop further collection actions on specific invoices or the entire claim, depending on their requirements. Recalls are crucial for cases where clients have resolved issues directly with the debtor or need to make adjustments for any reason. There are two types of recalls available:

• Total Recall: In a total recall, the client withdraws the entire claim. All invoices and associated details are recalled, effectively stopping all collection efforts for that particular claim.
• Partial Recall: A partial recall allows the client to withdraw specific invoices associated with a claim, rather than recalling the entire claim. This is useful when adjustments or partial payments have been made that only affect certain parts of the claim.

Endpoint

POST {{collection_api_base_url}}/v1/claims/{claimNumber}/recalls

Total Recall

When a client opts for a total recall, all invoices associated with the specified claim are recalled. This action ceases all collection efforts for that claim.Upon a total recall, clients can expect to receive a confirmation of type recall. If they check the transaction status via the transaction endpoint immediately after the recall, it will eventually show the claim as closed with the closing type recalled_by_client.

Use Case

A client recalls the entire claim amount of €400. A confirmation of type recall is generated as shown below:

Sample Request Body

{}

Sample Response Body

[
...
{
        "sortNumber": 27,
        "id": "4d5983ed-526f-45f2-bde9-15746da13584",
        "type": "CONFIRMATION",
        "customerNumber": "K508647",
        "claimNumber": "DE-S242243704005",
        "confirmation": {
            "date": "2024-08-07",
            "type": "RECALL",
            "number": "K508647",
            "contractNumber": "",
            "amount": 400
        }
    }
]

Partial Recall

This option allows clients to selectively recall specific invoices tied to a claim. The remaining invoices continue through the collection process. Clients will receive confirmation of the partial recall and can track the status of each invoice via the transaction endpoint.

Use Case

A client recalls €100 of a €400 remaining debt, relating only to specific invoices. A confirmation of type partial_recall is generated as shown below:

Sample Request Body

{
  "invoiceNumber": "I0417211448",
  "contractNumber": "166271782837",
  "type": "CREDIT_WAIVER",
  "date": "2023-06-23",
  "description": "Quia molestias voluptates vero harum ea ea iste animi est.",
  "amount": 100,
  "currency": "EUR"
}

Sample Response Body

{
  "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Confirmation and Closing

Once a claim is recalled, the client will receive two responses:

• Confirmation: A transaction confirmation with type: "recall" indicates the recall request has been successfully processed.
• Closing: The claim will then be closed with type: "recalled_by_client", indicating that the claim has been recalled and the collection process is inactive.

Find below sample transaction responses for confirmation and closing of claim previously recalled by a client:

Sample Confirmation of Recall (closing type: "recalled_by_client")

{
    "sortNumber": 0,
    "id": "de51a3d6-fead-4a92-b613-e79057c12319",
    "type": "CLOSING",
    "customerNumber": "brak008-45544456",
    "claimNumber": "DE-S242243747003",
    "closing": {
        "date": "2024-09-11",
        "type": "RECALLED_BY_CLIENT"
    }
},
{
    "sortNumber": 1,
    "id": "e7f49fa3-3ebd-49aa-b71e-92411489b329",
    "type": "CONFIRMATION",
    "customerNumber": "brak008-45544456",
    "claimNumber": "DE-S242243747003",
    "confirmation": {
        "date": "2024-09-11",
        "type": "RECALL",
        "number": "brak008-45544456",
        "contractNumber": "",
        "amount": 0
    }
}

Handling Previously Recalled Claims

• Recalled by Client: If a client tries to recall a claim already closed with type: "recalled_by_client", Riverty will send a rejection of type: "recall", with a "description" explaining that the recall was rejected due to the previous client-initiated recall.
  A client cannot recall a claim already recalled by themselves.
• Other Closing Types: If a claim was closed for other reasons (e.g., liquidation or fraud), the client can still initiate a recall. Refer to our documentation on closing to learn more about closing types.

Find below sample transaction response when a client recalls a previosly recalled claim with closing type: "recalled_by_client":

Sample Rejection Response

{
    "sortNumber": 2,
    "id": "1b142099-32a6-4c05-8416-3d465fd423a7",
    "type": "REJECTION",
    "customerNumber": "brak008-45544456",
    "claimNumber": "DE-S242243747003",
    "rejection": {
        "date": "2024-09-11",
        "type": "RECALL",
        "description": "Das Verfahren ist bereits eingestellt.",
        "number": "brak008-45544456",
        "contractNumber": "",
        "reason": "OTHER"
    }
}

Please Note: The confirmation, closing, and other relevant responses can only be retrieved when the client proactively calls the transaction endpoint. Make sure to check the transaction endpoint regularly for status updates.

Accounting Document

An accounting document is automatically generated whenever a recall is initiated, whether it is partial or total. This document records the transaction details and helps maintain accurate financial records. An accounting document with the type will be associated with the recall action to ensure proper tracking and compliance. Read our documentation on accounting document to learn more.