API des factures (/factures)
Utilisez l'API des factures pour créer, mettre à jour ou interroger des factures associées à un bon de commande.
Aperçu
L'URL pour accéder aux factures est :
https://{your_instance_name}/api/invoices
Depuis la version 29, Coupa a amélioré l’API de facturation pour qu’elle soit entièrement fonctionnelle, à parité avec les autres canaux d’acheteurs de factures. Pour plus d'informations sur cette mise à jour, consultez API de facturation étendue pour la création de factures ,
Voir Bonnes pratiques d’intégration pour en savoir plus.
Objets API de facture
Il s'agit de la liste complète des objets de facture disponibles via l'interface utilisateur. Cependant, tous les objets listés ici n'ont pas de points de terminaison. Certains sont uniquement référencés par des objets et ne peuvent pas être mis à jour directement.
wiki.tree();
Actions
L'API Factures vous permet de :
Verbe | Chemin d'accès | Action | Description |
---|---|---|---|
METTRE |
/api/invoices/:id/abandon
|
abandonner | Abandonner la facture |
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 côté client d'approuver et de payer une facture le plus rapidement possible. |
METTRE |
/api/invoices/:id/bypass_current_approval
|
Contourner l'approbation actuelle |
Contourner l'approbation actuelle Permet à un système tiers côté client d'obtenir l'approbation d'une facture auprès de l'approbateur actuel afin de la régler le plus rapidement possible. |
METTRE |
/api/invoices/:id/dispute
|
Contester |
Contester la facture Autorise le passage d'une facture au statut Contesté via un appel système. Le déplacement d'une facture vers la page Contesté signale au fournisseur qu'un problème est survenu 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-QUANTITY</ 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 préavis d'expédition |
Convertir la facture en avis d'expédition avancée
|
OBTENIR |
/api/invoices/:id/retrieve_image_scan
|
Récupérer scan image | Récupérer/télécharger le scan image |
METTRE |
/api/invoices/:id/image_scan
|
Scan image | Actualiser la pièce jointe ou l'URL de numérisation |
OBTENIR |
/api/invoices
|
Index | Demander des 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 côté client d'effacer la chaîne d'approbation actuelle et de régénérer une nouvelle chaîne d'approbation pour une facture ayant subi des modifications.
|
OBTENIR |
/api/invoices/:id/retrieve_clearance_document
|
récupérer_document_autorisation | Récupérer/télécharger le document d'autorisation |
OBTENIR |
/api/invoices/:id/retrieve_legal_invoice_pdf
|
récupérer_facture_légale_pdf | Télécharger/récupérer la facture légale PDF. Cette action permet d'exporter la pièce jointe PDF par appel API. |
METTRE |
/api/invoices/:id/revalidate_tolerances
|
Revalider les tolérances |
Revalider les tolérances Permet à un système tiers côté client de soumettre à nouveau une facture présentant des problèmes. |
OBTENIR |
/api/invoices/:id
|
Afficher | Afficher la facture |
METTRE |
/api/invoices/:id/submit
|
Valider | Soumettre le projet de facture pour approbation |
PATCH |
/api/invoices/:id
|
Mettre à jour |
Actualiser la facture |
METTRE |
/api/invoices/:id
|
Mettre à jour |
Actualiser la facture Utilisé pour mettre à jour les informations sur la facture à l'aide de l'API |
METTRE |
/api/invoices/:id/update_line_accounts
|
Actualiser les comptes de ligne |
Actualiser 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 Cette option ne peut être utilisée que sur les factures approuvées et en attente de réception.
|
METTRE |
/api/invoices/:id/withdraw_dispute
|
Retirer le litige |
Retirer le litige En raison de l'inaction du fournisseur ou d'une erreur de la part de l'acheteur, une facture contestée peut être renvoyée au processus d'approbation. |
Éléments
Élément | Description | Demande d'achat | Unique | Valeur autorisée | Dans | Sortie | Type de données |
---|---|---|---|---|---|---|---|
abandon-raison | Abandonner le motif | no | no | tout | oui | Reason Insight | |
account-type | Référence du plan comptable | oui | oui | oui | Type de compte | ||
montant-reçu-du-paiement-anticipé | Montant de l’avance reçue | oui | oui | décimal(30,4) | |||
montant-dû-moins-remise | Montant dû après application de la remise | tout | oui | décimal | |||
approbations | Approbations | oui | Approbation | ||||
pièces jointes | oui | Pièce jointe | |||||
id_entité_archive | ID entité d'archivage | oui | entier | ||||
adresse de facturation | Adresse de facturation | oui | oui | oui | Adresse | ||
enregistrement fiscal de l'acheteur | Enregistrement fiscal acheteur | oui* | oui | Enregistrement fiscal | |||
annulé | Indique si la transaction a été annulée | oui | booléen | ||||
référence au régime de la comptabilité de caisse | Remarque si vous utilisez un schéma de comptabilité de caisse | oui | oui | string(255) | |||
document de dédouanement | Nom du fichier joint du document de dédouanement. Accessible via /recover_clearance_document | oui | chaîne | ||||
commentaires | commentaires | oui | oui | string(255) | |||
conforme | Indicateur de conformité des factures | oui | booléen | ||||
confirmation | Confirmation | oui | string(50) | ||||
contrat | Numéro de contrat justificatif | oui | oui | Contrat | |||
coupa-acceleration-status | Statut indiquant si la facture est assortie de conditions de paiement avec remise via la remise statique. | accéléré | oui | string(40) | |||
créé à | Créé automatiquement par Coupa au format AAAA-MM-JJFHH:MM:SS+HH:MMZ | oui | datetime | ||||
créé par | Créateur | oui | Utilisateur | ||||
différences-notes-de-crédit-avec-la-facture-originale | Différences de note de crédit avec la facture originale | oui | oui | décimal(30,4) | |||
motif de crédit | Raison de la création du crédit | oui | oui | string(255) | |||
devise | Code de devise | oui | oui | Devise | |||
dossiers-historiques-d-integration-actuels | Enregistrements historiques d'intégration actuels | oui | Historique d'intégration | ||||
remise-hors-taxe-comptable-client | Taxe comptable du client après application de la remise | tout | oui | décimal | |||
date de déclaration en douane | Date de déclaration douanière | oui | oui | datetime | |||
numéro de déclaration douanière | Numéro de déclaration douanière | oui | oui | string(60) | |||
bureau de douane | Bureau des douanes | oui | oui | texte | |||
date de réception | Date de réception au format AAAA-MM-JJTHH:MM:SS+HH:MMZ | oui | datetime | ||||
date de livraison | Date d’approvisionnement | no | no | tout | oui | datetime | |
pays de destination | Pays de destination utilisé pour la conformité | oui | Pays | ||||
montant de remise | Montant de remise fourni par le fournisseur | oui | oui | décimal(32,4) | |||
date d'échéance de la remise | Échéance de la remise calculée en fonction des conditions de paiement de la remise | oui | datetime | ||||
pourcentage de remise | Remise en % | oui | oui | flotter | |||
méthode fondée sur la contestation | Méthode de contestation | no | no | tout | oui | string(10) | |
contestation | Motifs de contestation | no | no | tout | oui | Motif de la contestation | |
type de document | Facture ou note de crédit | Facture, note de crédit | oui | string(255) | |||
dispositions relatives au paiement anticipé | Incitations au paiement anticipé | oui | oui | string(255) | |||
taux de change | Taux de change | oui | oui | décimal(30,9) | |||
exporté | Indique si une transaction a été exportée | oui | booléen | ||||
tolérances de défaillance | Tolérances échouées | oui | oui | Facture::FailedTolerance | |||
numéro de folio | Numéro de folio | oui | string(20) | ||||
mode de paiement | Formulaire de paiement | oui | string(10) | ||||
total brut | Montant brut total | oui | décimal | ||||
total-brut-moins-remise | Total de la facture après application de la remise | tout | oui | décimal | |||
quantité manipulée | Montant de traitement | oui | oui | décimal(32,4) | |||
id | Identifiant Coupa unique | oui | entier | ||||
balayage d'images | Nom du fichier joint Invoice Image Scan | oui | string(25) | ||||
type de contenu du balayage de l'image | Type de contenu du scan d'image | oui | string(191) | ||||
nom-fichier-image-scan | Nom de fichier du scan d'image | oui | string(255) | ||||
taille-fichier-scan-image | Taille du fichier de numérisation d'image en Mo | oui | string(12) | ||||
url-scan-image | URL de numérisation des images de facture. Doit commencer par 'http://' ou 'https://'. | oui | string(255) | ||||
facture entrante | Référence de facture entrante | oui | Facture entrante | ||||
nom de boîte de réception | Nom de la boîte de réception | oui | chaîne | ||||
note interne | Note interne | oui | oui | texte | |||
frais de facturation | Frais de facture | oui | oui | Frais de facture | |||
date de facturation | Date de la facture | oui | oui | oui | datetime | ||
adresse d'envoi de la facture | Adresse de facturation | oui* | oui | Coordonnées de paiement du fournisseur | |||
lignes de facture | Identifiant du dossier | oui | oui | Ligne de facture | |||
invoice-number | Numéro de facture | oui | oui | oui | string(40) | ||
reçus-paiement-facture | Informations sur les reçus de paiement liés aux factures | oui | Reçu de paiement de facture | ||||
numéro-de-référence-de-facture | Numéro de référence de facturation (NRF) | oui | oui | ||||
lieu d’émission | Lieu d’émission | oui | string(50) | ||||
dernière exportation à | Date et heure de la dernière exportation de la transaction au format AAAA-MM-JJFHH:MM:SS+HH:MMZ | oui | datetime | ||||
pénalités de retard | Pénalités de retard | oui | oui | string(255) | |||
pays de destination légale | Pays de destination légal utilisé pour la conformité | Voir la Liste des pays conformes , | oui | Pays | |||
taxation au niveau de la ligne | Indicateur indiquant si les taxes sont fournies au niveau de la ligne dans cette facture | oui | oui | oui | booléen | ||
clé de version de verrouillage | Verrouiller la version | oui | entier | ||||
régime de la marge bénéficiaire | Raison d'utiliser le modèle de marge | oui | oui | string(255) | |||
montant divers | Montant divers | oui | oui | décimal(32,4) | |||
net-due-date | Échéance nette calculée en fonction des conditions de paiement nettes | oui | datetime | ||||
total net-moins-remise | Total net après application de la remise | tout | oui | décimal | |||
pays d'origine | Pays d'origine utilisé pour la conformité | oui | Pays | ||||
devise-origine-brute | Devise locale brute | oui* | oui | décimal(32,4) | |||
devise d'origine nette | Devise locale nette | oui* | oui | décimal(32,4) | |||
date de la facture d'origine |
Date de facture initiale requise lorsque
is-credit-note=true
|
oui** | oui | datetime | |||
numéro-de-facture-originale |
Date de facture initiale requise lorsque
is-credit-note=true
|
oui** | oui | string(40) | |||
payé | Payé | oui | oui | booléen | |||
paiement des factures | Payer la facture | oui | |||||
payment-channel | Traitement du paiement des factures - ERP (par défaut), Coupa Pay Virtual Card, Coupa Pay Invoice Payment | no | no | 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) | ||||
bordereau 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 des conditions de paiement sur la facture | oui | oui | Modalités de paiement | |||
paiements | Paiements | oui | oui | Paiement | |||
date de paiement anticipé | Date de prépaiement | oui | oui | datetime | |||
lignes de rapprochement | Lignes de rapprochement | oui | Ligne de facture/rapprochement | ||||
adresse de paiement | Adresse de paiement | oui | oui | oui | Adresse de paiement | ||
demandé par | Demandeur sur la facture | oui | Utilisateur | ||||
indication d'autoliquidation | Autoliquidation | oui | oui | string(255) | |||
code-qr-signé | Code QR signé | oui | texte | ||||
référence d'auto-facturation | Référence d'auto-facturation sur la facture | oui | oui | string(191) | |||
adresse électronique de l'expéditeur | Adresse e-mail de l’émetteur | oui | string(255) | ||||
séries | Séries | oui | string(30) | ||||
adresse d'expédition | Adresse d’expédition | oui | oui | Coordonnées de paiement du fournisseur | |||
adresse de livraison | Adresse de livraison | oui | oui | Adresse | |||
montant d'expédition | Montant de l’expédition | oui | oui | décimal(32,4) | |||
condition d'expédition | Code des conditions d'expédition sur la facture | oui | Condition d'expédition | ||||
afficher-informations-fiscales | Afficher les informations fiscales dans la facture | oui | booléen | ||||
statut | Statut de la facture | oui | string(50) | ||||
Fournisseur | Nom ou numéro du fournisseur | oui | oui | Fournisseur | |||
créé par le fournisseur | Indicateur de facture créé par le fournisseur | oui | booléen | ||||
note du fournisseur | Note fournie par le fournisseur | oui | oui | texte | |||
adresse de paiement du fournisseur | Adresse de paiement fournie par le fournisseur | oui | oui | oui | Coordonnées de paiement du fournisseur | ||
immatriculation fiscale du fournisseur | Enregistrement fiscal du fournisseur | oui* | oui | Enregistrement fiscal | |||
total-fournisseur | Total du fournisseur | oui | décimal | ||||
marquage | Etiquetages | oui | oui | Marquage | |||
étiquettes | Étiquette (Obsolète, veuillez utiliser l'association Étiquettes pour ajouter des étiquettes à InvoiceHeader) | oui | oui | Code actif | |||
montant fiscal | Montant de la taxe (non utilisé si la taxe est fournie au niveau de la ligne) | oui | oui | décimal | |||
moteur du montant de l'impôt | Montant fiscal calculé par Coupa Native ou par un moteur fiscal externe en fonction de la configuration | oui | décimal | ||||
code fiscal | Code fiscal (non utilisé si la taxe est fournie au niveau de la ligne) | oui | oui | string(255) | |||
machine à code fiscal | Code fiscal renvoyé par le moteur fiscal externe en fonction de la configuration | oui | |||||
impôt dû au fournisseur | Taxe due au fournisseur | oui | décimal(32,4) | ||||
lignes d'imposition | Code de taxe de la ligne (non utilisé si la taxe est fournie au niveau de l'en-tête) | oui | oui | Ligne fiscale | |||
tax-rate | Taux d'imposition (non utilisé si l'impôt est fourni au niveau de la ligne) | oui | oui | flotter | |||
moteur du taux d'imposition | Taux d'imposition renvoyé par le moteur fiscal externe en fonction de la configuration | oui | |||||
taxe-en-devise-pays-d-origine | Taxe associée à la devise locale | oui* | oui | décimal(32,4) | |||
tolérance-défaillances | Échec de tolérance | oui | string(512) | ||||
total avec taxes | Total avec taxes | oui | décimal | ||||
total-taxes-moins-remise | Total des taxes après application de la remise | tout | oui | décimal | |||
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 la facture | Utilisation de la facture | oui | string(10) | ||||
lignes de retenue à la source | Lignes de retenue à la source | oui | oui | Ligne de retenue à la source | |||
ignorer la retenue à la source | Remplacement de la retenue fiscale | oui | décimal(30,3) | ||||
numéro-de-référence-de-facture | Numéro de référence de facturation (NRF) | oui | oui | string(255) | |||
nom-émetteur-facture-fournisseur | Nom de l'émetteur de la facture fournisseur | oui | oui | string(255) | |||
nom-réviseur-facture-fournisseur | Nom du vérificateur de la facture fournisseur | oui | oui | string(255) | |||
nom-collecteur-paiement-fournisseur | Nom de l'agent de recouvrement des paiements fournisseur | oui | oui | string(255) | |||
endossement des factures | Endossement sur les factures | oui | string(10) | ||||
moyen de transport neuf | Nouveaux moyens de transport | oui | string(10) | ||||
lieu d'émission | Lieu d'émission | oui | string(100) | ||||
montant de l'avance | Montant du paiement anticipé | oui | oui | décimal(46,20) | |||
uuid-transaction | UUID de la transaction | oui | string(50) | ||||
date-de-notification-de-transaction | Date de notification de la transaction | oui | datetime | ||||
validation du contenu | Indicateur de validation du contenu des factures | oui | booléen | ||||
numéro-de-référence-de-facture | Numéro de référence de facturation (NRF) | oui | oui | ||||
nom-émetteur-facture-fournisseur | Nom de l'émetteur de la facture fournisseur | oui | oui | string(255) | |||
nom-réviseur-facture-fournisseur | Nom du vérificateur de la facture fournisseur | oui | oui | string(255) | |||
nom-collecteur-paiement-fournisseur | Nom de l'agent de recouvrement des paiements fournisseur | oui | oui | string(255) | |||
est une note de crédit | Type de document - Note de crédit | oui | booléen | ||||
requester-email | Courrier électronique du demandeur | oui | chaîne | ||||
nom-demandeur | Nom complet du demandeur | oui | chaîne | ||||
nom-de-recherche-du-demandeur | 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-approvisionnement-originale | Valeur d’approvisionnement initiale | oui | décimal(46,20) | ||||
valeur-correcte-de-l-offre | Valeur correcte d'approvisionnement | oui | décimal(46,20) | ||||
date de la facture d'origine | Date de facture d'origine utilisée en cas de note de crédit | oui | oui | datetime | |||
type de relation | Type de relation | oui | string(10) | ||||
numéro-de-facture-originale | Numéro de facture d'origine utilisé en cas de note de crédit | oui | oui | string(40) | |||
lieu de fourniture | Lieu d’approvisionnement | oui | string(255) | ||||
mécanisme de paiement fractionné | Fractionner le mécanisme de paiement | oui | booléen | ||||
endossement des factures | Endossement sur les factures | oui | string(10) | ||||
moyen de transport neuf | Nouveaux moyens de transport | oui | string(10) | ||||
lieu d'émission | Lieu d'émission | oui | string(100) | ||||
code-qr-signé | Code QR signé | oui | texte | ||||
condition d'expédition | Code des conditions d'expédition sur la facture | oui | |||||
immatriculation fiscale du fournisseur | oui | oui | |||||
enregistrement fiscal de l'acheteur | oui | oui | |||||
numéro_ordre_paiement | Numéro d'ordre de paiement |
oui |
chaîne | ||||
heure d'émission de la facture | Heure d'émission de la facture | oui | string(255) | ||||
opérateur de la caisse enregistreuse | Opérateur de caisse | oui | string(255) | ||||
moyen de paiement | Moyen de paiement | oui | string(255) | ||||
code-d-identification-unique-du-reçu-de-caisse | Code d'identification unique de la recette de caisse | oui | string(255) | ||||
code de la valeur mobilière de l'émetteur | Code de sécurité de l'émetteur | oui | string(255) | ||||
numéro fiscal de l'État | Numéro d'identification fiscale de l'État | oui | string(255) | ||||
numéro-fiscal-de-l-etat-pour-contribuable-de-substitution | Numéro d'identification fiscale de l'État pour le contribuable de substitution | oui | string(255) | ||||
numéro d'impôt municipal | Numéro d'identification fiscale de la municipalité | oui | string(255) | ||||
code-de-la-facture-fiscale-sériel | Code de série de la facture fiscale | oui | string(255) | ||||
code de vérification | Code de vérification | oui | string(255) | ||||
type de document | Type de document | oui | string(255) | ||||
numéro_protocole | Numéro de protocole | oui | string(255) | ||||
nature de l'opération | Nature de l'opération | oui | string(255) | ||||
type d'opération | Type d'opération | oui | string(255) | ||||
type de fret | Type de fret | oui | string(255) | ||||
plaque d'immatriculation | Plaque d'immatriculation du véhicule | oui | string(255) | ||||
inscription du transporteur national | Inscription nationale du convoyeur | oui | string(255) | ||||
montant-volume | 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) | ||||
marque-volume | Marque du volume | oui | string(255) | ||||
type de volume | Type de volume | oui | string(255) | ||||
numérotage des volumes | Numérotation du volume | oui | string(255) | ||||
notes-de-contrat-de-paiement | Notes d’accord de paiement | Paiement intégral via un accord de paiement anticipé, Paiement partiel via un accord de paiement anticipé, Déjà payé pour un accord récurrent, Retenir le paiement par accord | oui | string(255) | |||
tcs-lignes-taxe | oui | - | |||||
adresse d'envoi de la facture | oui | oui | Adresse | ||||
adresse d'expédition | oui | oui | Adresse |
Les champs obligatoires signalés par un astérisque * sont des champs obligatoires supplémentaires pour les factures conformes. Les champs obligatoires signalés par deux astérisques ** ne sont obligatoires que lorsque
is-credit-note=true
,
Liste des pays conformes
Cette liste indique les pays autorisés pour la facturation conforme. Il ne s'agit pas d'une liste de pays conformes actuellement pris en charge par Coupa.
#id | Code | Nom |
---|---|---|
14 | AU | Australie |
15 | AT | Autriche |
22 | BE | Belgique |
31 | BR | Brésil |
34 | BG | Bulgarie |
39 | AC | 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 | EST | Islande |
103 | IE | Irlande |
104 | IL | Israël |
105 | IT | Italie |
108 | JP | Japon |
118 | LV | 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 |
Une partie ou la totalité de cette page peut avoir été traduite par machine. Toutes nos excuses pour les inexactitudes.