Types de données
AchatCreationDto
[TBD]
AdditionalId
[TBD]
AdressePostaleDto
AdressePostaleDto
required:
- codePays
type: object
properties:
adresse1:
description: 'Première ligne d''adresse, ligne principale de l''adresse.'
type: string
example: 7 Av. Adolphe Max
adresse2:
description: Deuxième ligne de l'adresse.
type: string
example: Batiment B
adresse3:
description: Troisième ligne de l'adresse.
type: string
example: Appartement 12
localite:
description: 'Localité, commune, ville ou village.'
type: string
example: Lyon
codePostal:
description: Code postal
type: string
example: '69005'
pays:
description: Pays
type: string
example: France
codePays:
description: Code d'indentification du pays au format ISO 3166
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- KH
- CM
- CA
- CV
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- EL
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- KR
- KP
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MK
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- SS
- ES
- LK
- SD
- SR
- SJ
- SZ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- US
- UM
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
type: string
example: FR
ClientDto
ClientDto
required:
- type
- nom
- siren
- siret
- adresse
- adresseLivraison
type: object
properties:
type:
description: Le type de client
enum:
- PROFESSIONNEL
- PARTICULIER
type: string
example: PROFESSIONNEL
nom:
description: 'La raison sociale de l''Acheteur, le nom complet de l''Acheteur.'
maxLength: 99
type: string
nomCommercialSociete:
description: 'Appelation commerciale de l''acheteur, nom par lequel l''Acheteur est connu.'
maxLength: 99
type: string
prenomNom:
description: Le prénom et le nom de l'acheteur comme point de contact.
maxLength: 100
type: string
telephone:
description: Le numéro de téléphone de contact de l'acheteur.
maxLength: 15
type: string
email:
description: L'adresse email de l'acheteur.
maxLength: 50
type: string
siren:
description: Le SIREN de l'entreprise cliente
type: string
example: '362521879'
siret:
description: Le SIRET de l'entreprise cliente
type: string
example: '36252187900034'
adresse:
description: L'adresse postale du client.
allOf:
-
$ref: '#/components/schemas/AdressePostaleDto'
tvaIntracommunautaire:
description: Le numéro de TVA intracommunautaire du client. L'identifiant à la TVA de l'acheteur.
maxLength: 18
type: string
example: FR 53157896342
autresInformations:
description: La liste des autres informations relatives au client.
type: array
items:
type: string
adresseLivraison:
description: L'adresse de livraison du client.
allOf:
-
$ref: '#/components/schemas/AdressePostaleDto'
CompanyDto
CompanyDto
required:
- companyId
- companyName
- templateId
- logo
- docInfo
- siren
- regimeFiscal
- additionalIds
type: object
properties:
companyId:
type: string
companyName:
type: string
templateId:
type: string
logo:
$ref: '#/components/schemas/LogoDto'
docInfo:
$ref: '#/components/schemas/DocInfoDto'
siren:
type: string
regimeFiscal:
type: string
additionalIds:
type: array
items:
$ref: '#/components/schemas/AdditionalId'
CreatePdpConnectionDto
CreatePdpConnectionDto
required:
- siren
- connectionType
type: object
properties:
siren:
type: string
connectionType:
enum:
- PDP
- PPF
type: string
firstName:
type: string
lastName:
type: string
email:
type: string
companyName:
type: string
regimeFiscal:
enum:
- NORMAL_MENSUEL
- NORMAL_TRIMESTRIEL
- SIMPLIFIE
- FRANCHISE_EN_BASE
- NON_SOUMIS
type: string
DetailTvaDto
DetailTvaDto
required:
- totalHT
- totalTVA
type: object
properties:
totalHT:
description: Base d'imposition du type de TVA. Somme de tous les montants imposables.
type: string
tauxTVA:
description: 'Taux de TVA, en pourcentage.'
type: string
totalTVA:
description: Montant total de la TVA.
type: string
DocInfoDto
DocInfoDto
type: object
properties:
sujet:
description: Sujet
type: string
titre:
description: Titre
type: string
motsCles:
description: Mots clés
type: array
items:
type: string
FactureAchatDto
FactureAchatDto
required:
- id
- dateCreation
- syntaxe
- numero
- statutOd
- paiements
type: object
properties:
id:
type: string
dateCreation:
format: date-time
type: string
syntaxe:
enum:
- Factur-X
- UBL
- CII
type: string
numero:
type: string
statutOd:
enum:
- CREEE
- A_ENVOYER
- ENVOYEE
- RECUE
- REFUSEE
type: string
nomFournisseur:
type: string
dateEmission:
format: date-time
type: string
devise:
description: La devise des montants de la Facture au format ISO 4217.
enum:
- EUR
- DKK
- ISK
- NOK
- SEK
- CZK
- PLN
- MDL
- RON
- BGN
- GBP
- CHF
- CHE
- CHW
- CNY
- JPY
- INR
- USD
- AUD
- CAD
- AFN
- ALL
- DZD
- AOA
- XCD
- ARS
- AMD
- AWG
- AZN
- BSD
- BHD
- BDT
- BBD
- BYN
- BZD
- XOF
- BMD
- BTN
- BOB
- BOV
- BAM
- BWP
- BRL
- BND
- BIF
- CVE
- KHR
- XAF
- KYD
- CLP
- CLF
- COP
- COU
- KMF
- CDF
- NZD
- CRC
- HRK
- CUP
- CUC
- ANG
- DJF
- DOP
- EGP
- SVC
- ERN
- SZL
- ETB
- FKP
- FJD
- XPF
- GMD
- GEL
- GHS
- GIP
- GTQ
- GNF
- GYD
- HTG
- HNL
- HKD
- HUF
- IDR
- XDR
- IRR
- IQD
- ILS
- JMD
- JOD
- KZT
- KES
- KPW
- KRW
- KWD
- KGS
- LAK
- LBP
- LSL
- ZAR
- LRD
- LYD
- MOP
- MKD
- MGA
- MWK
- MYR
- MVR
- MRU
- MUR
- XUA
- MXN
- MXV
- MNT
- MAD
- MZN
- MMK
- NAD
- NPR
- NIO
- NGN
- OMR
- PKR
- PAB
- PGK
- PYG
- PEN
- PHP
- QAR
- RUB
- RWF
- SHP
- WST
- STN
- SAR
- RSD
- SCR
- SLL
- SGD
- XSU
- SBD
- SOS
- SSP
- LKR
- SDG
- SRD
- SYP
- TWD
- TJS
- TZS
- THB
- TOP
- TTD
- TND
- TRY
- TMT
- UGX
- UAH
- AED
- USN
- UYU
- UYI
- UYW
- UZS
- VUV
- VES
- VND
- YER
- ZMW
- ZWL
- XBA
- XBB
- XBC
- XBD
- XTS
- XXX
- XAU
- XPD
- XPT
- XAG
type: string
example: EUR
montantTTC:
type: string
montantTVA:
type: string
type:
enum:
- Facture
- Avoir
type: string
motifRefus:
$ref: '#/components/schemas/MotifRefusDto'
paiements:
type: array
items:
$ref: '#/components/schemas/PaiementDto'
FactureVenteCreationDto
required:
- logo
- numeroFacture
- typeFacture
- cadreFacturation
- codeDevise
- dateFacturation
- client
- lignesFacture
- detailsTVA
- totalFacture
- vendeur
type: object
properties:
logo:
description: Le logo de la Facture en base64.
allOf:
-
$ref: '#/components/schemas/LogoDto'
docInfo:
description: Les métadonnées du fichier PDF
allOf:
-
$ref: '#/components/schemas/DocInfoDto'
numeroFacture:
description: Le numéro de la Facture. Identification unique de la Facture.
maxLength: 20
type: string
example: 2023-12-FAC1
typeFacture:
description: Le type de Facture.
enum:
- FACTURE_COMMERCIALE
- FACTURE_AUTOFACTUREE
- FACTURE_AFFACTUREE
- FACTURE_AUTOFACTUREE_AFFACTUREE
- FACTURE_ACOMPTE
- FACTURE_ACOMPTE_AUTOFACTUREE
- FACTURE_RECTIFICATIVE
- FACTURE_RECTIFICATIVE_AUTOFACTUREE
- FACTURE_RECTIFICATIVE_AFFACTUREE
- FACTURE_RECTIFICATIVE_AUTOFACTUREE_AFFACTUREE
- AVOIR_AUTOFACTURE
- AVOIR
- AVOIR_AFFACTURE
- AVOIR_FACTURE_ACOMPTE
- REMISE_GLOBALE
type: string
example: FACTURE_COMMERCIALE
cadreFacturation:
description: Le cadre de facturation.
enum:
- FACTURE_BIEN
- FACTURE_SERVICE
- FACTURE_DOUBLE
- FACTURE_BIEN_PAYE
- FACTURE_SERVICE_PAYE
- FACTURE_DOUBLE_PAYE
- FACTURE_SERVICE_SOUS_TRAITANCE
- FACTURE_DEFINITIVE_BIEN
- FACTURE_DEFINITIVE_SERVICE
- FACTURE_DEFINITIVE_DOUBLE
- FACTURE_SOUS_TRAITANT_SERVICE
- FACTURE_COTRAITANT_SERVICE
- FACTURE_BIEN_REPORTE
- FACTURE_SERVICE_REPORTE
type: string
example: FACTURE_BIEN
codeDevise:
description: La devise des montants de la Facture au format ISO 4217.
enum:
- EUR
- DKK
- ISK
- NOK
- SEK
- CZK
- PLN
- MDL
- RON
- BGN
- GBP
- CHF
- CHE
- CHW
- CNY
- JPY
- INR
- USD
- AUD
- CAD
- AFN
- ALL
- DZD
- AOA
- XCD
- ARS
- AMD
- AWG
- AZN
- BSD
- BHD
- BDT
- BBD
- BYN
- BZD
- XOF
- BMD
- BTN
- BOB
- BOV
- BAM
- BWP
- BRL
- BND
- BIF
- CVE
- KHR
- XAF
- KYD
- CLP
- CLF
- COP
- COU
- KMF
- CDF
- NZD
- CRC
- HRK
- CUP
- CUC
- ANG
- DJF
- DOP
- EGP
- SVC
- ERN
- SZL
- ETB
- FKP
- FJD
- XPF
- GMD
- GEL
- GHS
- GIP
- GTQ
- GNF
- GYD
- HTG
- HNL
- HKD
- HUF
- IDR
- XDR
- IRR
- IQD
- ILS
- JMD
- JOD
- KZT
- KES
- KPW
- KRW
- KWD
- KGS
- LAK
- LBP
- LSL
- ZAR
- LRD
- LYD
- MOP
- MKD
- MGA
- MWK
- MYR
- MVR
- MRU
- MUR
- XUA
- MXN
- MXV
- MNT
- MAD
- MZN
- MMK
- NAD
- NPR
- NIO
- NGN
- OMR
- PKR
- PAB
- PGK
- PYG
- PEN
- PHP
- QAR
- RUB
- RWF
- SHP
- WST
- STN
- SAR
- RSD
- SCR
- SLL
- SGD
- XSU
- SBD
- SOS
- SSP
- LKR
- SDG
- SRD
- SYP
- TWD
- TJS
- TZS
- THB
- TOP
- TTD
- TND
- TRY
- TMT
- UGX
- UAH
- AED
- USN
- UYU
- UYI
- UYW
- UZS
- VUV
- VES
- VND
- YER
- ZMW
- ZWL
- XBA
- XBB
- XBC
- XBD
- XTS
- XXX
- XAU
- XPD
- XPT
- XAG
type: string
example: EUR
autresInformationsPrincipales:
description: La liste des lignes d'autres informations présentes dans l'en-tête de la Facture.
type: array
items:
type: string
dateFacturation:
format: date-time
description: La date d'émission de la Facture.
type: string
example: '2023-12-01'
titreFacture:
description: Le titre de la Facture.
type: string
autresInformationsFacture:
description: La liste des lignes d'autres informations présentes sous la date de facturation.
type: array
items:
type: string
dateEcheance:
format: date-time
description: La date d'échéance de paiement de la Facture.
type: string
example: '2023-12-01'
conditionsPaiement:
description: Toutes les conditions de paiement de la Facture.
maxLength: 1024
type: string
example: |-
La facture est payable à réception.
Des pénalités correspondant au taux directeur de la BCE (la Banque Centrale Européenne), majoré de 10 points seront applicables en l'absence ou en cas de retard de paiement.
Les pénalités de retard sont exigibles sans qu'un rappel soit nécessaire.
Une indemnité forfaitaire de 40 € pour frais de recouvrement sera appliquée en cas de retard de paiement conformément aux articles L 441-3 et L 441-6 du code de commerce.
Pas d'escompte en cas de paiement anticipé.
iban:
description: L'IBAN du vendeur.
maxLength: 50
type: string
example: FR7630001007941234567890185
client:
description: Les informations concernant le client / l'acheteur.
allOf:
-
$ref: '#/components/schemas/ClientDto'
lignesFacture:
description: La liste des lignes de Facture.
type: array
items:
$ref: '#/components/schemas/LigneFactureDto'
detailsTVA:
description: La ventilation de la TVA.
type: array
items:
$ref: '#/components/schemas/DetailTvaDto'
totalFacture:
description: Les totaux de la Facture.
allOf:
-
$ref: '#/components/schemas/TotalFactureDto'
formulePolitesse:
description: La formule de politesse présente en fin de Facture.
type: string
mentionTva:
description: La mention d'exonération de TVA.
enum:
- FRANCHISE_EN_BASE
- EXPORTATION_HORS_UE
- LIVRAISON_INTRACOMMUNAUTAIRE
- PRESTATION_DE_SERVICE_HORS_UE
- PRESTATION_DE_SERVICE_EN_UE_HORS_FRANCE
- AUTOLIQUIDATION_SOUS_TRAITANCE_BTP
- AUTOLIQUIDATION_SERVICES_COMM_ELECTRONIQUES
- AUTOLIQUIDATION_AUTRE
- FACTURATION_TVA_ETRANGERE
type: string
example: FRANCHISE_EN_BASE
vendeur:
description: Les informations sur le vendeur.
allOf:
-
$ref: '#/components/schemas/VendeurDto'
mentionsFacture:
$ref: '#/components/schemas/MentionsFactureDto'
FactureVenteDto
FactureVenteDto
required:
- id
- dateCreation
- syntaxe
- numero
- statutOd
- statutsPdp
- paiements
type: object
properties:
id:
type: string
dateCreation:
format: date-time
type: string
syntaxe:
enum:
- Factur-X
- UBL
- CII
type: string
numero:
type: string
statutOd:
enum:
- CREEE
- A_ENVOYER
- ENVOYEE
- RECUE
- REFUSEE
type: string
statutsPdp:
type: array
items:
$ref: '#/components/schemas/StatutPdpDto'
paiements:
type: array
items:
$ref: '#/components/schemas/PaiementDto'
FileDto
FileDto
required:
- fileId
- type
- contentType
- content
type: object
properties:
fileId:
type: string
type:
type: string
contentType:
type: string
content:
type: string
LigneFactureDto
LigneFactureDto
required:
- titre
- quantite
- unite
- prixUnitaireHT
- totalHT
type: object
properties:
titre:
description: Le nom de l'article.
maxLength: 255
type: string
description:
description: La description de l'article.
maxLength: 1024
type: string
reference:
description: La référence de l'article.
maxLength: 50
type: string
quantite:
description: La quantité d'articles (biens ou services) prise en compte dans la ligne de Facture.
type: string
unite:
description: L'unité de mesure applicable la quantité facturée.
enum:
- unité
- jour
- heure
type: string
example: unité
prixUnitaireHT:
description: 'Le prix unitaire net de l''article, hors TVA.'
type: string
prixUnitaireTTC:
description: Le prix unitaire TTC de l'article.
type: string
tauxTVA:
description: 'Taux de TVA, exprimé sous forme de pourcentage, applicable à l''article facturé.'
type: string
totalHT:
description: Montant total net hors TVA incluant les remises au niveau de la ligne
type: string
montantTotalRemise:
description: Montant d'une remise hors TVA.
type: string
remisePourcentage:
description: Pourcentage de remise de ligne de facture.
type: string
LogoDto
LogoDto
required:
- mimeType
- base64
- alt
type: object
properties:
mimeType:
description: Type MIME du logo
enum:
- image/jpeg
- image/png
- image/svg+xml
- image/webp
- image/x-icon
type: string
base64:
description: Données du logo encodé en base64
type: string
alt:
description: Texte alternatif du logo
type: string
width:
description: Largeur du logo dans le document (en px)
minimum: 1
type: number
height:
description: Hauteur du logo dans le document (en px)
minimum: 1
type: number
MentionsFactureDto
MentionsFactureDto
required:
- autresInformations
type: object
properties:
autresInformations:
description: Liste des autres informations de la facture.
type: array
items:
type: string
MotifRefusDto
MotifRefusDto
required:
- codeMotif
- libelle
type: object
properties:
codeMotif:
enum:
- AUT_MOTIF_ERR_VALIDEUR
- CONTACT_ACHTR
- COORD_BANC_ERR
- CREANCIER_ERR
- DEST_ERR
- DOUBLE_FACT
- EJ_ERR
- ERR_VALIDEUR
- FACT_NON_CONFORME
- JUSTIF_ABS
- LIVR_INCOMP
- MARCHE_TERM
- MONTANT_ERR
- SE_ERR
- ST_CT_NON_DECLAR
- SUPPR_COMP_AVOIR
- TRANSF_PMNT_REGIE
- TX_TVA_ERR
- ANNUL_ENC
- AUTRE
- ROUTAGE_ERR
type: string
libelle:
type: string
PaiementDto
PaiementDto
required:
- montantHt
- tauxTva
type: object
properties:
montantHt:
type: number
tauxTva:
type: number
PatchFactureAchatDto
PatchFactureAchatDto
required:
- op
- path
- value
type: object
properties:
op:
description: Opération
enum:
- add
- replace
type: object
path:
description: Chemin de la ressource
enum:
- /statutOd
- /paiements
- /motifRefus
type: string
value:
description: Valeur
type: object
PatchFactureVenteDto
PatchFactureVenteDto
required:
- op
- path
- value
type: object
properties:
op:
description: Opération
enum:
- replace
type: object
path:
description: Chemin de la ressource
enum:
- /statutOd
- /paiements
type: string
value:
description: Valeur
type: object
ReceiveFactureAchatDto
ReceiveFactureAchatDto
required:
- signature
- payload
type: object
properties:
signature:
description: Signature des données reçues
type: string
payload:
description: Données de la facture reçue
type: string
StatutPdpDto
StatutPdpDto
required:
- date
- statut
type: object
properties:
date:
format: date-time
type: string
statut:
type: string
TotalFactureDto
TotalFactureDto
required:
- totalHT
- totalNetHT
- totalTTC
- totalAPayer
type: object
properties:
totalHT:
description: Somme des montants nets des lignes de facture.
type: string
remiseGlobalePourcent:
description: Pourcentage de remise globale de la facture.
type: string
remiseGlobaleMontant:
description: Montant de la remise globale de la facture.
type: string
totalRemiseMontant:
description: |-
Somme de toutes les remises de la facture.
Dans le cas où une remise globale en pourcentage ou un montant de remise globale est renseigné,
ce champ doit l'être également.
type: string
totalNetHT:
description: Montant total de la facture hors TVA.
type: string
tauxTVA:
description: 'Taux de TVA, exprimé sous forme de pourcentage.'
type: string
totalTVA:
description: Montant total de TVA de la facture.
type: string
totalTTC:
description: 'Montant total de la Facture, avec la TVA'
type: string
acompteTTC:
description: Montant payé par anticipation.
type: string
totalAPayer:
description: Montant total à payer.
type: string
VendeurDto
VendeurDto
required:
- nomSociete
- siren
- siret
- adresse
type: object
properties:
nomSociete:
description: Raison sociale du vendeur.
maxLength: 99
type: string
nomCommercialSociete:
description: Appellation commerciale du vendeur
maxLength: 99
type: string
formeLegale:
description: Forme juridique et capital social pour les sociétés.
maxLength: 1024
type: string
siren:
description: Numéro de SIREN.
type: string
siret:
description: Identifiant du vendeur (SIRET)
type: string
tvaIntracommunautaire:
description: Identifiant à la TVA du vendeur.
type: string
telephone:
description: Numéro de téléphone du contact du vendeur.
maxLength: 15
type: string
email:
description: Adresse email du contact du vendeur.
maxLength: 50
type: string
contact:
description: Point de contact du vendeur
maxLength: 99
type: string
assuranceProAssureur:
description: Assureur de l'assurance professionnelle du vendeur.
type: string
assuranceProCouvertureGeo:
description: Couverture géographique de l'assurance professionnelle du vendeur.
type: string
assuranceDecennaleAssureur:
description: Assureur de l'assurance décennale du vendeur.
type: string
assuranceDecennaleCouvertureGeo:
description: Couverture géographique de l'assurance décennale du vendeur.
type: string
autresInformations:
description: Liste des autres informations concernant le vendeur.
type: array
items:
type: string
adresse:
description: Adresse postale du vendeur.
allOf:
-
$ref: '#/components/schemas/AdressePostaleDto'
VenteCreationDto
[TBD]