Ouvrir un brouillon de facture

POST/v1/claims

Un brouillon s’enregistre même incomplet. validate dit ce qui manque.

Droit de clé restreinte : claims:write.

Corps de la requête

practitionertexteobligatoire
Le praticien qui facture, prac_….
patienttexteobligatoire
Le patient, pat_….
kindénumération
FSE par défaut.
fsedre
modeénumération
Le mode de saisie.
secureddegradedsesam_sans_vitale
insurance_natureénumération
La nature de l'assurance.
sicknessmaternitywork_accidentfree_medical_care
third_party_amobooléen
Tiers payant sur la part obligatoire.
third_party_amcbooléen
Tiers payant sur la part complémentaire.
coveragetexte
La lecture de droits. Par défaut, la dernière du patient.
practice_situationtexte
La situation du praticien. Par défaut, la première facturable.
contextobjet
Les dates et numéros que la nature d'assurance demande.
Champs de context
- maternity_datedate
- work_accident_datedate
- work_accident_numbertexte
- common_law_accidentbooléen
- common_law_accident_datedate
- care_pathwayénumération
  excludedemergencytreating_doctornew_treating_doctorsubstituterecent_generalistunderserved_areaaway_from_homedirect_accessoutside_direct_accessreferred_by_treatingreferred_by_othernot_respected
- treating_doctor_declaredénumération
  yesnounknown
- referring_doctor_last_nametexte
- referring_doctor_first_nametexte
linestableau de objet
Les prestations, 100 au plus.
Champs de lines
- nomenclatureénumérationobligatoire
  ngapccamlppbiologymedication
- codetexteobligatoire
- service_datedateobligatoire
- quantityentier
- coefficientnombre
- modifierstableau de texte
- unit_price_centsentierou null
- prescriberobjet
  Champs de prescriber
  - identifiertexte
  - keytexte
  - specialty_codetexte
  - prescribed_ondate

En-têtes

Idempotency-Keytexte
Rend le rejeu de cette écriture sûr pendant 24 heures. Idempotence.

Réponse

Rend l’objet factures.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/claims \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{
    "practitioner": "prac_…",
    "patient": "pat_…",
    "third_party_amo": true,
    "lines": [
      {
        "nomenclature": "ngap",
        "code": "ZC",
        "service_date": "2026-11-06",
        "unit_price_cents": 2650
      }
    ]
  }'

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->post('/v1/claims', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
    'json' => [
        'practitioner' => 'prac_…',
        'patient' => 'pat_…',
        'third_party_amo' => true,
        'lines' => [
            [
                'nomenclature' => 'ngap',
                'code' => 'ZC',
                'service_date' => '2026-11-06',
                'unit_price_cents' => 2650,
            ],
        ],
    ],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/claims', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    practitioner: 'prac_…',
    patient: 'pat_…',
    third_party_amo: true,
    lines: [
      {
        nomenclature: 'ngap',
        code: 'ZC',
        service_date: '2026-11-06',
        unit_price_cents: 2650
      }
    ]
  }),
})
const object = await response.json()

Réponse 201


{
  "id": "clm_034t7h8TUC9Gu36cQgfZA5",
  "object": "claim",
  "status": "draft",
  "kind": "fse",
  "mode": "secured",
  "practitioner": "prac_034stsE7Z3xrDD833mQ3Kz",
  "practice_situation": "sit_034stsE7xFkwRLDQT8u2tW",
  "patient": "pat_034suQ2fyOnQtlR2EbxM0C",
  "coverage": "cov_034t7h7Z8puJCJmZpYBTli",
  "insurance_nature": "sickness",
  "third_party_amo": true,
  "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": null,
  "secured_at": null,
  "transmitted_at": null,
  "acknowledged_at": null,
  "settled_at": null,
  "canceled_at": null,
  "livemode": false,
  "created": 1794004693,
  "updated": 1794004693
}