Skip to content

Update a sale transaction
Sales

Request

Updates billing and invoicing fields on a sale transaction. Requires SITE_PRODUCT:WRITE permission and RS:COMPROMIS_UPDATE right.

Important limitations:

  • This endpoint only accepts billing/invoicing fields (conformity, payment, invoice numbers, fees).
  • It does NOT allow updating: buyer_price, product_price, date_act, date_agreement, status.
  • Sale price and deed date are set when the agreement is created in the back-office.
  • There is no POST /agreement endpoint in the Site API context — sale agreements are created via the internal user interface or the User API.

Fees: Each fee entry must reference an existing id from the transaction's fee records and provide a percentage between 0 and 100.

Security
bearerAuth
Path
compromisIdintegerrequired

Unique identifier of the sale transaction to update.

Example:5678
Bodyapplication/jsonrequired
conformityinteger or null, [ 0 .. 2 ]

Conformity status:

  • 0 — Not verified
  • 1 — Conform
  • 2 — Non-conform
c_discount_sellerinteger or null

Commercial discount amount for seller (in cents or currency unit).

c_discount_buyerinteger or null

Commercial discount amount for buyer.

no_facture_buyerinteger or null

Buyer invoice number (legacy numeric field).

no_facture_sellerinteger or null

Seller invoice number (legacy numeric field).

num_bill_buyerstring or null

Buyer invoice reference (free-text).

Example:"FA-2025-001"
num_credit_note_buyerstring or null

Buyer credit note reference.

num_bill_sellerstring or null

Seller invoice reference.

Example:"FA-2025-002"
num_credit_note_sellerstring or null

Seller credit note reference.

billing_statusinteger or null

Billing workflow status. Values depend on the site configuration.

payment_amountinteger or null

Total payment amount received (in currency unit).

Example:15000
amount_recoveredinteger or null

Amount already recovered/collected.

payment_datestring or null, (date-time)

Date when payment was received. Format: ISO 8601 with timezone offset (YYYY-MM-DDTHH:MM:SS+HH:MM).

Example:"2025-06-01T00:00:00+02:00"
date_bill_buyerstring or null, (date)

Buyer invoice date (format YYYY-MM-DD).

Example:"2025-06-05"
date_credit_note_buyerstring or null, (date)

Buyer credit note date.

date_bill_sellerstring or null, (date)

Seller invoice date.

Example:"2025-06-05"
date_credit_note_sellerstring or null, (date)

Seller credit note date.

feesArray of objects or null

Fee percentage updates. Each entry must reference an existing fee id from the transaction's fee records.

curl -i -X PUT \
  https://api-doc.immo-facile.com/_mock/openapi/agreement/5678 \
  -H 'Authorization: Bearer <YOUR_opaque_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "conformity": 1,
    "billing_status": 2,
    "payment_amount": 15000,
    "payment_date": "2025-06-01T00:00:00+02:00",
    "num_bill_buyer": "FA-2025-001",
    "date_bill_buyer": "2025-06-05",
    "fees": [
      {
        "id": 1,
        "percentage": 5
      }
    ]
  }'

Responses

Updated successfully

Response
No content