France Quickstart

This quickstart walks you through creating your first signed fiscal record with fiskaly SIGN FR, fulfilling the three key French fiscal obligations: signing, journaling, and archiving.

Prerequisites

• A fiskaly account (sign up at hub.fiskaly.com)
• An API Key and Secret for a GROUP organization in the TEST environment
• Taxpayer information: company name, SIREN number, address

⚠️Store credentials securely

Your API Secret is shown only once. Store it immediately in a secure location.

Steps

1. Authenticate

   cURLJavaScriptPythonJavaC#

   curl -X POST https://test.api.fiskaly.com/tokens \
     -H "Content-Type: application/json" \
     -H "X-Api-Version: 2026-02-03" \
     -d '{
       "content": {
         "type": "API_KEY",
         "key": "YOUR_API_KEY",
         "secret": "YOUR_API_SECRET"
       }
     }'

   const BASE = "https://test.api.fiskaly.com";
   const API_VERSION = "2026-02-03";
   
   const authResp = await fetch(`${BASE}/tokens`, {
     method: "POST",
     headers: {
       "Content-Type": "application/json",
       "X-Api-Version": API_VERSION,
     },
     body: JSON.stringify({
       content: { type: "API_KEY", key: "YOUR_API_KEY", secret: "YOUR_API_SECRET" },
     }),
   });
   
   const { access_token } = await authResp.json();
   const headers = {
     "Authorization": `Bearer ${access_token}`,
     "Content-Type": "application/json",
     "X-Api-Version": API_VERSION,
   };

   import requests, uuid
   
   BASE = "https://test.api.fiskaly.com"
   API_VERSION = "2026-02-03"
   
   auth = requests.post(f"{BASE}/tokens", json={
       "content": {"type": "API_KEY", "key": "YOUR_API_KEY", "secret": "YOUR_API_SECRET"}
   }, headers={"X-Api-Version": API_VERSION})
   
   access_token = auth.json()["access_token"]
   hdrs = {"Authorization": f"Bearer {access_token}", "X-Api-Version": API_VERSION}

   // POST https://test.api.fiskaly.com/tokens
   // Headers: X-Api-Version: 2026-02-03
   // Body: {"content":{"type":"API_KEY","key":"...","secret":"..."}}

   using var client = new HttpClient();
   client.DefaultRequestHeaders.Add("X-Api-Version", "2026-02-03");
   var authResp = await client.PostAsJsonAsync(
       "https://test.api.fiskaly.com/tokens",
       new { content = new { type = "API_KEY", key = "YOUR_API_KEY", secret = "YOUR_API_SECRET" } });

   📘Note

   SIGN FR uses the same API platform as SIGN IT. All requests require the X-Api-Version header. Write operations also need X-Idempotency-Key.

2. Create Organization, Taxpayer, Location, and System

   The setup follows the same pattern as SIGN IT — create a UNIT organization, then a Taxpayer, Location, and System, commissioning each resource:

   cURLJavaScriptPythonJavaC#

   # Create Organization UNIT
   curl -X POST https://test.api.fiskaly.com/organizations \
     -H "Authorization: Bearer ${ACCESS_TOKEN}" \
     -H "Content-Type: application/json" \
     -H "X-Api-Version: 2026-02-03" \
     -H "X-Idempotency-Key: $(uuidgen)" \
     -d '{"content": {"type": "UNIT", "name": "My French Company"}}'
   
   # Create Subject API Key for the UNIT, re-authenticate, then:
   
   # Create Taxpayer
   curl -X POST https://test.api.fiskaly.com/taxpayers \
     -H "Authorization: Bearer ${UNIT_TOKEN}" \
     -H "Content-Type: application/json" \
     -H "X-Api-Version: 2026-02-03" \
     -H "X-Idempotency-Key: $(uuidgen)" \
     -d '{
       "content": {
         "type": "COMPANY",
         "name": {"legal": "Ma Societe SARL"},
         "address": {"street": "1 Rue de Rivoli", "zip": "75001", "city": "Paris", "country_code": "FR"},
         "fiscalization": {
           "type": "FR",
           "tax_id_number": "123456789"
         }
       }
     }'
   
   # Commission Taxpayer, create + commission Location and System
   # (same pattern as SIGN IT — see full integration guide)

   // Create Organization UNIT
   const org = await fetch(`${BASE}/organizations`, {
     method: "POST",
     headers: { ...headers, "X-Idempotency-Key": crypto.randomUUID() },
     body: JSON.stringify({ content: { type: "UNIT", name: "My French Company" } }),
   }).then(r => r.json());
   
   // After creating Subject API Key and re-authenticating:
   
   // Create Taxpayer
   const taxpayer = await fetch(`${BASE}/taxpayers`, {
     method: "POST",
     headers: { ...headers, "X-Idempotency-Key": crypto.randomUUID() },
     body: JSON.stringify({
       content: {
         type: "COMPANY",
         name: { legal: "Ma Societe SARL" },
         address: { street: "1 Rue de Rivoli", zip: "75001", city: "Paris", country_code: "FR" },
         fiscalization: { type: "FR", tax_id_number: "123456789" },
       },
     }),
   }).then(r => r.json());
   
   // Commission Taxpayer → create Location → commission → create System → commission

   # Create Taxpayer (after org + subject setup)
   taxpayer = requests.post(f"{BASE}/taxpayers", headers={
       **hdrs, "X-Idempotency-Key": str(uuid.uuid4())
   }, json={"content": {
       "type": "COMPANY",
       "name": {"legal": "Ma Societe SARL"},
       "address": {"street": "1 Rue de Rivoli", "zip": "75001", "city": "Paris", "country_code": "FR"},
       "fiscalization": {"type": "FR", "tax_id_number": "123456789"},
   }}).json()
   
   # Commission, then create + commission Location and System...

   // Same pattern as SIGN IT:
   // POST /organizations → UNIT
   // POST /subjects → API_KEY (scoped)
   // POST /tokens → re-authenticate
   // POST /taxpayers → FR fiscalization
   // PATCH /taxpayers/{id} → COMMISSIONED
   // POST /locations → BRANCH
   // POST /systems → FISCAL_DEVICE

   // Same pattern as SIGN IT — create and commission:
   // Organization → Taxpayer → Location → System
   // French-specific: fiscalization.type = "FR", tax_id_number = SIREN (9 digits)

3. Create your first Record

   cURLJavaScriptPythonJavaC#

   # Part A: Intention
   curl -X POST https://test.api.fiskaly.com/records \
     -H "Authorization: Bearer ${UNIT_TOKEN}" \
     -H "Content-Type: application/json" \
     -H "X-Api-Version: 2026-02-03" \
     -H "X-Idempotency-Key: $(uuidgen)" \
     -d '{
       "content": {
         "type": "INTENTION",
         "system": {"id": "YOUR_SYSTEM_ID"},
         "operation": {"type": "TRANSACTION"}
       }
     }'
   
   # Part B: Transaction
   curl -X POST https://test.api.fiskaly.com/records \
     -H "Authorization: Bearer ${UNIT_TOKEN}" \
     -H "Content-Type: application/json" \
     -H "X-Api-Version: 2026-02-03" \
     -H "X-Idempotency-Key: $(uuidgen)" \
     -d '{
       "content": {
         "type": "TRANSACTION",
         "intention": {"id": "INTENTION_ID"},
         "operation": {
           "type": "RECEIPT",
           "document": {
             "number": "1",
             "date": "2026-02-27",
             "amounts": {
               "total_including_vat": "12.00",
               "total_excluding_vat": "10.00"
             }
           },
           "entries": [{
             "type": "SALE",
             "description": "Product A",
             "nature": "GOOD",
             "quantity": "1",
             "amounts": {
               "unit_including_vat": "12.00",
               "total_including_vat": "12.00",
               "total_excluding_vat": "10.00",
               "vat": {"rate": "20.00", "amount": "2.00"}
             }
           }]
         }
       }
     }'

   // Part A: Intention
   const intention = await fetch(`${BASE}/records`, {
     method: "POST",
     headers: { ...headers, "X-Idempotency-Key": crypto.randomUUID() },
     body: JSON.stringify({
       content: {
         type: "INTENTION",
         system: { id: systemId },
         operation: { type: "TRANSACTION" },
       },
     }),
   }).then(r => r.json());
   
   // Part B: Transaction
   const record = await fetch(`${BASE}/records`, {
     method: "POST",
     headers: { ...headers, "X-Idempotency-Key": crypto.randomUUID() },
     body: JSON.stringify({
       content: {
         type: "TRANSACTION",
         intention: { id: intention.id },
         operation: {
           type: "RECEIPT",
           document: {
             number: "1", date: "2026-02-27",
             amounts: { total_including_vat: "12.00", total_excluding_vat: "10.00" },
           },
           entries: [{
             type: "SALE", description: "Product A", nature: "GOOD", quantity: "1",
             amounts: {
               unit_including_vat: "12.00", total_including_vat: "12.00",
               total_excluding_vat: "10.00",
               vat: { rate: "20.00", amount: "2.00" },
             },
           }],
         },
       },
     }),
   }).then(r => r.json());
   
   console.log("Record created and archived:", record.state);

   # Part A: Intention
   intention = requests.post(f"{BASE}/records", headers={
       **hdrs, "X-Idempotency-Key": str(uuid.uuid4())
   }, json={"content": {
       "type": "INTENTION", "system": {"id": system_id},
       "operation": {"type": "TRANSACTION"},
   }}).json()
   
   # Part B: Transaction
   record = requests.post(f"{BASE}/records", headers={
       **hdrs, "X-Idempotency-Key": str(uuid.uuid4())
   }, json={"content": {
       "type": "TRANSACTION", "intention": {"id": intention["id"]},
       "operation": {
           "type": "RECEIPT",
           "document": {"number": "1", "date": "2026-02-27",
               "amounts": {"total_including_vat": "12.00", "total_excluding_vat": "10.00"}},
           "entries": [{"type": "SALE", "description": "Product A", "nature": "GOOD",
               "quantity": "1", "amounts": {
                   "unit_including_vat": "12.00", "total_including_vat": "12.00",
                   "total_excluding_vat": "10.00", "vat": {"rate": "20.00", "amount": "2.00"}}}],
       },
   }}).json()

   // POST /records → INTENTION (system.id, operation.type = TRANSACTION)
   // POST /records → TRANSACTION (intention.id, receipt data with entries)
   // Data is signed, journaled, and archived for NF525 compliance

   // Two-step record creation: INTENTION → TRANSACTION
   // French VAT rate: 20.00% (standard)
   // Response confirms signing, journaling, and archiving

   Once created, the data is automatically signed, journaled, and archived — fulfilling the three key NF525 fiscal obligations.

Next Steps

Full Integration Guide

Complete step-by-step walkthrough with all 11 steps

Core Functionalities

Signing, journaling, and archiving capabilities

Offline Mode

Keep your POS running during outages