Que pouvons-nous vous aider à trouver ? Produits Documentation produit Coupa Documentation technique sur l'intégration L'API Coupa Core Ressources Ressources transactionnelles API INVOICES (/INVOICES)

API INVOICES (/INVOICES)

Utilisez l'API de facture pour créer, mettre à jour ou interroger les factures associées à un bon de commande.

Aperçu

L'URL pour accéder aux factures est : https ://{your_instance_name}/api/invoices

À partir de la version 29, Coupa a amélioré l'API de facturation pour qu'elle soit pleinement fonctionnelle, sur un pied d'égalité avec les autres canaux d'achat de factures. Pour plus d'informations sur cette mise à jour, voir Couverture étendue de l'API de facturation pour la création de factures.

Voir les meilleures pratiques d'intégration pour plus d'informations.

Actions

L'API Factures vous permet de :

Verbe	Chemin d'accès	Action	Description
METTRE	`/api/invoices/:id/abandon`	abandon	Facture d'abandon
METTRE	`/api/invoices/:id/add_approver`	Ajouter un approbateur	Ajouter manuellement un approbateur pour une facture
METTRE	`/api/invoices/:id/bypass_approvals`	Contourner les approbations	Contourner les approbations Permet à un système tiers du côté des clients d'obtenir une facture approuvée et payée aussi rapidement que possible.
METTRE	`/api/invoices/:id/bypass_current_approval`	Ignorer l'approbation actuelle	Passer outre l'approbation actuelle Permet à un système tiers du côté des clients d'obtenir une facture approuvée par l'approbateur actuel pour qu'une facture soit payée aussi rapidement que possible.
METTRE	`/api/invoices/:id/dispute`	Contester	Contester la facture Permet de déplacer une facture à l'état contesté via un appel système. Déplacer une facture vers contestée informe le fournisseur qu'il y a un problème avec une facture. La demande de contestation peut inclure un motif de contestation dans la charge utile comme suit : <invoice-header> <dispute-reason> <code>INCORRECT-QUANTITÉ</code> </dispute-reason> <comment>Un commentaire du fournisseur</comment> </invoice-header> Cela nécessite que INCORRECT_QUANTITY soit un motif de contestation valide et actif.
METTRE	`/api/invoices/:id/flip_to_advance_ship_notice`	Retourner pour avancer la notification d'expédition	Basculer la facture vers un préavis d'expédition
OBTENIR	`/api/invoices/:id/retrieve_image_scan`	Récupérer scan image	Récupérer/télécharger le scan de l'image
METTRE	`/api/INVOICES/:id/image_scan`	Scan de l\ 'image	Mettre à jour la pièce jointe de numérisation d'image ou l'URL de
OBTENIR	`/API/factures`	Index	Demander les factures
METTRE	`/api/invoices/:id/remove_approval`	Supprimer approbation	Supprimer un approbateur ajouté manuellement
METTRE	`/api/invoices/:id/restart_approvals`	Redémarrer les approbations	Redémarrer les approbations Permet à un système tiers du côté des clients d'effacer la chaîne d'approbation actuelle et de régénérer une nouvelle chaîne d'approbation pour une facture qui a été modifiée.
OBTENIR	`/api/invoices/:id/retrieve_clearance_document`	retrieve_clearance_document	Récupérer/télécharger le document d'autorisation
OBTENIR	`/api/invoices/:id/retrieve_legal_invoice_pdf`	récupérer_facture_juridique_pdf	Télécharger/récupérer le PDF de la facture légale. Cette action permet d'exporter la pièce jointe PDF par appel API.
METTRE	`/API/INVOICES/:id/revalidate_TOLERANCES`	Valider à nouveau les tolérances	Valider à nouveau les tolérances Permet à un système tiers du côté des clients de soumettre à nouveau une facture qui a eu des problèmes.
OBTENIR	`/api/invoices/:id`	Afficher	Afficher la facture
METTRE	`/api/invoices/:id/submit`	Soumettre	Soumettre le projet de facture pour approbation
PATCH	`/api/invoices/:id`	Mettre à jour	Mettre à jour la facture
METTRE	`/api/invoices/:id`	Mettre à jour	Mettre à jour la facture Utilisé pour mettre à jour les informations sur la facture à l'aide de l'API
METTRE	`/api/invoices/:id/update_line_accounts`	Mettre à jour les comptes de ligne	Mettre à jour les comptes de ligne Utilisé par les utilisateurs mobiles pour mettre à jour les factures
METTRE	`/api/invoices/:id/void`	Annuler	Annuler une facture approuvée Cela peut être utilisé sur les factures uniquement sur les factures approuvées et en attente de réception. BUYER_VOIDABLE_STATUS = [:pending_receipt, :approved, :draft] SUPPLIER_VOIDABLE_STATUS = [:en attente_réception, :approuvé]
METTRE	`/api/invoices/:id/withdraw_dispute`	Retirer le litige	Retirer la contestation En raison de l'inaction du fournisseur ou d'une erreur de l'acheteur, une facture contestée peut être renvoyée au processus d'approbation.

Éléments

Élément	Description	Req'd	Unique	Valeur autorisée	Dans	Sortie	Type de données
abandon-reason	Motif de l'abandon	non	non	tout		oui	Reason Insight
type de compte	Référence du plan comptable	oui			oui	oui	Type de compte
acompte-paiement-reçu-montant	Montant de l'avance reçue				oui	oui	décimale(30,4)
amount-due-less-discount	Montant dû après application de la remise			tout		oui	décimale
approbations	Approbations					oui	Approbation
pièces jointes						oui	Pièce jointe
archive-entity-id	ID de l'entité d'archivage					oui	nombre entier
facture-à-adresse	Adresse de facturation	oui			oui	oui	Adresse
inscription-taxe-acheteur	Inscription aux taxes de l'acheteur	oui*				oui	Inscription aux taxes
annulé	Indique si la transaction a été annulée					oui	boolean
cash-accounting-scheme-reference	Notez si vous utilisez un régime de comptabilité de caisse				oui	oui	string(255)
clearance-document	Nom du fichier en pièce jointe du document d'apurement. Accessible via /retrieve_clearance_document					oui	chaîne
commentaires	commentaires				oui	oui	string(255)
conforme	Indicateur de conformité des factures					oui	boolean
confirmation	Confirmation					oui	string(50)
contrat	Numéro de contrat de sauvegarde				oui	oui	Contrat
coupa-accélérer-statut	Statut indiquant si la facture est assortie de conditions de paiement avec remise via la remise statique.			accéléré		oui	string(40)
created-at	Créé automatiquement par Coupa au format AAAA-MM-JJFHH :MM :SS+HH :MMZ					oui	datetime
créé par	Utilisateur qui a créé					oui	Utilisateur
credit-note-differences-with-original-invoice	Différences de la note de crédit avec la facture d'origine				oui	oui	décimale(30,4)
raison-de-crédit	La raison de la création du crédit				oui	oui	string(255)
devise	Code de devises				oui	oui	Devise
enregistrements-histoire-intégration-courant	Historique d'enregistrement de l'intégration actuelle					oui	Enregistrement de l'historique d'intégration
customer-accounting-tax-less-discount	Impôt de comptabilité client après application de la remise			tout		oui	décimale
date-déclaration-douane	Date de déclaration douanière				oui	oui	datetime
numéro-déclaration-douane	Numéro de déclaration douanière				oui	oui	string(60)
bureau de douane	Bureau des douanes				oui	oui	texte
date-réception	Date de réception au format AAAA-MM-JJFHH :MM :SS+HH :MMZ					oui	datetime
date de livraison	Date d'approvisionnement	non	non	tout		oui	datetime
pays de destination	Pays de destination utilisé pour la conformité					oui	Pays
discount-amount	Montant de remise fourni par le fournisseur				oui	oui	décimale(32,4)
discount-due-date	Date d'échéance pour la remise calculée en fonction des modalités de paiement de la remise					oui	datetime
discount-percent	Remise %				oui	oui	flotteur
méthode-de-contestation	Méthode de contestation	non	non	tout		oui	string(10)
motifs-de-conflit	Motifs de contestation	non	non	tout		oui	Motif du différend
type de document	Facture ou avoir			Facture, note de crédit		oui	string(255)
dispositions de paiement anticipé	Incitations au paiement anticipé				oui	oui	string(255)
taux de change	Taux de change				oui	oui	décimale(30,9)
exported	Indique si la transaction a été exportée					oui	boolean
fail-tolerances	Échec des tolérances				oui	oui	Facture : :FailedTolerance
folio-number	Numéro de folio					oui	string(255)
mode de paiement	Formulaire de paiement					oui	string(10)
brut-total	Total net					oui	décimale
rabais-total-moins-brut	Total de la facture après application de la réduction			tout		oui	décimale
handling-amount	Montant de traitement				oui	oui	décimale(32,4)
id	Identifiant unique Coupa					oui	nombre entier
image-scan	Nom de fichier de la pièce jointe de la numérisation de l'image de la					oui	string(25)
image-scan-content-type	Type de contenu de scan de l'image					oui	string(191)
image-scan-file-name	Nom de fichier de l'analyse d'image					oui	string(255)
image-scan-file-size	Taille du fichier de numérisation de l'image en Mo					oui	string(12)
image-scan-url	URL de la numérisation d'image de facture. Doit commencer par 'http ://' ou 'https ://'.					oui	string(255)
facture entrante	Référence de la facture entrante					oui	Facture entrante
nom de la boîte de réception	Nom de la boîte de réception					oui	chaîne
internal-note	Note interne				oui	oui	texte
facture-frais	Frais de facturation				oui	oui	Frais de facture
date-de-facture	Date de la facture	oui			oui	oui	datetime
facture-de-adresse	Adresse du lieu de facturation	oui*				oui	Coordonnées de paiement du fournisseur
lignes de facture	Identifiant de l'enregistrement				oui	oui	Ligne de facture
numéro-de-facture	Numéro de facture	oui			oui	oui	string(40)
facture-paiement-reçus	Informations sur les reçus de paiement liés à la facture					oui	Reçu de paiement de la facture
référence-de-facture-numéro	Numéro de référence de facturation (NRF)				oui	oui
lieu-d' émission	Lieu d'émission					oui	string(50)
last-exported-at	Date et heure de la dernière exportation de la transaction au format AAAA-MM-JJFHH :MM :SS+HH :MMZ					oui	datetime
retard de paiement-pénalités	Pénalités pour retard de paiement				oui	oui	string(255)
pays-de-destination-légale	Pays de destination légale utilisé pour la conformité			Voir la liste des pays conformes.		oui	Pays
taxation au niveau de la ligne	Marquer indiquant si les taxes sont fournies au niveau de la ligne dans cette facture	oui			oui	oui	boolean
lock-version-key	Verrouiller la version					oui	nombre entier
margin-scheme	Motif d'utilisation du schéma de marge				oui	oui	string(255)
misc-amount	Montant divers				oui	oui	décimale(32,4)
net-due-date	Date d'échéance nette calculée sur la base des conditions de paiement net					oui	datetime
net-total-less-discount	Total net après application de la remise			tout		oui	décimale
pays d'origine	Pays d'origine utilisé pour la conformité					oui	Pays
origine-currency-gross	Devise locale brute	oui*				oui	décimale(32,4)
origine-currency-net	Devise locale nette	oui*				oui	décimale(32,4)
original-invoice-date	Date de la facture d'origine requise `lorsqueis-credit-note =true`	oui**				oui	datetime
original-invoice-number	Date de la facture d'origine requise `lorsqueis-credit-note =true`	oui**				oui	string(40)
payé	Payé				oui	oui	boolean
payer-facture	Paiement de la facture					oui
canal de paiement	Comment le paiement de la facture sera traité - ERP (par défaut), carte virtuelle Coupa Pay, paiement de la facture Coupa Pay	non	non	tout		oui	string(40)
date-de-paiement	Date de paiement de la facture				oui	oui	datetime
mode-de-paiement	Mode de paiement					oui	string(10)
notes-de-paiement	Notes incluses avec le paiement de la facture				oui	oui	texte
référence-ordre-de-paiement	Référence d'ordre de paiement				oui	oui	string(255)
délai de paiement	Code de modalité de paiement sur la facture				oui	oui	Modalité de paiement
paiements	Paiements				oui	oui	Paiement
date de prépaiement	Date de paiement anticipé				oui	oui	datetime
lignes-de-conciliation	Lignes de rapprochement				oui		Ligne de facturation/rapprochement
remit-to-adress	Coordonnées de paiement	oui			oui	oui	Coordonnées de paiement
demandé par	Demandeur sur la facture					oui	Utilisateur
numéro-de-résolution	Numéro de la résolution				oui	oui	string(255)
reverse-charge-reference	Autoliquidation				oui	oui
signé-qr-code	Code QR signé					oui	texte
autofacturation-référence	Référence d'auto-facturation sur la facture				oui	oui	string(191)
adresse e-mail de l'expéditeur	Adresse e-mail de l'émetteur					oui	string(255)
série	Séries					oui	string(30)
ship-from-address	Adresse du lieu d'expédition	oui				oui	Coordonnées de paiement du fournisseur
adresse d'expédition	Adresse d'expédition				oui	oui	Adresse
shipping-amount	Montant de l'expédition				oui	oui	décimale(32,4)
délai d'expédition	Code du délai d'expédition sur la facture					oui	Condition d'expédition
show-tax-information	Afficher les informations fiscales dans la facture					oui	boolean
statut	État de la facture. Pour plus d'informations sur les statuts des factures, voir Progression des factures dans les statuts.			nouvelle, ap_hold, brouillon, en_attente, pending_receipt, rejeté, abandonné. en litige. pending_approval, booking_hold, pending_action, approuvé, nulle, traitement, non valide, pending_action, payable_adjustment		oui	string(50)
fournisseur	Nom ou numéro du fournisseur				oui	oui	Fournisseur
créé par le fournisseur	Indicateur créé par le fournisseur pour la facture					oui	boolean
fournisseur-note	Note fournie par le fournisseur				oui	oui	texte
supplier-remit-to	Adresse de paiement fournie par le fournisseur	oui			oui	oui	Coordonnées de paiement du fournisseur
enregistrement-taxe-fournisseur	Enregistrement de la taxe fournisseur	oui*				oui	Inscription aux taxes
fournisseur-total	Total du fournisseur					oui	décimale
étiquetages	Etiquetages				oui	oui	Étiquetage
étiquettes	Étiquette (Obsolète, veuillez utiliser l'association d'étiquettes pour ajouter des étiquettes sur InvoiceHeader)				oui	oui	Étiquette
montant-taxe	Montant de la taxe (non utilisé si la taxe est fournie au niveau de la ligne)				oui	oui	décimale
tax-amount-engine	Montant de la taxe calculé par Coupa Native ou par le moteur fiscal externe en fonction de la configuration					oui	décimale
code fiscal	Code fiscal (non utilisé si la taxe est fournie au niveau de la ligne)				oui	oui	string(255)
tax-code-engine	Code fiscal renvoyé par le moteur fiscal externe en fonction de la configuration					oui
taxe due au fournisseur	Impôt à verser au fournisseur					oui	décimale(32,4)
lignes-fiscales	Code de taxe de ligne (non utilisé si la taxe est fournie au niveau de l'en-tête)				oui	oui	Ligne des taxes
taux d'imposition	Taux de taxe (non utilisé si la taxe est fournie au niveau de la ligne)				oui	oui	flotteur
taux d'imposition-moteur	Taux d'imposition retourné par le moteur fiscal externe en fonction de la configuration					oui
taxes-dans-la-devise-pays-d' origine	Taxe en devise locale	oui*				oui	décimale(32,4)
tolérances-échecs	Défaut de tolérance					oui	string(512)
total-avec-taxes	Total TTC					oui	décimale
total-taxes-less-discount	Total des taxes après application de la remise			any		oui	décimale
type de reçu	Type de reçu					oui	string(10)
type de relation	Type de relation					oui	string(10)
mis-à-jour à	Créé automatiquement par Coupa au format AAAA-MM-JJFHH :MM :SS+HH :MMZ					oui	datetime
mis à jour par	Utilisateur ayant réalisé la mise à jour					oui	Utilisateur
utilisation-de-facture	Utilisation de la facture					oui	string(10)
lignes de retenue d'impôt	Lignes de retenue à la source				oui	oui	Ligne de retenue d'impôt
retenue d'impôt-dérogation	Remplacement de la retenue d'impôt					oui	décimale(30,3)
référence-de-facture-numéro	Numéro de référence de facturation (NRF)				oui	oui	string(255)
fournisseur-facture-nom-émetteur	Nom de l'émetteur de la facture du fournisseur				oui	oui	string(255)
nom-reviseur-fournisseur-facture	Nom du vérificateur de la facture fournisseur				oui	oui	string(255)
fournisseur-paiement-collecteur-nom	Nom du percepteur du paiement du fournisseur				oui	oui	string(255)
endossement-sur-factures	Endossement sur les factures					oui	string(10)
new-means-of-transport	Nouveaux moyens de transport					oui	string(10)
lieu de délivrance	Lieu d'émission					oui	string(100)
montant-de-l' avance-paiement	Montant du paiement anticipé				oui	oui	décimale(46,20)
transaction-uuid	UUID de la transaction					oui	string(50)
date-notification-transaction	Date de notification de la transaction					oui	datetime
validation de contenu	Indicateur de validation du contenu de la facture					oui	boolean
référence-de-facture-numéro	Numéro de référence de facturation (NRF)				oui	oui
fournisseur-facture-nom-émetteur	Nom de l'émetteur de la facture du fournisseur				oui	oui	string(255)
nom-reviseur-fournisseur-facture	Nom du vérificateur de la facture fournisseur				oui	oui	string(255)
fournisseur-paiement-collecteur-nom	Nom du percepteur du paiement du fournisseur				oui	oui	string(255)
is-credit-note	Note de crédit du type de document				oui		boolean
email du demandeur	E-mail du demandeur				oui		chaîne
nom-demandeur	Nom complet du demandeur				oui		chaîne
requester-lookup-name	Nom de recherche du demandeur				oui		chaîne
numéro-de-livraison	Numéro de livraison				oui		string(255)
date de livraison	Date d'approvisionnement				oui		datetime
valeur d'origine de l'offre	Valeur d'approvisionnement initiale				oui		décimale(46,20)
valeur-de-l' offre correcte	Valeur correcte d'approvisionnement				oui		décimale(46,20)
original-invoice-date	Date de la facture d'origine utilisée dans le cas d'une note de crédit	oui			oui		datetime
type de relation	Type de relation				oui		string(10)
original-invoice-number	Numéro de la facture d'origine utilisé dans le cas d'une note de crédit	oui			oui		string(40)
lieu d'approvisionnement	Lieu d'approvisionnement				oui		string(255)
mécanisme-de-paiement-divisé	Fractionner le mécanisme de paiement				oui		boolean
endossement-sur-factures	Endossement sur les factures				oui		string(10)
new-means-of-transport	Nouveaux moyens de transport				oui		string(10)
lieu de délivrance	Lieu d'émission				oui		string(100)
signé-qr-code	Code QR signé				oui		texte
délai d'expédition	Code du délai d'expédition sur la facture				oui
enregistrement-taxe-fournisseur		oui			oui
inscription-taxe-acheteur		oui			oui
payment-order-number	Numéro de l'ordre de paiement				oui		chaîne
facture-délai d'émission	Heure d'émission de la facture				oui		string(255)
caisse enregistreuse-exploitant	Opérateur de caisse				oui		string(255)
moyens de paiement	Modes de paiement				oui		string(255)
unique-identification-code-of-cash-receipt	Code d'identification unique de la recette de caisse				oui		string(255)
security-code-of-issuer	Code de sécurité de l'émetteur				oui		string(255)
state-tax-number	Numéro d'identifiant de l'impôt d'État				oui		string(255)
state-tax-number-for-substitute-taxpayer	Numéro d'identifiant de l'impôt d'État pour le contribuable substitut				oui		string(255)
municipal-tax-number	Numéro d'identifiant d'imposition municipale				oui		string(255)
série-code-de-facture-fiscale	Code de série de la facture fiscale				oui		string(255)
code-vérification	Code de vérification				oui		string(255)
type de document	Type de document				oui		string(255)
protocol-number	Numéro de protocole				oui		string(255)
nature de l'opération	Nature des activités				oui		string(255)
type d'opération	Type d'activité				oui		string(255)
type de fret	Type de fret				oui		string(255)
plaque d'immatriculation du véhicule	Plaque d'immatriculation du véhicule				oui		string(255)
national-enrôlement-du-convoyeur	Inscription nationale du convoyeur				oui		string(255)
volume-amount	Montant du volume				oui		string(255)
volume-poids brut	Poids brut du volume				oui		string(255)
volume-poids-liquide	Poids liquide du volume				oui		string(255)
volume-marque	Marque du volume				oui		string(255)
type de volume	Type de volume				oui		string(255)
numérotation des volumes	Numérotation du volume				oui		string(255)
notes-accord-de-paiement	Notes d'accord de paiement			Entièrement payé par le biais d'un accord de prépaiement, partiellement payé par le biais d'un accord de prépaiement, déjà payé pour un accord récurrent, conserver le paiement par accord	oui		string(255)
tcs-tax-lines					oui		-
facture-de-adresse		oui			oui		Adresse
ship-from-address		oui			oui		Adresse

Remarque

Les champs obligatoires marqués d'un astérisque * sont des champs obligatoires supplémentaires pour les factures conformes. Les champs obligatoires marqués de deux astérisques ** ne sont requis que lorsque is-credit-note=true.

Liste des pays conforme

Cette liste indique les pays autorisés pour la facturation conforme. Il ne s'agit pas d'une liste de pays conformes que Coupa prend actuellement en charge.

#id	Code	Nom
14	AU	Australie
15	AT	Autriche
22	BE	Belgique
31	BR	Brésil
34	BG	Bulgarie
39	CA	Canada
53	RH	Croatie
55	CY	Chypre
56	CZ	République tchèque
58	DK	Danemark
67	EE	Estonie
72	FI	Finlande
73	FR	France
79	DE	Allemagne
82	Go	Royaume-Uni
83	GR	Grèce
96	HK	Hong Kong
97	HU	Hongrie
98	IS	Islande
103	IE	Irlande
104	IL	Israël
105	IT	Italie
108	JP	Japon
118	BT	Lettonie
123	LI	Liechtenstein
124	LT	Lituanie
125	LU	Luxembourg
133	MT	Malte
138	MX	Mexique
141	MC	Monaco
144	MA	Maroc
151	NL	Pays-Bas
154	NZ	Nouvelle-Zélande
161	Non	Norvège
171	PL	Pologne
173	PT	Portugal
175	QA	Qatar
177	RO	Roumanie
183	SA	Arabie saoudite
187	SG	Singapour
188	SK	Slovaquie
189	SI	Slovénie
192	ZA	Afrique du Sud
193	ES	Espagne
204	SE	Suède
205	CH	Suisse
222	AE	Émirats arabes unis
223	États-Unis	États-Unis
250	Messagerie instantanée	Île de Man

Articles associés

API Coupa Core

Notre API RESTful fournit un accès fiable pour lire, modifier ou intégrer vos données à la plateforme Coupa.

Démarrez avec l'API

Informations générales sur l'utilisation de l'API Coupa et quand vous devez envisager d'utiliser CSV.

Transition vers OAuth 2.0 et OIDC

Coupa désapprouve les API Keys héritées et nécessite l'utilisation d'OAuth 2.0 / OIDC. À partir de R34, aucune nouvelle clé API ne sera émise et les clés API ne seront plus prises en charge avec R35.

Ressources

Nous avons organisé nos points de terminaison API par type d'objet : données de référence, données transactionnelles et ressources partagées.