Get business unit

Returns a list of business units according to the specified region.

HTTP request

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

Replace {location-id} with your supported location.

Path parameters

Parameter	Type	Description
`region`	path, string	Required. Invoice region. Supported regions: US: USA, AU: Australia, EU: European Union countries, CA: Canada.
`ExternalId`	query, string	Optional. External business unit ID.
`Skip`	query, integer	Optional. Skip count.

Response

If successful, the response body contains an instance of BusinessUnitsResponseModel. If the request is successful but business units with the specified region are not found, the server returns a 204 No Content HTTP status.

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

Field	Type	Description
`external_id`	string	Required. External business unit ID.
`name[]`	string	Required. Business unit name.
`street[]`	string	Optional. Business unit street.
`city[]`	string	Optional. Business unit city.
`state[]`	string	Optional. Business unit state.
`zip[]`	string	Optional. Business unit zip code.
`country_code`	string	Required. Country code in ISO 3166-1 alpha-2 format.
`vat[]`	string	Optional. Tax payer ID.

Update business unit

Remove business unit by region

⌘I

Administrator's Guide

Administration Guide

Performance Guide

Troubleshooting

Cloud

HTTP request

Path parameters

Response

​HTTP request

​Path parameters

​Response

HTTP request

Path parameters

Response