Get Receivable

GET

/client-service/api/v1/receivables/{entityId}

Retrieve a specific receivable by its entityId

Request

Path Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

success response

Bodyapplication/json

Example

{
    "message": "receivableFetched",
    "entityId": "YgeeFcOegtHPSgvYngUaQ",
    "invoiceRef": "Invoice 6789",
    "uniqueRequestId": "24d564a9-f45a-44d2-9b31-340bdb8d92a1",
    "currencyIso3Code": "USD",
    "amount": 34540.25,
    "amountPaid": 34540.25,
    "payer": "XYZ Limited",
    "issueDate": "2026-05-28T00:00:00Z",
    "dueDate": "2026-06-13T00:00:00Z",
    "paidDate": "2025-05-30T15:38:29Z",
    "status": "paid",
    "fundingDetails": [
        {
            "accountName": "Receivables Corp.",
            "bankOrSortCode": "214",
            "bic": "FCMBNGLA",
            "accountNumber": "8700002499",
            "bankName": "FCMB",
            "bankAddress": "Primrose Tower, 17A, Tinubu Street, Marina, Lagos",
            "countryIso3Code": "USD"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

Modified at 2026-05-20 10:19:43

Create Receivable