Lister les factures

GET/v1/claims

Chaque facture rendue laisse une trace dans le journal d’audit.

Droit de clé restreinte : claims:read.

Paramètres de requête

statusénumération
Retient les objets dans cet état.
draftreadysecuredbatchedtransmittedacknowledgedpaidpartially_paidadjustedrejectedflaggedcanceled
patienttexte
Les factures d'un patient, pat_….
practitionertexte
Les factures d'un praticien, prac_….
modeénumération
Retient les factures de ce mode de saisie.
secureddegradedsesam_sans_vitale
fundtexte
Le code de la caisse, lu sur la couverture de la facture.
created[gte]entier
Créé à partir de cette date, en secondes Unix.
created[lte]entier
Créé jusqu'à cette date, en secondes Unix.
limitentier
Le nombre d'objets rendus, de 1 à 100. Par défaut, 25.
starting_aftertexte
Un identifiant : la page qui suit cet objet.
ending_beforetexte
Un identifiant : la page qui précède cet objet.

Réponse

Rend le corps ci-contre.

Une erreur suit le format commun.

Requête

curl


curl https://api.ophelix.fr/v1/claims?limit=3 \
  -H "Authorization: Bearer sk_test_…"

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->get('/v1/claims?limit=3', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/claims?limit=3', {
  headers: { Authorization: 'Bearer sk_test_…' },
})
const object = await response.json()

Réponse 200


{
  "object": "list",
  "url": "/v1/claims",
  "has_more": true,
  "data": [
    {
      "id": "clm_034t7h8TUC9Gu36cQgfZA5",
      "object": "claim",
      "status": "secured",
      "kind": "fse",
      "mode": "secured",
      "practitioner": "prac_034stsE7Z3xrDD833mQ3Kz",
      "practice_situation": "sit_034stsE7xFkwRLDQT8u2tW",
      "patient": "pat_034suQ2fyOnQtlR2EbxM0C",
      "coverage": "cov_034t7h7Z8puJCJmZpYBTli",
      "insurance_nature": "sickness",
      "third_party_amo": false,
      "third_party_amc": false,
      "context": {},
      "lines": [
        {
          "id": "cli_034t7h8TgDnSkrr7lTV28g",
          "object": "claim_line",
          "nomenclature": "ngap",
          "code": "ZC",
          "service_date": "2026-11-06",
          "quantity": 1,
          "coefficient": "1.00",
          "modifiers": [],
          "prescriber": null,
          "unit_price_cents": 2650,
          "base_unit_cents": null,
          "amount_cents": 2650,
          "base_amount_cents": 2650,
          "livemode": false
        }
      ],
      "amount_cents": 2650,
      "base_amount_cents": 2650,
      "amo_amount_cents": 1855,
      "amc_amount_cents": 0,
      "patient_amount_cents": 795,
      "paid_amount_cents": null,
      "rejection_code": null,
      "referential_versions": [],
      "ready_at": 1794004694,
      "secured_at": 1794004694,
      "transmitted_at": null,
      "acknowledged_at": null,
      "settled_at": null,
      "canceled_at": null,
      "livemode": false,
      "created": 1794004693,
      "updated": 1794004694
    }
  ]
}