Retrieve collection case

GET

https://api.cash-in.com/v2/caseinquiry

This API endpoint is for the Creditor to inquire collection case identifiers for the collection receivables (invoice number and reference). Data returned contains collection case id, status, outstanding capital amount and latest payment date for the invoice.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Query Params

Responses

🟢200

application/json

Case inquiry found

Body

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.cash-in.com/v2/caseinquiry?invoiceNumber&invoiceReference&extended' \
--header 'X-Api-Key: <api-key>'

Response Example

200 - Example 1

[
    {
        "CollectionCaseId": 0,
        "InvoiceNumber": "string",
        "InvoiceReference": "string",
        "CollectionStatusId": 0,
        "CollectionOutstandingCapitalAmt": 0,
        "CollectionLatestPaymentDate": "2019-08-24T14:15:22.123Z",
        "ReceivedPaymentsQty": 0,
        "OriginalInvoiceCapitalAmt": 0,
        "TotalInvoicePaidAmt": 0,
        "CreditorCostsAmt": 0,
        "CreditorPaidCostsAmt": 0,
        "CreditorOutstandingCostsAmt": 0,
        "AccruedInterestAmt": 0,
        "PaidInterestAmt": 0,
        "OutstandingInterestAmt": 0
    }
]

Retrieve Case Batch Status

Retrieve debtor summary