Skip to content

Financing Case

Financing cases and their status.

GET/api/financing_cases

Retrieves the collection of FinancingCase resources.

Parameters

Path and query parameters for GET /api/financing_cases
Name In Type Required Description
page query integer no The collection page number

Code samples

curl -X GET 'https://sandbox.partner.miete24.com/api/financing_cases' \
  -H 'X-Api-Key: YOUR_API_KEY'

Responses

Responses for GET /api/financing_cases
Status Description Schema
200 FinancingCase collection array<FinancingCase-financing_case.read>

GET/api/financing_cases/{id}

Retrieves a FinancingCase resource.

Parameters

Path and query parameters for GET /api/financing_cases/{id}
Name In Type Required Description
id path string yes FinancingCase identifier

Code samples

curl -X GET 'https://sandbox.partner.miete24.com/api/financing_cases/{id}' \
  -H 'X-Api-Key: YOUR_API_KEY'

Responses

Responses for GET /api/financing_cases/{id}
Status Description Schema
200 FinancingCase resource FinancingCase-financing_case.read
404 Resource not found

POST/api/financing_cases/{id}/cancel

Cancel a financing case

Cancels a financing case owned by the calling partner: the associated quote and, where applicable, contract are transitioned to CANCELED, document tokens are invalidated and open callback requests are closed. Requires a valid API key (ROLE_API_USER) and only operates on financing cases belonging to the calling partner. Status rules: a partner may cancel while the case is in a regular status. Cancellation past internal-approval points is reserved for the Miete24 Approval Team and is refused for partners — quotes in IN_PROGRESS, REJECTED_BY_CUSTOMER or FINANCE_REJECTED, and contracts after signing (signed, post_processing_required, delivery_approved, invoice_checked, completed). A signed contract therefore stays active even when its quote is canceled; an already canceled case is terminal. On success the financer / distribution hub is notified by email (where a contact address is configured) and, for partners with an active webhook endpoint, a financing_case.status_changed webhook is emitted. Responds 204 on success, 401 without a valid API key, 403 for a case owned by another partner, 404 if the case does not exist, and 422 if the case cannot be canceled in its current status.

Parameters

Path and query parameters for POST /api/financing_cases/{id}/cancel
Name In Type Required Description
id path string yes FinancingCase identifier

Code samples

curl -X POST 'https://sandbox.partner.miete24.com/api/financing_cases/{id}/cancel' \
  -H 'X-Api-Key: YOUR_API_KEY'

Responses

Responses for POST /api/financing_cases/{id}/cancel
Status Description Schema
204 FinancingCase resource created
400 Invalid input
403 Forbidden
422 Unprocessable entity