GetSettlement on Id

GET

/orgs/{orgId}/settlements/{settlementId}

Endpoints for organization management operations

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Responses

🟢200

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/orgs//settlements/' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "summary": {
        "status": "string",
        "nextPageToken": "string"
    },
    "data": {
        "caseNumber": "string",
        "collectionType": "REMINDER",
        "currency": "string",
        "customerReference": "string",
        "exchangeRate": 0,
        "feeDistribution": {
            "collector": 0,
            "creditor": 0
        },
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "interestDistribution": {
            "collector": 0,
            "creditor": 0
        },
        "invoice": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "invoiceNumber": "string",
            "uniqueSourceInvoiceId": "string",
            "collectionCaseNumber": "string",
            "type": "REMINDER",
            "status": "OPEN",
            "closureDate": "2019-08-24T14:15:22.123Z"
        },
        "ledgerRef": "string",
        "organization": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "organizationNumber": "string",
            "name": "string"
        },
        "paymentAmount": 0,
        "principalDistribution": {
            "collector": 0,
            "creditor": 0
        },
        "remittanceDate": "2019-08-24T14:15:22.123Z",
        "settlementDate": "2019-08-24T14:15:22.123Z",
        "settlementNumber": 0,
        "settlementType": "COLLECTOR_PAYMENT",
        "vat": 0
    }
}

Modified at 2026-03-12 12:16:21

ResumeCase

GetSettlements