Créditer une facture (renversement ou retour partiel)

POST

/api/invoicing/invoices/{code}/actions/reverse

Crée un crédit à partir d'une facture existante ; la facture reste immuable. Sans corps, le crédit reprend toute la facture (lignes, transport, taxes), une seule fois : un second renversement répond 409. Avec lines, c'est un retour partiel : seules les lignes et quantités indiquées sont créditées, taxes calculées sur ces quantités, transport exclu sauf include_shipping. Plusieurs retours sont possibles tant que le cumul crédité par produit ne dépasse pas le facturé (422 sinon). Le crédit porte la référence REV:<id unique de la facture> ; il s'applique ensuite à la facture par un encaissement (POST /api/customers/payments).

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Successful Response

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/invoicing/invoices//actions/reverse?profile_offset=' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "lines": [
        {
            "line_id": 132577,
            "quantity": 1
        }
    ],
    "reason": "Retour d'\''un article endommagé"
}'

Response Example

{
    "success": true,
    "source_invoice_id": 1,
    "source_invoice_code": "string",
    "created_credit_id": 1,
    "created_credit_code": "string"
}

Modified at 2026-10-12 13:22:09

Marquer une facture comme imprimée par ID interne

Créditer une facture (ou un retour partiel), par ID interne