---
title: "Gets the payments of the specified lease schedule. Displayed in lease schedule payment details."
url: "https://developer.tesma.com/apis/tesma-platform-api-v1/versions/333907fb-f0a7-4e20-b01e-c9915c73321a/paths/v1-leases-leaseCompanyNumber---leaseScheduleId--payments/get"
---

> Full API specification: https://developer.tesma.com/apis/tesma-platform-api-v1/versions/333907fb-f0a7-4e20-b01e-c9915c73321a.md

# Gets the payments of the specified lease schedule. Displayed in lease schedule payment details.

`GET` `/v1/leases/{leaseCompanyNumber}/{leaseScheduleId}/payments`

## Path parameters

- `leaseCompanyNumber` (integer, int32, required) - The lease company number.
- `leaseScheduleId` (integer, int32, required) - The lease schedule identifier.

## Header parameters

- `CorporateGroup-Name` (string, optional) - Corporate group key that assigns the currently selected corporate group to the request.

## Responses

- `200` - OK
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.1.1
info:
  title: tesma
  version: v1
servers:
  - url: https://api.tesma.com
paths:
  /v1/leases/{leaseCompanyNumber}/{leaseScheduleId}/payments:
    get:
      parameters:
        - description: The lease company number.
          in: path
          name: leaseCompanyNumber
          required: true
          schema:
            format: int32
            minimum: 1
            type: integer
        - description: The lease schedule identifier.
          in: path
          name: leaseScheduleId
          required: true
          schema:
            format: int32
            minimum: 1
            type: integer
        - description: Corporate group key that assigns the currently selected corporate
            group to the request.
          in: header
          name: CorporateGroup-Name
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LeaseSchedulePaymentResponse"
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationProblemDetails"
          description: Bad Request
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
        "404":
          description: Not Found
      summary: Gets the payments of the specified lease schedule. Displayed in lease
        schedule payment details.
      tags:
        - LeaseSchedulePayment
security:
  - PersonalAccessToken: []
components:
  schemas:
    LeaseSchedulePaymentResponse:
      additionalProperties: false
      properties:
        currency:
          type:
            - "null"
            - string
        customerContext:
          $ref: "#/components/schemas/CustomerContextResponse"
        leaseScheduleId:
          format: int32
          type: integer
        paidAmount:
          format: double
          type: number
        totalAmount:
          format: double
          type: number
      type: object
    ValidationProblemDetails:
      additionalProperties: {}
      properties:
        detail:
          type:
            - "null"
            - string
        errors:
          additionalProperties:
            items:
              type: string
            type: array
          type:
            - "null"
            - object
        instance:
          type:
            - "null"
            - string
        status:
          format: int32
          type:
            - "null"
            - integer
        title:
          type:
            - "null"
            - string
        type:
          type:
            - "null"
            - string
      type: object
    CustomerContextResponse:
      additionalProperties: false
      properties:
        customerName:
          type:
            - "null"
            - string
        customerNumber:
          format: int32
          type: integer
        leaseCompany:
          format: int32
          type: integer
        leaseCompanyName:
          type:
            - "null"
            - string
      type: object
  securitySchemes:
    PersonalAccessToken:
      description: Authentication using the Personal Access Token generated in tesma UI.
      in: header
      name: X-API-KEY
      type: apiKey
```