Skip to content

Get a sale transaction
Sales

Request

Returns detailed information about a sale transaction (compromis, offer, or lease). Requires SITE_PRODUCT:READ permission and RS:COMPROMIS_GET right.

Use ?include= to load additional relations. Available includes: compromis_cs, agencies, buyer, buyer_groups, buyer_address, buyer_origin, buyer_admin, buyer_gender, buyer_informations, buyer_extended, buyer_relations, seller, seller_groups, seller_address, seller_origin, seller_admin, followed_nego, recommandation, fees, fees_nego, analytic

Security
bearerAuth
Path
compromisIdintegerrequired

Unique identifier of the sale transaction (compromis).

Example:5678
Query
includestring

Comma-separated list of relations to include in the response. Each include triggers additional eager loading on the server side.

Example:include=buyer,seller,fees,agencies
curl -i -X GET \
  'https://api-doc.immo-facile.com/_mock/openapi/agreement/5678?include=buyer%2Cseller%2Cfees%2Cagencies' \
  -H 'Authorization: Bearer <YOUR_opaque_HERE>'

Responses

Sale transaction details

Bodyapplication/json
dataobject(SaleTransactionResponse)

A sale transaction (compromis, offer, or lease). Fields availability depends on the transaction type and the include parameter.

Response
{
  "data": {
    "id": 5678,
    "status": { … },
    "offer_status": "acceptee",
    "number": "COMP-2025-001",
    "transaction_type": "Vente",
    "product_id": 12345,
    "customer_id": 789,
    "seller_id": 790,
    "created_at": "2025-03-01T10:00:00+01:00",
    "updated_at": "2025-06-01T14:30:00+02:00",
    "date_agreement": "2025-03-15T00:00:00+01:00",
    "date_act": "2025-06-01T00:00:00+02:00",
    "date_cancellation": null,
    "buyer_price": 355000,
    "product_price": 350000
  }
}