---
title: "Lease Schedules"
description: "This article explains the fields contained in responses and requests sent from and to the lease API endpoint."
url: "https://developer.tesma.com/apis/tesma-platform-api-v1/docs/leases-chedules"
image: "https://developer.tesma.com/_og/d/c_Ocean.takumi,title_Lease+Schedules,description_This+article+explains+the+fields+contained+in+responses+and+requests+sent+from+and+to+the+lease+API+endpoint.,props_eyJ0aGVtZSI6eyJtb2RlIjoibGlnaHQiLCJjb2xvcnMiOnsicHJpbWFyeSI6IiM0Mjg1ZjQifX19,p_Ii9hcGlzL3Rlc21hLXBsYXRmb3JtLWFwaS12MS9kb2NzL2xlYXNlcy1jaGVkdWxlcyI,s_uLt-AebUbSjOGEi2.png"
---

# Lease Schedules

This article explains the fields contained in responses and requests sent from and to the lease API endpoint.

## [General information](#general-information)

The general asset response contains all properties and is therefore used to describe the meaning of the field values. An example of a single asset may look like this:

```json
"customerContext": {
  "customerName": "Testcompany GmbH",
  "leaseCompanyName": "CHG-MERIDIAN AG",
  "customerNumber": 903544,
  "leaseCompany": 1
},
  "status": "Active",
  "leaseScheduleId": 0,
  "leaseStartDate": "2023-06-29",
  "actualLeaseTerm": 0,
  "actualLeaseEndDate": "2023-06-29",
  "leaseOrderNumber": "string",
  "locationOfInstallation": "string",
  "leaseScheduleReference": "string",
  "minimumLeaseTermEndDate": "2023-06-29",
  "minimumLeaseTermStartDate": "2023-06-29",
  "plannedLeaseEndDate": "2023-06-29",
  "isCanceled": true,
  "cancellationDate": "2023-06-29",
  "isCarbonZero": true,
  "periodicalPrice": 0,
  "usagePeriod": "monthly",
  "currency": "string"
}
```

A lease schedule is uniquely identified by a combination of the leaseScheduleId and leaseCompany.

## [Asset properties](#asset-properties)

| Property                  | Description                                                            | Remarks                                                      |
| :------------------------ | :--------------------------------------------------------------------- | :----------------------------------------------------------- |
| customerContext           | Customer context which consists of the lease company and the customer  |                                                              |
| status                    | Unknown, Initial, Active, Inactive                                     |                                                              |
| leaseScheduleId           | CHG lease schedule id                                                  |                                                              |
| leaseStartDate            | Lease start date for the lease schedule                                |                                                              |
| actualLeaseTerm           | Total running time                                                     |                                                              |
| actualLeaseEndDate        | Financial lease end of the lease schedule                              |                                                              |
| leaseOrderNumber          | Customer installation data (invoice relevant)                          | Editable via PATCH                                           |
| locationOfInstallation    | Customer installation data (invoice relevant)                          | Editable via PATCH                                           |
| leaseScheduleReference    | Internal lease schedule reference                                      |                                                              |
| minimumLeaseTermEndDate   | Minimum lease term of the lease schedule                               |                                                              |
| minimumLeaseTermStartDate | Minimum lease start of the lease schedule                              |                                                              |
| plannedLeaseEndDate       | Future lease end of the lease schedule                                 |                                                              |
| isCanceled                | Is the lease schedule canceled                                         |                                                              |
| cancellationDate          | Date the lease schedule has been canceled                              |                                                              |
| isCarbonZero              | Carbon Zero certified                                                  |                                                              |
| periodicalPrice           | Leasing price for the current period (determined by field usagePeriod) |                                                              |
| usagePeriod               | The current payment/usage period                                       | Possible enum values: monthly, quarterly, semiyearly, yearly |
| currency                  | Currency of current periodicalPrice                                    | ISO 4217 Code, e.g. EUR                                      |

## [Example requests](#example-requests)

### [All active lease schedules](#all-active-lease-schedules)

To query for the active lease schedules use this filter setup `filter=["status", "=", "Active"]`

### [All lease schedules of the last 3 months](#all-lease-schedules-of-the-last-3-months)

To get the latest lease schedules of the last 3 months use this filter `filter=[["leaseStartDate", "<=", "2023-03-01"]]` Date is today - 3 months

### [All ending lease schedules](#all-ending-lease-schedules)

To get the ending lease schedules of the next 6 months use this filter `filter=[["plannedLeaseEndDate", ">=", "2023-03-01"]]` Date is today + 6 months