HomeGuidesREST APISOAP APIChangelogAEB Trade Compliance WebsiteLegal Notice
REST API

/companies/{id}

put
https://rz3.aeb.de/test4ce/rest/companies/

Create or update a company with the specified ID (company number). If the company with the given ID does not exist, a new company is created. If the company exist, the existing company is fully updated. Not filled fields in the request are treated thereby as empty data fields and lead to empty fields in an already existing company. It is therefore recommended to use the GET/companies to check whether a company with a specific ID exists or not BEFORE you use PUT/companies/{id}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The requested ID (company number).

Body Params

A complete address of a company.

string
required
length between 1 and 40

Name of the company (first address line).

string
length between 0 and 40

Address name line 2.

string
length between 0 and 40

Address name line 3.

string
length between 0 and 40

Address name line 4.

string
length between 0 and 40

Street (line 1) of the address.

string
length between 0 and 40

Street (line 2) of the address.

string
length between 0 and 10

Postcode of the street address.

string
length between 0 and 40

City of the address.

string
length between 0 and 40

District (city line 2) of the address.

string
required
length between 2 and 2
[A-Z]{2}

Country of address. Unique alpha-2 ISO code of country according to ISO 3166.

string
length between 0 and 40

County of the address.

string
length between 0 and 10

PO-Box.

string
length between 0 and 10

Postcode of the poBox address.

string
length between 0 and 40

City of the po-box address.

string
length between 0 and 256

Email address of the address.

string
length between 0 and 20

Phone number of reception.

string
length between 0 and 20

Fax number of reception.

string
length between 0 and 20

International VAT identification number. Example of format: DE123456789

boolean

If false, the company is logically deleted. Disabled companies will not be linked to new transactional data. It is possible to enable a disabled company by overwriting the value with 'true' or leave it empty.

string
length between 0 and 250

Homepage of the company.

string
length between 0 and 4000

Remarks about the company.

roles
array of objects

Roles of the company. The possible roles depends on the AEB service. Use API method GET /company-roles to retrieve all possible company roles.

roles
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 3 months ago