Passer au contenu principal
Renvoie une liste d’unités commerciales pour la région spécifiée.

​
Requête HTTP

GET https://api-{location-id}.flexicapture.com/v2/dataset/businessunits/{region}
Remplacez {location-id} par votre emplacement pris en charge.

​
Paramètres de chemin

ParamètreTypeDescription
regionpath, stringObligatoire. Région de la facture. Régions prises en charge : US : USA, AU : Australie, EU : pays de l’Union européenne, CA : Canada.
ExternalIdquery, stringFacultatif. ID externe de l’unité commerciale.
Skipquery, integerFacultatif. Nombre d’éléments à ignorer.

​
Réponse

En cas de succès, le corps de la réponse contient une instance de BusinessUnitsResponseModel. Si la requête réussit, mais qu’aucune unité commerciale correspondant à la région spécifiée n’est trouvée, le serveur renvoie le code d’état HTTP 204 No Content. 
{
  "external_id": "string",
  "name": [
    "string"
  ],
  "street": [
    "string"
  ],
  "city": [
    "string"
  ],
  "state": [
    "string"
  ],
  "zip": [
    "string"
  ],
  "country_code": "string",
  "vat": [
    "string"
  ]
}
ChampTypeDescription
external_idstringObligatoire. ID externe de l’unité commerciale.
name[]stringObligatoire. Nom de l’unité commerciale.
street[]stringFacultatif. Rue de l’unité commerciale.
city[]stringFacultatif. Ville de l’unité commerciale.
state[]stringFacultatif. État de l’unité commerciale.
zip[]stringFacultatif. Code postal de l’unité commerciale.
country_codestringObligatoire. Code du pays au format ISO 3166-1 alpha-2.
vat[]stringFacultatif. ID fiscal du payeur.