---
title: "Retrieve a settlement"
url: "https://real-estate-agency.apim.eu/apis/commission-settlement/versions/6ae2ea20-d101-452a-9066-4c9c4d7d5fdc/operations/getSettlement"
---

> Full API specification: https://real-estate-agency.apim.eu/apis/commission-settlement/versions/6ae2ea20-d101-452a-9066-4c9c4d7d5fdc.md

# Retrieve a settlement

`GET` `/settlements/{settlementId}`

Operation ID: `getSettlement`

## Path parameters

- `settlementId` (string, required)

## Responses

- `200` - Settlement
- `404` - Record not found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Commission Settlement
  version: 1.0.0
servers:
  - url: https://api.realestateagency.example/v1
    description: Production
  - url: https://sandbox.api.realestateagency.example/v1
    description: Sandbox
paths:
  /settlements/{settlementId}:
    parameters:
      - name: settlementId
        in: path
        required: true
        schema:
          type: string
          example: stl_7c53
    get:
      tags:
        - Settlements
      summary: Retrieve a settlement
      operationId: getSettlement
      responses:
        "200":
          description: Settlement
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Settlement"
        "404":
          $ref: "#/components/responses/NotFound"
security:
  - apiKey: []
components:
  schemas:
    Settlement:
      type: object
      properties:
        id:
          type: string
          example: stl_7c53
        property_id:
          type: string
          example: prop_8f2c1a
        status:
          $ref: "#/components/schemas/SettlementStatus"
        deal_type:
          $ref: "#/components/schemas/DealType"
        assessment_basis_eur:
          type: integer
          example: 645000
        line_items:
          type: array
          items:
            $ref: "#/components/schemas/LineItem"
        invoice_id:
          type: string
          example: inv_a920
        due_date:
          type: string
          format: date
          example: 2026-08-28
        paid_eur:
          type: number
          format: float
          example: 0
        created_at:
          type: string
          format: date-time
          example: 2026-08-15T07:30:00Z
    SettlementStatus:
      type: string
      enum:
        - draft
        - open
        - partially_paid
        - paid
        - canceled
      example: open
    DealType:
      type: string
      enum:
        - sale
        - rental
        - commercial_rental
      example: sale
    LineItem:
      type: object
      properties:
        party:
          type: string
          enum:
            - buyer
            - seller
            - tenant
            - landlord
        rate_percent:
          type: number
          format: float
          example: 3.57
        net_eur:
          type: number
          format: float
          example: 19353.36
        tax_eur:
          type: number
          format: float
          example: 3677.14
        gross_eur:
          type: number
          format: float
          example: 23030.5
    Error:
      type: object
      description: Uniform error format across all Real Estate Agency APIs.
      required:
        - code
        - message
      properties:
        code:
          type: string
          example: validation_failed
        message:
          type: string
          example: The assessment basis is required to calculate the commission.
        details:
          type: array
          items:
            $ref: "#/components/schemas/ErrorDetail"
    ErrorDetail:
      type: object
      properties:
        field:
          type: string
          example: buyer_percent
        reason:
          type: string
          example: missing
  responses:
    NotFound:
      description: Record not found
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: |
        Every call carries an API key in the `apikey` header. You generate the
        key in the Real Estate portal under "My Apps"; it's shown exactly once.

        Each key has the scopes it's allowed to use attached to it. If one is
        missing, the API responds with `403` and `code: "scope_missing"`; the
        missing scope is in `details[].field`.
```