Liste des factures ERP

Utilisez cet endpoint pour récupérer les factures certifiées par votre ERP via l’intégration en ligne. Il retourne les factures associées à votre clé d’intégration active avec pagination, filtrage par type et par période.

Authentification : clé API (en-tête X-API-Key) délivrée après approbation d’une intégration ERP.
Portée : uniquement les factures du business_id lié à la clé.

OpenAPI / Swagger

Visualiser dans Swagger UI

Endpoint

URL : GET /api/invoices
Authentification : Header X-API-Key


GET https://{baseUrl}/api/invoices?page=1&pageSize=10
X-API-Key: {votre_cle_api}
Accept: application/json

Paramètres de requête

Paramètre	Type	Description	Obligatoire	Valeur par défaut
`page`	integer ≥ 1	Numéro de page	❌	`1`
`pageSize`	integer 1-20	Nombre de factures par page	❌	`10`
`invoice_type`	string	Filtre par type de facture (`salesInvoice`, `creditNote`, etc.)	❌	—
`date_start`	string (ISO 8601)	Début de période (inclus)	❌	—
`date_end`	string (ISO 8601)	Fin de période (inclus, 23:59:59 automatiquement)	❌	—

Exemple de requête (cURL)


curl --request GET \
  --url "https://{baseurl}/api/invoices?page=2&pageSize=25&invoice_type=salesInvoice&date_start=2025-01-01&date_end=2025-01-31" \
  --header "X-API-Key: sk_sfec_live_your_key" \
  --header "Accept: application/json"

Structure de réponse


{
  "invoices": [
    {
      "id": "f0b6ad2d-bd0e-4c5a-9559-e2d7c4156c90",
      "invoice_number": "INV-2025-000145",
      "invoice_date": "2025-01-15T10:30:00.000Z",
      "invoice_type": "salesInvoice",
      "invoice_status": "certified",
      "currency": "XAF",
      "total_ht": "13280.00",
      "total_tax18": "2390.40",
      "total_ttc": "15670.40",
      "payment_method": "2",
      "notes": "Facture ERP janvier",
      "buyer_name": "Test Buyer Company",
      "buyer_niu": "BUYER123456789",
      "items_json": [
        {
          "designation": "iphones 16",
          "quantity": 12,
          "unit_price": 720,
          "tax_rate": "18",
          "total_amount": 7835.2
        }
      ],
      "Buyer": {
        "id": "4bd77f16-833a-4c4e-ac0b-4d0664720c77",
        "niu": "BUYER123456789",
        "name": "Test Buyer Company",
        "buyer_type": "company"
      },
      "StatusInvoice": {
        "status_id": 3,
        "name": "certified"
      }
    }
  ],
  "totalPages": 12,
  "page": 2,
  "pageSize": 25
}

Codes de réponse

Code	Description
`200`	Requête réussie
`401`	Clé API absente, invalide ou status ≠ `active`
`500`	Erreur interne (voir champ `details` dans la réponse)

Détails d’une facture ERP

Utilisez cet endpoint pour récupérer les détails complets d’une facture spécifique par son identifiant unique (UUID) ou son numéro de facture.

Authentification : clé API (en-tête X-API-Key) délivrée après approbation d’une intégration ERP.
Portée : uniquement les factures du businesss lié à la clé.

Endpoint

URL : GET /api/invoices/{id}
Authentification : Header X-API-Key


GET https://{baseUrl}/api/invoices/{id}
X-API-Key: {votre_cle_api}
Accept: application/json

Paramètres de chemin

Paramètre	Type	Description
`id`	string	Identifiant unique (UUID) ou numéro de facture (`invoice_number`)

Le paramètre id accepte soit :

L’identifiant unique de la facture (UUID), ex: f0b6ad2d-bd0e-4c5a-9559-e2d7c4156c90
Le numéro de facture, ex: INV-2025-000145

Exemple de requête (cURL)

Par UUID


curl --request GET \
  --url "https://{baseurl}/api/invoices/f0b6ad2d-bd0e-4c5a-9559-e2d7c4156c90" \
  --header "X-API-Key: sk_sfec_live_your_key" \
  --header "Accept: application/json"

Par numéro de facture


curl --request GET \
  --url "https://{baseurl}/api/invoices/INV-2025-000145" \
  --header "X-API-Key: sk_sfec_live_your_key" \
  --header "Accept: application/json"

Structure de réponse


{
  "id": "f0b6ad2d-bd0e-4c5a-9559-e2d7c4156c90",
  "invoice_number": "INV-2025-000145",
  "invoice_date": "2025-01-15T10:30:00.000Z",
  "invoice_type": "salesInvoice",
  "invoice_status": "certified",
  "currency": "XAF",
  "total_ht": "13280.00",
  "total_tax18": "2390.40",
  "total_ttc": "15670.40",
  "payment_method": "2",
  "notes": "Facture ERP janvier",
  "buyer_name": "Test Buyer Company",
  "buyer_niu": "BUYER123456789",
  "items_json": [
    {
      "designation": "iphones 16",
      "quantity": 12,
      "unit_price": 720,
      "tax_rate": "18",
      "total_amount": 7835.2
    }
  ],
  "Buyer": {
    "id": "4bd77f16-833a-4c4e-ac0b-4d0664720c77",
    "niu": "BUYER123456789",
    "name": "Test Buyer Company",
    "buyer_type": "company"
  }
}

Codes de réponse

Code	Description
`200`	Requête réussie, facture trouvée
`401`	Clé API absente, invalide ou status ≠ `active`
`404`	Facture non trouvée (n’existe pas ou n’appartient pas au business)
`500`	Erreur interne (voir champ `details` dans la réponse)