riverty logo

Docs

Create a Recall

Path

POST /claims/{claimNumber}/recalls

Request Parameters

claimNumber
required
string
Refers to an existing claim

Request Body

application/json

invoiceNumber
string
Max length: 40
The invoice number assigned by the client for each invoice.
contractNumber
string
Max length: 40
A client-assigned contract number associated with this payment.
type
string
Max length: 20
Enum:

PAYMENT

CREDIT_WAIVER

INSOLVENCY

COMPANY_LIQUIDATED

RECALL

NO_DOCUMENTATION

CUSTOMER_DECEASED

NO_GOODS_OR_SERVICE_TRANSFER

STATUTE_BARRED

FRAUD

CUSTOMER_INCAPABLE_OF_CONTRACTING

CUSTOMER_RELOCATED

SECOND_PLACEMENT

The type of the recall.
description
string
Max length: 256
This is a description of the recall.
date
string
yyyy-MM-dd
Max length: 10
The date of the recall.
currency
string
Max length: 3
This reflects all relevant currencies in ISO-4217.
amount
number
Max length: 12
This is a description of the costs.

Responses

Successful Request - Partial RecallSuccesful Request -Total Recall

Request Example

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

Response Example

    
        {
 "requestId": "eebc4f79-2288-4a2d-9439-50113f30d852"
}