Documentation API

Versions

v3.0
v3.1

Description

Récupére les factures de votre site. Plusieurs filtres sont possibles.

Quota

La méthode est limitée à 100 appels/heure. SI le quota est dépassé, un code erreur 400 sera retourné.

URL

{version}/invoice/

Méthode

GET

Headers

Paramètre	Valeur
X-Auth-Token	Valeur de votre token

Paramètres de l'url

Paramètre	Type	Obligatoire	Description	Commentaire
version	Alphanumérique	Oui	Le numéro de la version de l’API que vous souhaitez appeler.	Valeurs possibles : v3.1
page	Numérique	Non	Le numéro de la page que vous souhaitez récupérer. Une page correspond à une liste de véhicules. (Voir paramètre count).	Si non défini, la valeur de « page » sera par défaut à 1.
count	Numérique	Non	Le nombre de véhicules désirés sur la page demandée. (Voir paramètre page).	Si non défini, la valeur de « count » sera par défaut à 10. Ce paramètre ne peut dépasser 100. Si besoin de récupérer plus d'éléments, utilisez le paramètre page ci-dessus.
uniqueId	Numérique	Non	Filtre sur le champ « uniqueId »
number	Alphanumérique	Non	Filtre sur le numéro de facture
orderFormNumber	Alphanumérique	Non	Filtre sur le numéro du B.C. associé à la facture
vehicleReference	Alphanumérique	Non	Filtre sur le numéro de dossier du véhicule associé
invoiceDateFrom	Date	Non	Filtre sur la date de la facture. Format : "2000-12-31" pour le 31 décembre 2000	Retournera les factures qui ont une date inférieur à celle précisée en paramètre
invoiceDateTo	Date	Non	Filtre sur la date de la facture. Format : "2000-12-31" pour le 31 décembre 2000	Retournera les factures qui ont une date inférieur à celle précisée en paramètre
updateDateFrom	Date	Non	Filtre sur la date de dernière modification de la facture. Format : "2000-12-31" pour le 31 décembre 2000	Retourneras les factures qui ont une date de dernière modification supérieur à celle précisée en paramètre
updateDateTo	Date	Non	Filtre sur la date de dernière modification de la facture. Format : "2000-12-31" pour le 31 décembre 2000	Retourneras les factures qui ont une date de dernière modification inférieur à celle précisée en paramètre
state	Alphanumérique	Non	Etat de la facture. Préciser son code et pas son nom. Plus de précisions sur "Voir détail"	Voir détail
customer	Alphanumérique	Non	Siret ou Email du client	Si client professionnel ou site : filtre sur le siret. Si client particulier : filtre sur l'email.

Données de la requête

Aucune

Réponse

Statut code : 200
Contenu :

Variable	Type	Description
datas	Tableau de « Invoice »	Liste des factures
total	Numérique	Nombre total d'éléments
currentPage	Numérique	Numéro de la page courante
perPage	Numérique	Nombre d'éléments par page

Variable	Type	Description	Commentaire
uuid	Alphanumérique	Identifiant unique
uniqueId	Numérique	Numéro unique	Correspond au numéro de la facture sans le préfixe
number	Alphanumérique	Numéro de la facture	Correspond au numéro de la facture avec le préfixe
invoiceDate	Date	Date de la facture
deliveryDate	Date	Date de livraison
destination	Alphanumérique	Destination
invoiceSellDate	Date	Date/h de vente
seller	Alphanumérique	Vendeur	Adresse email
type	Alphanumérique	Type de facture (Véhicule, Prestation, Avoir, Location, Atelier)
group	Alphanumérique	Site de la facture
state	Alphanumérique	Etat de la facture
downloadLink	Lien	Lien de téléchargement de la facture
sellPriceWithoutTax	Numérique	Prix HT
sellPriceWithTax	Numérique	Prix TTC
balance	Numérique	Solde
fundingOrganization	Alphanumérique	Organisme de garantie
fundingDateEndFunding	Date	Date de fin de financement
customer	Contact particulier \| Contact professionnel	Client
owner	Contact particulier \| Contact professionnel	Propriétaire
items	Tableau de VehicleSelling \| ServiceSelling	Liste des éléments vendus
payments	Tableau de Payment	Liste des paiements
notes	Tableau de Note	Liste des notes
orderForm	OrderForm	Bon de commande associé
bundle	bundle	Lot associé

Variable	Type	Description	Commentaire
discr	Alphanumérique	Type de contact	Voir détail
siret	Numérique	SIRET	Identifiant d'un contact professionnel
CorporateNameContact	Alphanumérique	Raison Sociale
legalFormContact	Alphanumérique	Forme Juridique
tvaIntracom	Alphanumérique	TVA Intracom
email	Alphanumérique	Email
phoneNumber	Alphanumérique	Téléphone fixe
cellPhoneNumber	Alphanumérique	Téléphone portable
faxNumber	Alphanumérique	Fax
address	Adresse	Adresse
driverBirthDate	Date	Date de naissance
knownFrom	Alphanumérique	Champs 'Nous a connu par'

Variable	Type	Description	Commentaire
discr	Alphanumérique	Type de contact	Voir détail
civility	Alphanumérique	Civilité
firstname	Alphanumérique	Prénom
lastname	Alphanumérique	Nom
email	Alphanumérique	Email	Identifiant d'un contact particulier
phoneNumber	Alphanumérique	Téléphone fixe
cellPhoneNumber	Alphanumérique	Téléphone portable
faxNumber	Alphanumérique	Fax
address	Adresse	Adresse
driverBirthDate	Date	Date de naissance
knownFrom	Alphanumérique	Champs 'Nous a connu par'

Variable	Type	Description	Commentaire
address	Alphanumérique	Adresse
addressNext	Alphanumérique	Adresse complémentaire
postalCode	Alphanumérique	Code postal
city	Alphanumérique	Ville
country	Pays	Pays	Voir détail

Variable	Type	Description	Commentaire
type	Alphanumérique	Valeur vehicle_selling
vehicleReference	Alphanumérique	N° de dossier véhicule	Identifiant d'un véhicule
sellPriceWithoutTaxWithoutDiscount	Alphanumérique	Prix de vente HT
priceDiscount	Numérique	Remise HT
zone	Numérique	Zone	Voir détail
tax	Numérique	TVA	Voir détail

Variable	Type	Description	Commentaire
type	Alphanumérique	Valeur service_selling
reference	Alphanumérique	Référence	Identifiant d'une prestation
name	Alphanumérique	Libellé
sellPriceWithoutTaxWithoutDiscount	Numérique	Total HT
quantity	Numérique	Quantité
priceDiscount	Numérique	Remise HT
sellZone	Numérique	Zone	Voir détail
sellTax	Numérique	TVA	Voir détail

Variable	Type	Description
condition	Alphanumérique	Condition de règlement
mode	Alphanumérique	Mode de règlement
receiveDate	Date	Reçu le
termDate	Date	Echéance
amount	Numérique	Montant
bank	Alphanumérique	Banque
checkNumber	Alphanumérique	N° chèque
siteBank	Alphanumérique	Remise en banque

Variable	Type	Description	Commentaire
title	Alphanumérique	Désignation
content	Alphanumérique	Remarque

Variable	Type	Description	Commentaire
number	Alphanumérique	Numéro du bon de commande

Variable	Type	Description	Commentaire
number	Alphanumérique	Numéro du lot

Erreurs

Statut code	Contenu
401	Invalid authentication token
500	Une erreur est survenue lors de l'affichage des factures.

Description

Récupére une facture de votre site par son identifiant.

Quota

La méthode est limitée à 100 appels/heure. SI le quota est dépassé, un code erreur 400 sera retourné.

URL

{version}/invoice/{uniqueId}

Méthode

GET

Headers

Paramètre	Valeur
X-Auth-Token	Valeur de votre token

Paramètres de l'url

Paramètre	Type	Obligatoire	Description	Commentaire
version	Alphanumérique	Oui	Le numéro de la version de l’API que vous souhaitez appeler.	Valeurs possibles : v3.1
uniqueId	Numérique	Oui	Identifiant de la facture Correspond au numéro de la facture sans le préfixe

Données de la requête

Aucune

Réponse

Statut code : 200
Contenu : Un élément de type Invoice

Variable	Type	Description	Commentaire
uuid	Alphanumérique	Identifiant unique
uniqueId	Numérique	Numéro unique	Correspond au numéro de la facture sans le préfixe
number	Alphanumérique	Numéro de la facture	Correspond au numéro de la facture avec le préfixe
invoiceDate	Date	Date de la facture
deliveryDate	Date	Date de livraison
destination	Alphanumérique	Destination
invoiceSellDate	Date	Date/h de vente
seller	Alphanumérique	Vendeur	Adresse email
type	Alphanumérique	Type de facture (Véhicule, Prestation, Avoir, Location, Atelier)
group	Alphanumérique	Site de la facture
state	Alphanumérique	Etat de la facture
downloadLink	Lien	Lien de téléchargement de la facture
sellPriceWithoutTax	Numérique	Prix HT
sellPriceWithTax	Numérique	Prix TTC
balance	Numérique	Solde
fundingOrganization	Alphanumérique	Organisme de garantie
fundingDateEndFunding	Date	Date de fin de financement
customer	Contact particulier \| Contact professionnel	Client
owner	Contact particulier \| Contact professionnel	Propriétaire
items	Tableau de VehicleSelling \| ServiceSelling	Liste des éléments vendus
payments	Tableau de Payment	Liste des paiements
notes	Tableau de Note	Liste des notes
orderForm	OrderForm	Bon de commande associé
bundle	bundle	Lot associé

Variable	Type	Description	Commentaire
discr	Alphanumérique	Type de contact	Voir détail
siret	Numérique	SIRET	Identifiant d'un contact professionnel
CorporateNameContact	Alphanumérique	Raison Sociale
legalFormContact	Alphanumérique	Forme Juridique
tvaIntracom	Alphanumérique	TVA Intracom
email	Alphanumérique	Email
phoneNumber	Alphanumérique	Téléphone fixe
cellPhoneNumber	Alphanumérique	Téléphone portable
faxNumber	Alphanumérique	Fax
address	Adresse	Adresse
driverBirthDate	Date	Date de naissance
knownFrom	Alphanumérique	Champs 'Nous a connu par'

Variable	Type	Description	Commentaire
discr	Alphanumérique	Type de contact	Voir détail
civility	Alphanumérique	Civilité
firstname	Alphanumérique	Prénom
lastname	Alphanumérique	Nom
email	Alphanumérique	Email	Identifiant d'un contact particulier
phoneNumber	Alphanumérique	Téléphone fixe
cellPhoneNumber	Alphanumérique	Téléphone portable
faxNumber	Alphanumérique	Fax
address	Adresse	Adresse
driverBirthDate	Date	Date de naissance
knownFrom	Alphanumérique	Champs 'Nous a connu par'

Variable	Type	Description	Commentaire
address	Alphanumérique	Adresse
addressNext	Alphanumérique	Adresse complémentaire
postalCode	Alphanumérique	Code postal
city	Alphanumérique	Ville
country	Pays	Pays	Voir détail

Variable	Type	Description	Commentaire
type	Alphanumérique	Valeur vehicle_selling
vehicleReference	Alphanumérique	N° de dossier véhicule	Identifiant d'un véhicule
sellPriceWithoutTaxWithoutDiscount	Alphanumérique	Prix de vente HT
priceDiscount	Numérique	Remise HT
zone	Numérique	Zone	Voir détail
tax	Numérique	TVA	Voir détail

Variable	Type	Description	Commentaire
type	Alphanumérique	Valeur service_selling
reference	Alphanumérique	Référence	Identifiant d'une prestation
name	Alphanumérique	Libellé
sellPriceWithoutTaxWithoutDiscount	Numérique	Total HT
quantity	Numérique	Quantité
priceDiscount	Numérique	Remise HT
sellZone	Numérique	Zone	Voir détail
sellTax	Numérique	TVA	Voir détail

Variable	Type	Description
condition	Alphanumérique	Condition de règlement
mode	Alphanumérique	Mode de règlement
receiveDate	Date	Reçu le
termDate	Date	Echéance
amount	Numérique	Montant
bank	Alphanumérique	Banque
checkNumber	Alphanumérique	N° chèque
siteBank	Alphanumérique	Remise en banque

Variable	Type	Description	Commentaire
title	Alphanumérique	Désignation
content	Alphanumérique	Remarque

Variable	Type	Description	Commentaire
number	Alphanumérique	Numéro du bon de commande

Variable	Type	Description	Commentaire
number	Alphanumérique	Numéro du lot

Erreurs

Statut code	Contenu
401	Invalid authentication token.
404	L'élément demandé n'existe pas.
500	Une erreur est survenue lors de l'affichage de la facture, number : {uniqueId}.

Description

Télécharger une facture de votre site qui a déjà été éditée.
Récupére la facture par son identifiant.

Quota

La méthode est limitée à 100 appels/heure. SI le quota est dépassé, un code erreur 400 sera retourné.

URL

{version}/invoice/{uniqueId}/document

Méthode

GET

Headers

Paramètre	Valeur
X-Auth-Token	Valeur de votre token

Paramètres de l'url

Paramètre	Type	Obligatoire	Description	Commentaire
version	Alphanumérique	Oui	Le numéro de la version de l’API que vous souhaitez appeler.	Valeurs possibles : v3.1
uniqueId	Numérique	Oui	numéro de la facture Correspond au numéro de la facture sans le préfixe

Réponse

Statut code : 200
Contenu : Un fichier au format « PDF »

Erreurs

Statut code	Contenu
401	Invalid authentication token
500	Une erreur est survenue lors du téléchargement de la facture, number : {uniqueId}.

Liste des Zones

Code	Valeur
0	France
1	UE
2	Hors UE
3	Luxembourg
4	Import / Export
5	Martinique
6	Guadeloupe
7	La Réunion
8	Monaco
9	Espagne
10	Belgique
11	Côte d'Ivoire
12	Allemagne

Liste des TVA

Code	Valeur
0	TVA 20
1	TVA Exo
2	TVA/Marge
3	TVA 5,5
4	Sans TVA
5	Franchise de TVA
6	TVA 17
7	TVA 8,5
8	TVA 21
9	TVA 18
10	TVA 19
11	TVA 7

Etats - Liste des états

Code	Etat	Commentaires
invoice.state.processing	En cours
invoice.state.edit	Editée
invoice.state.valid	Validé
invoice.state.canceled	Annulé

Contact - Liste des civilités

Code	Valeur
0	M.
1	Mme

Contact - Liste des natures

Code	Valeur
0	Société
1	Négociant
2	Collectivité

Contact - Liste des discr

Code	Valeur
individual	Particulier
professional	Professionnel
group	Site

Liste des Pays

Code	Pays	Code	Pays	Code	Pays	Code	Pays	Code	Pays	Code	Pays
AF	Afghanistan	ZA	Afrique du Sud	AL	Albanie	DZ	Algérie	DE	Allemagne	AD	Andorre
AO	Angola	AI	Anguilla	AQ	Antarctique	AG	Antigua-et-Barbuda	SA	Arabie saoudite	AR	Argentine
AM	Arménie	AW	Aruba	AU	Australie	AT	Autriche	AZ	Azerbaïdjan	BS	Bahamas
BH	Bahreïn	BD	Bangladesh	BB	Barbade	BE	Belgique	BZ	Belize	BJ	Bénin
BM	Bermudes	BT	Bhoutan	BY	Biélorussie	BO	Bolivie	BA	Bosnie-Herzégovine	BW	Botswana
BR	Brésil	BN	Brunéi Darussalam	BG	Bulgarie	BF	Burkina Faso	BI	Burundi	KH	Cambodge
CM	Cameroun	CA	Canada	CV	Cap-Vert	EA	Ceuta et Melilla	CL	Chili	CN	Chine
CY	Chypre	CO	Colombie	KM	Comores	CG	Congo-Brazzaville	CD	Congo-Kinshasa	KP	Corée du Nord
KR	Corée du Sud	CR	Costa Rica	CI	Côte d’Ivoire	HR	Croatie	CU	Cuba	CW	Curaçao
DK	Danemark	DG	Diego Garcia	DJ	Djibouti	DM	Dominique	EG	Égypte	AE	Émirats arabes unis
EC	Équateur	ER	Érythrée	ES	Espagne	EE	Estonie	VA	État de la Cité du Vatican	FM	États fédérés de Micronésie
US	États-Unis	ET	Éthiopie	FJ	Fidji	FI	Finlande	FR	France	GA	Gabon
GM	Gambie	GE	Géorgie	GS	Géorgie du Sud et îles Sandwich du Sud	GH	Ghana	GI	Gibraltar	GR	Grèce
GD	Grenade	GL	Groenland	GP	Guadeloupe	GU	Guam	GT	Guatemala	GG	Guernesey
GN	Guinée	GQ	Guinée équatoriale	GW	Guinée-Bissau	GY	Guyana	GF	Guyane française	HT	Haïti
HN	Honduras	HU	Hongrie	CX	Île Christmas	AC	Île de l’Ascension	IM	Île de Man	NF	Île Norfolk
AX	Îles Åland	KY	Îles Caïmans	IC	Îles Canaries	CC	Îles Cocos	CK	Îles Cook	FO	Îles Féroé
FK	Îles Malouines	MP	Îles Mariannes du Nord	MH	Îles Marshall	UM	Îles mineures éloignées des États-Unis	PN	Îles Pitcairn	SB	Îles Salomon
TC	Îles Turques-et-Caïques	VG	Îles Vierges britanniques	VI	Îles Vierges des États-Unis	IN	Inde	ID	Indonésie	IQ	Irak
IR	Iran	IE	Irlande	IS	Islande	IL	Israël	IT	Italie	JM	Jamaïque
JP	Japon	JE	Jersey	JO	Jordanie	KZ	Kazakhstan	KE	Kenya	KG	Kirghizistan
KI	Kiribati	XK	Kosovo	KW	Koweït	RE	La Réunion	LA	Laos	LS	Lesotho
LV	Lettonie	LB	Liban	LR	Libéria	LY	Libye	LI	Liechtenstein	LT	Lituanie
LU	Luxembourg	MK	Macédoine	MG	Madagascar	MY	Malaisie	MW	Malawi	MV	Maldives
ML	Mali	MT	Malte	MA	Maroc	MQ	Martinique	MU	Maurice	MR	Mauritanie
YT	Mayotte	MX	Mexique	MD	Moldavie	MC	Monaco	MN	Mongolie	ME	Monténégro
MS	Montserrat	MZ	Mozambique	MM	Myanmar (Birmanie)	NA	Namibie	UN	Nations Unies	NR	Nauru
NP	Népal	NI	Nicaragua	NE	Niger	NG	Nigéria	NU	Niue	NO	Norvège
NC	Nouvelle-Calédonie	NZ	Nouvelle-Zélande	OM	Oman	UG	Ouganda	UZ	Ouzbékistan	PK	Pakistan
PW	Palaos	PA	Panama	PG	Papouasie-Nouvelle-Guinée	PY	Paraguay	NL	Pays-Bas	BQ	Pays-Bas caribéens
PE	Pérou	PH	Philippines	PL	Pologne	PF	Polynésie française	PR	Porto Rico	PT	Portugal
QA	Qatar	HK	R.A.S. chinoise de Hong Kong	MO	R.A.S. chinoise de Macao	CF	République centrafricaine	DO	République dominicaine	RO	Roumanie
GB	Royaume-Uni	RU	Russie	RW	Rwanda	EH	Sahara occidental	BL	Saint-Barthélemy	KN	Saint-Christophe-et-Niévès
SM	Saint-Marin	MF	Saint-Martin	SX	Saint-Martin (partie néerlandaise)	PM	Saint-Pierre-et-Miquelon	VC	Saint-Vincent-et-les-Grenadines	SH	Sainte-Hélène
LC	Sainte-Lucie	SV	Salvador	WS	Samoa	AS	Samoa américaines	ST	Sao Tomé-et-Principe	SN	Sénégal
RS	Serbie	SC	Seychelles	SL	Sierra Leone	SG	Singapour	SK	Slovaquie	SI	Slovénie
SO	Somalie	SD	Soudan	SS	Soudan du Sud	LK	Sri Lanka	SE	Suède	CH	Suisse
SR	Suriname	SJ	Svalbard et Jan Mayen	SZ	Swaziland	SY	Syrie	TJ	Tadjikistan	TW	Taïwan
TZ	Tanzanie	TD	Tchad	CZ	Tchéquie	TF	Terres australes françaises	IO	Territoire britannique de l’océan Indien	PS	Territoires palestiniens
TH	Thaïlande	TL	Timor oriental	TG	Togo	TK	Tokélaou	TO	Tonga	TT	Trinité-et-Tobago
TA	Tristan da Cunha	TN	Tunisie	TM	Turkménistan	TR	Turquie	TV	Tuvalu	UA	Ukraine
UY	Uruguay	VU	Vanuatu	VE	Venezuela	VN	Vietnam	WF	Wallis-et-Futuna	YE	Yémen
ZM	Zambie	ZW	Zimbabwe	EZ	zone euro

Facture v3.1

Versions

Description

Quota

URL

Méthode

Headers

Paramètres de l'url

Données de la requête

Réponse

Type « Invoice »

Type « Contact professionnel »

Type « Contact particulier »

Type « Adresse »

Type « VehicleSelling »

Type « ServiceSelling »

Type « Payment »

Type « Note »

Type « OrderForm »

Type « Bundle »

Erreurs

Description

Quota

URL

Méthode

Headers

Paramètres de l'url

Données de la requête

Réponse

Type « Invoice »

Type « Contact professionnel »

Type « Contact particulier »

Type « Adresse »

Type « VehicleSelling »

Type « ServiceSelling »

Type « Payment »

Type « Note »

Type « OrderForm »

Type « Bundle »

Erreurs

Description

Quota

URL

Méthode

Headers

Paramètres de l'url

Réponse

Erreurs

Liste des Zones

Liste des TVA

Etats - Liste des états

Contact - Liste des civilités

Contact - Liste des natures

Contact - Liste des discr

Liste des Pays