Adress-API (/addresses)
Verwenden Sie die Adress-API zum Abfragen, Erstellen oder Aktualisieren von persönlichen oder Lieferanten-Adressinformationen.
Verwenden Sie die Adress-API zum Abfragen, Erstellen oder Aktualisieren von persönlichen oder Lieferanten-Adressinformationen.
Die URL für Zugriffsadressen lautet: https://<instance>/api/addresses
- Verwenden Sie diese URL, um persönliche Adressinformationen abzufragen:
https://<instance url>/api/users/<user ID>/addresses - Verwenden Sie diese URL, um Informationen zum Lieferantenauftrag an die Adresse abzufragen:
https:/<instance url>//api/suppliers/<user ID>/addresses
Weitere Informationen finden Sie unter Integrations-Best Practices.
Aktionen
Mit der Adressen-API können Sie:
| Verb | Pfad | Aktion | Beschreibung |
|---|---|---|---|
| BEITRAG | /api/addresses |
erstellen | Adresse erstellen |
| ABFRAGEN | /api/addresses |
index | Adressen abfragen |
| ABFRAGEN | /api/addresses/:id |
anzeigen | Adresse anzeigen |
| PUT | /api/addresses/:id |
aktualisierung | Adresse aktualisieren |
Elemente
Die folgenden Elemente sind für die Adressen-API verfügbar:
| Element | Beschreibung | Pflichtfeld? | Eindeutig? | Zulässiger Wert | Api_In Field? | Api_Out-Feld? | Datentyp |
|---|---|---|---|---|---|---|---|
| aktiv | Wenn kein Wert angegeben wird, ist die Adresse inaktiv, sodass sie für Benutzer nicht mehr verfügbar ist. Ein Ja-Wert macht es aktiv und für Benutzer verfügbar. | ja | ja | boolean | |||
| achtung | Adresse Standard-Aufmerksamkeitszeile | ja | ja | string(255) | |||
| business-group-name | Inhaltsgruppenname für Adresse | ja | ja | string(255) | |||
| ort | Name des Ortes | ja | ja | ja | string(255) | ||
| content-groups | Inhaltsgruppen. | ja | ja | ContentGroup | |||
| land | land | ja | ja | ja | Land | ||
| created-at | Automatisch von Coupa erstellt im Format JJJJ-MM-TTTHH:MM:SS+HH:MMZ | ja | datum/Uhrzeit | ||||
| erstellt von | Benutzer der Erstellung | ja | Benutzer | ||||
| iD | Eindeutige Kennung von Coupa für die Adresse | ja | ganze Zahl | ||||
| lokale Steuernummer | local_tax_number | ja | ja | ja | string(255) | ||
| location-code | location_code | ja | ja | ja | string(255) | ||
| name | Adresse 'Nickname' | ja | ja | string(255) | |||
| pLZ | Postleitzahl | ja | ja | ja | string(255) | ||
| zwecke | Zwecke für Mehrfachkontakte und Adressen für Lieferanten | ja | ja | Zweck | |||
| status | Bundesland Kurzbezeichnung | Siehe Anmerkung unter dieser Tabelle, um eine Liste der zulässigen Werte herunterzuladen. | ja | ja | string(255) | ||
| state-iso-code |
ISO-Code für den Bundesstaat Hinweis
In 36.1 wurde die zulässige Syntax für Feldwerte in das Format geändert: |
Siehe Anmerkung unter dieser Tabelle, um eine Liste der zulässigen Werte herunterzuladen. | ja | ja | string(255) | ||
| street1 | Adresszeile 1 | ja | ja | ja | |||
| street2 | Adresszeile 2 | ja | ja | string(255) | |||
| street3 | Adresszeile 3 | ja | ja | string(255) | |||
| street4 | Adresszeile 4 | ja | ja | string(255) | |||
| steueranmeldungen | Steuerliche Registrierungen | ja | Steuerregistrierung | ||||
| updated-at | Automatisch von Coupa erstellt im Format JJJJ-MM-TTTHH:MM:SS+HH:MMZ | ja | datum/Uhrzeit | ||||
| aktualisiert von | Benutzer der Aktualisierung | ja | Benutzer | ||||
| vAT-Land | uSt_COUNTRY | ja | ja | Land | |||
| umsatzsteuer-Identifikationsnummer | vat_number | ja | ja | string(255) |
- Ab der Veröffentlichung im Mai 2023 haben sich die ISO-Codes und -Namen des Staates geändert. Um eine vollständige Liste der Änderungen und zulässigen Werte anzuzeigen, laden Sie die Unterteilungscode-Änderungs-Excel-Datei herunter.
- Das Referenzobjekt Land und der jeweilige Ländername, Code oder ID müssen im System bereits vorhanden sein.
- Wenn die Adresse deaktiviert oder inaktiv ist, können der Adresseintrag und seine Attribute nicht über die API aktualisiert werden.