Retrieve settlements from an organization

GET

/orgs/{orgId}/settlements

Endpoint to create a new settlement in the system

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Path Params

Responses

🟢200OK

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠409Conflict

🟠422Unprocessable Entity

🟠423Locked

🟠429Too Many Requests

🔴500Internal Server Error

🔴501Not Implemented

🔴502Bad Gateway

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "summary": {
        "status": "string",
        "nextPageToken": "string"
    },
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "organization": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "organizationNumber": "string",
                "name": "string"
            },
            "date": "2019-08-24T14:15:22Z",
            "remittanceDate": "2019-08-24T14:15:22Z",
            "currency": "string",
            "paymentAmount": 0,
            "invoice": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "invoiceNumber": "string",
                "collectionCaseNumber": "string",
                "type": "string",
                "status": "string"
            },
            "principalDistribution": {
                "collector": 0,
                "creditor": 0
            },
            "feeDistribution": {
                "collector": 0,
                "creditor": 0
            },
            "interestDistribution": {
                "collector": 0,
                "creditor": 0
            },
            "vat": 0
        }
    ]
}

Modified at 2025-09-23 10:42:55

Get reports on a organization

/webapi/api/Attachment