Obtenir une unité commerciale - ABBYY Documentation

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ètre	Type	Description
`region`	path, string	Obligatoire. Région de la facture. Régions prises en charge : US : USA, AU : Australie, EU : pays de l’Union européenne, CA : Canada.
`ExternalId`	query, string	Facultatif. ID externe de l’unité commerciale.
`Skip`	query, integer	Facultatif. 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"
  ]
}

Champ	Type	Description
`external_id`	string	Obligatoire. ID externe de l’unité commerciale.
`name[]`	string	Obligatoire. Nom de l’unité commerciale.
`street[]`	string	Facultatif. Rue de l’unité commerciale.
`city[]`	string	Facultatif. Ville de l’unité commerciale.
`state[]`	string	Facultatif. État de l’unité commerciale.
`zip[]`	string	Facultatif. Code postal de l’unité commerciale.
`country_code`	string	Obligatoire. Code du pays au format ISO 3166-1 alpha-2.
`vat[]`	string	Facultatif. ID fiscal du payeur.