Geschäftsbereich abrufen - ABBYY Documentation

Gibt entsprechend der angegebenen Region eine Liste von Geschäftsbereichen zurück.

HTTP-Anfrage

GET https://api-{location-id}.flexicapture.com/v2/dataset/businessunits/{region}

Ersetzen Sie {location-id} durch Ihren unterstützten Standort.

Pfadparameter

Parameter	Typ	Beschreibung
`region`	path, string	Erforderlich. Rechnungsregion. Unterstützte Regionen: US: USA, AU: Australien, EU: Länder der Europäischen Union, CA: Kanada.
`ExternalId`	query, string	Optional. Externe ID des Geschäftsbereichs.
`Skip`	query, integer	Optional. Anzahl der zu überspringenden Elemente.

Antwort

Bei Erfolg enthält der Antworttext eine Instanz von BusinessUnitsResponseModel. Wenn die Anfrage erfolgreich ist, aber keine Geschäftsbereiche mit der angegebenen Region gefunden werden, gibt der Server den HTTP-Status 204 No Content zurück.

{
  "external_id": "string",
  "name": [
    "string"
  ],
  "street": [
    "string"
  ],
  "city": [
    "string"
  ],
  "state": [
    "string"
  ],
  "zip": [
    "string"
  ],
  "country_code": "string",
  "vat": [
    "string"
  ]
}

Feld	Typ	Beschreibung
`external_id`	string	Erforderlich. Externe ID des Geschäftsbereichs.
`name[]`	string	Erforderlich. Name des Geschäftsbereichs.
`street[]`	string	Optional. Straße des Geschäftsbereichs.
`city[]`	string	Optional. Stadt des Geschäftsbereichs.
`state[]`	string	Optional. Bundesstaat des Geschäftsbereichs.
`zip[]`	string	Optional. Postleitzahl des Geschäftsbereichs.
`country_code`	string	Erforderlich. Ländercode im Format ISO 3166-1 alpha-2.
`vat[]`	string	Optional. Steuer-ID des Zahlers.