API d'adresse (/addresses)
Utilisez l'API d'adresse pour rechercher, créer ou mettre à jour des informations d'adresse de paiement personnelle ou fournisseur.
Utilisez l'API d'adresse pour rechercher, créer ou mettre à jour des informations d'adresse de paiement personnelle ou fournisseur.
L'URL pour accéder aux adresses est : https://<instance>/api/addresses
- Utilisez cette URL pour rechercher des informations d'adresse personnelle :
https://<instance url>/api/users/<user ID>/addresses - Utilisez cette URL pour rechercher les informations sur l'adresse de paiement du fournisseur :
https://<instance url>/api/suppliers/<user ID>/addresses
Consultez la rubrique Bonnes pratiques d'intégration pour plus d'informations.
Actions
L'API Addresses vous permet de :
| Verbe | Chemin d'accès | Action | Description |
|---|---|---|---|
| POSTE | /api/addresses |
créer | Créer une adresse |
| EFFACER | /api/addresses/:id |
détruire | Supprimer une adresse |
| OBTENIR | /api/addresses |
index | Interroger les adresses |
| OBTENIR | /api/addresses/:id |
montrer | Afficher l'adresse |
| METTRE | /api/addresses/:id |
mettre à jour | Actualiser adresse |
Éléments
Les éléments suivants sont disponibles pour l'API Addresses :
| Élément | Description | Champ obligatoire ? | Unique ? | Valeur autorisée | Champ Api_In ? | Champ Api_Out ? | Type de données |
|---|---|---|---|---|---|---|---|
| actif | Si aucune valeur n'est spécifiée, l'adresse devient inactive et n'est plus disponible pour les utilisateurs. Une valeur oui la rendra active et disponible aux utilisateurs. | oui | oui | booléen | |||
| attention | Ligne d'attention par défaut | oui | oui | string(255) | |||
| nom-groupe-commercial | Nom du groupe de contenu pour l'adresse | oui | oui | string(255) | |||
| ville | Nom de ville | oui | oui | oui | string(255) | ||
| groupes de contenu | Groupes de contenu. | oui | oui | GroupeContenu | |||
| pays | pays | oui | oui | oui | Pays | ||
| créé à | Créé automatiquement par Coupa au format AAAA-MM-JJFHH:MM:SS+HH:MMZ | oui | datetime | ||||
| créé par | Créateur | oui | Utilisateur | ||||
| id | Identifiant unique de Coupa pour l'adresse | oui | entier | ||||
| numéro-fiscal-local | numéro_fiscal_local | oui | oui | oui | string(255) | ||
| code de localisation | code_localisation | oui | oui | oui | string(255) | ||
| Nom | Adresse « Surnom » | oui | oui | string(255) | |||
| code postal | Code postal | oui | oui | oui | string(255) | ||
| fins | Objectifs pour lescontacts multiples et les adresses pour les fournisseurs | oui | oui | Objet | |||
| déclarer | Abréviation du statut | oui | oui | string(255) | |||
| rue1 | Ligne d’adresse 1 | oui | oui | oui | string(255) | ||
| rue2 | Ligne d’adresse 2 | oui | oui | string(255) | |||
| rue3 | Ligne d’adresse 3 | oui | oui | string(255) | |||
| rue4 | Ligne d’adresse 4 | oui | oui | string(255) | |||
| immatriculations fiscales | Enregistrements fiscaux | oui | Enregistrement fiscal | ||||
| 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 de la tva | pays_tva | oui | oui | Pays | |||
| numéro de TVA | numéro_tva | oui | oui | string(255) |
Remarque
- 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 d'adresse et ses attributs ne peuvent pas être mis à jour à l'aide de l'API.
Une partie ou la totalité de cette page peut avoir été traduite par machine. Toutes nos excuses pour les inexactitudes.