Adresse API (/adresses)
Utilisez l'API d'adresse pour interroger, créer ou mettre à jour des informations personnelles ou de paiement du fournisseur.
Utilisez l'API d'adresse pour interroger, créer ou mettre à jour des informations personnelles ou de paiement du fournisseur.
L'URL pour accéder aux adresses est : https ://<instance>/api/addresses
- Utilisez cette URL pour demander des informations d'adresse personnelle :
https :/<instance url>//api/users/<user ID>/addresses - Utilisez cette URL pour interroger les informations de l'adresse de remise du fournisseur
: https :/<instance url>//api/suppliers/<user ID>/addresses
Voir les meilleures pratiques d'intégration pour plus d'informations.
Actions
L'API Adresses vous permet de :
| Verbe | Chemin d'accès | Action | Description |
|---|---|---|---|
| PUBLIER | /api/adresses |
créer | Créer une adresse |
| OBTENIR | /API/Adresses |
index | Demander les adresses |
| OBTENIR | /api/adresses/:id |
afficher | Afficher l'adresse |
| METTRE | /api/adresses/:id |
mettre à jour | Actualiser adresse |
Éléments
Les éléments suivants sont disponibles pour l'API Adresses :
| Élément | Description | Champ obligatoire ? | Unique ? | Valeur autorisée | Api_In Field ? | Api_Out Field ? | Type de données |
|---|---|---|---|---|---|---|---|
| actif | Une valeur nulle rendra l'adresse inactive et ne sera plus disponible pour les utilisateurs. Une valeur oui la rendra active et disponible pour les utilisateurs. | oui | oui | boolean | |||
| attention | Ligne d'attention par défaut de l'adresse | oui | oui | string(255) | |||
| nom-groupe-entreprise | Nom du groupe de contenu pour l'adresse | oui | oui | string(255) | |||
| ville | Nom de la ville | oui | oui | oui | string(255) | ||
| content-groups | Groupes de contenu. | oui | oui | ContentGroup | |||
| pays | pays | oui | oui | oui | Pays | ||
| 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 | ||||
| iD | Identifiant unique de Coupa pour l'adresse | oui | nombre entier | ||||
| numéro-impôt-local | local_tax_number | oui | oui | oui | string(255) | ||
| code-lieu | location_code | oui | oui | oui | string(255) | ||
| nom | Adresse 'Surnom' | oui | oui | string(255) | |||
| code postal | Code postal | oui | oui | oui | string(255) | ||
| objectifs | Objectifs des contacts et adresses multiples pour les fournisseurs | oui | oui | Objectif | |||
| état | Sigle de l'État | Voir la note ci-dessous ce tableau pour télécharger une liste des valeurs admissibles. | oui | oui | string(255) | ||
| state-iso-code |
Code ISO du pays Remarque
En 36.1, la syntaxe autorisée pour les valeurs de champ a été remplacée par le format suivant : |
Voir la note ci-dessous ce tableau pour télécharger une liste des valeurs admissibles. | oui | oui | string(255) | ||
| street1 | Ligne d'adresse 1 | oui | oui | oui | |||
| street2 | Ligne d'adresse 2 | oui | oui | string(255) | |||
| street3 | Ligne d'adresse 3 | oui | oui | string(255) | |||
| street4 | Ligne d'adresse 4 | oui | oui | string(255) | |||
| immatriculations fiscales | Inscriptions fiscales | oui | Inscription aux taxes | ||||
| 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 | ||||
| pays-cuve | vat_country | oui | oui | Pays | |||
| numéro de cuve | numéro_TVA | oui | oui | string(255) |
- À partir de la version de mai 2023, les codes ISO et les noms des États ont changé. Pour voir une liste complète des modifications et des valeurs autorisées, téléchargez le fichier Excel Subdivision Code Changes.
- Le pays de l'objet de référence et le nom, le code ou l'ID du pays respectif doivent déjà exister dans le système.
- Si l'adresse est désactivée ou inactive, l'enregistrement de l'adresse et ses attributs ne peuvent pas être mis à jour à l'aide de l'API.