Contract
Rental contracts.
GET/api/contracts/{id}
Retrieves a Contract resource.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | yes | Contract identifier |
Code samples
curl -X GET 'https://sandbox.partner.miete24.com/api/contracts/{id}' \
-H 'X-Api-Key: YOUR_API_KEY'
const response = await fetch('https://sandbox.partner.miete24.com/api/contracts/{id}', {
method: 'GET',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Contract resource | Contract |
| 404 | Resource not found | — |
PATCH/api/contracts/{id}/edit-contract-number
Updates the Contract resource.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | yes | Contract identifier |
Code samples
curl -X PATCH 'https://sandbox.partner.miete24.com/api/contracts/{id}/edit-contract-number' \
-H 'X-Api-Key: YOUR_API_KEY'
const response = await fetch('https://sandbox.partner.miete24.com/api/contracts/{id}/edit-contract-number', {
method: 'PATCH',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Contract resource updated | Contract.ContractNumberResponse |
| 400 | Invalid input | — |
| 403 | Forbidden | — |
| 404 | Resource not found | — |
| 422 | Unprocessable entity | — |