Models
French e-reporting registration
Properties
| Name | Type | Required | Description |
|---|---|---|---|
environment | PROD | TEST | Yes | The reporting environment this registration belongs to. Teams on the test network are registered in TEST, all other teams in PROD. Values: PROD, TEST |
siren | string | Yes | The SIREN the company reports under, derived from its enterprise number. Example: "123456789" |
issuerName | string | Yes | The legal name carried as the issuer on every report filed for the company |
vatRegime | REEL_NORMAL_MENSUEL | REEL_SIMPLIFIE | FRANCHISE_EN_BASE | Yes | A French VAT regime: REEL_NORMAL_MENSUEL (régime réel normal), REEL_SIMPLIFIE (régime réel simplifié) or FRANCHISE_EN_BASE (franchise en base de TVA). Values: REEL_NORMAL_MENSUEL, REEL_SIMPLIFIE, FRANCHISE_EN_BASE |
vatExigibility | ENCAISSEMENTS | DEBITS | Yes | When VAT becomes due: ENCAISSEMENTS (on payment, typical for services) or DEBITS (on invoicing, typical for goods). Values: ENCAISSEMENTS, DEBITS |
enabled | boolean | Yes | Whether reports are currently accepted. A suspended registration keeps its registered state but refuses reports with a 400 until support re-enables it |
state | pending | registered | blocked | Yes | pending while the registration is being completed, registered once reports can be submitted, blocked when the registration needs support. Values: pending, registered, blocked |
simulated | boolean | Yes | True for playground and test-network teams, whose registration and reports are simulated instead of filed |
lastError | string | null | Yes | The reason the last registration attempt failed, if any |
registeredAt | string | null | Yes | When the registration was accepted. The company's reporting periods run from this moment. Null while the state is still pending. Format: date-time |
createdAt | string (date-time) | Yes | When the registration was first requested. Format: date-time |
updatedAt | string (date-time) | Yes | When the registration last changed, including a background retry of a pending registration. Format: date-time |