Platform | Company

Service to manage entities of type 'Company'.

Overview

api/{tenantKey}/{orgKey}/corePatterns/companies

URL	api/{tenantKey}/{orgKey}/corePatterns/companies
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:
- DELETE Company by identifier
- DELETE Company by key

All Resources

This service uses the following resources:

ApiCompanyResource
CompanyDataResource
CompanyResource
UserCompanyResource

GET Operations

GET Companies

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See CompanyResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies

GET /corePatterns/companies

GET Companies (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See CompanyResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies?page={page}&pageSize={pageSize}

GET /corePatterns/companies?page={page}&pageSize={pageSize}

GET Company by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See CompanyResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{id}

GET /corePatterns/companies/{id}

GET Company by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey

(string) The key for de company.

Response:

When successful, the response body contains the entity record. See CompanyResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}

GET /corePatterns/companies/{companyKey}

GET Print Company by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{id}/print?template={template}

GET /corePatterns/companies/{id}/print?template={template}

GET Print Company by key

Prints the specified entity record.

The following elements are required:

companyKey

(string) The key for de company.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/print

GET /corePatterns/companies/{companyKey}/print

GET Original Print CompanyOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{id}/printOriginal?template={template}

GET /corePatterns/companies/{id}/printOriginal?template={template}

GET Original Print Company by key

Prints the specified entity record.

The following elements are required:

companyKey

(string) The key for de company.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/printOriginal

GET /corePatterns/companies/{companyKey}/printOriginal

GET Company Logo.

Returns the value of attribute 'Logo' of the specified entity record.

The following elements are required:

id	(string) The record identifier.
fileName	(string) The file name.

Response:

When successful, the response is a stream with the image file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{id}/logo

GET /corePatterns/companies/{id}/logo

GET Custom operation 'GetCompaniesForUser'.

Custom operation 'GetCompaniesForUser'.

The following elements are required:

userName

(string) UserName.

Response:

When successful, the response body contains a list of resources of type 'CompanyResource'. See CompanyResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/getCompaniesForUser

GET /corePatterns/companies/getCompaniesForUser

GET Get Current User Companies

Custom operation 'GetCurrentUserCompanies'.

The following elements are required:

searchTerm

(string) SearchTerm.

Response:

When successful, the response body contains a list of resources of type 'UserCompanyResource'. See UserCompanyResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/getCurrentUserCompanies

GET /corePatterns/companies/getCurrentUserCompanies

GET Get Company By Company Tax Code Id

Custom operation 'GetCompanyByCompanyTaxCodeId'.

The following elements are required:

companyTaxId

(string) CompanyTaxId.

Response:

When successful, the response body contains a resource of type 'CompanyDataResource'. See CompanyDataResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/getCompanyByCompanyTaxCodeId/{companyTaxId}

GET /corePatterns/companies/getCompanyByCompanyTaxCodeId/{companyTaxId}

POST Operations

POST Companies

Creates a new entity record.

The following elements are required:

companyResource

(ApiCompanyResource) The request body should contain the entity record that should be created.
See ApiCompanyResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiCompanyResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies

POST /corePatterns/companies

POST Is Multiple Company

Custom operation 'IsMultipleCompany'.

Response:

When successful, the response body contains an item of type 'boolean'.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/isMultipleCompany

POST /corePatterns/companies/isMultipleCompany

POST New Company

Custom operation 'NewCompany'.

The following elements are required:

name	(string) Name.
description	(string) Description.
organizationCatalog	(string) OrganizationCatalog.

Response:

When successful, the response body contains an item of type 'boolean'.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/newCompany

POST /corePatterns/companies/newCompany

PUT Operations

PUT Set Address Company

Updates the value of attribute 'Address' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/address

PUT /corePatterns/companies/{companyKey}/address

PUT Set BaseCurrency Company

Updates the value of attribute 'BaseCurrency' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/baseCurrency

PUT /corePatterns/companies/{companyKey}/baseCurrency

PUT Set BuildingNumber Company

Updates the value of attribute 'BuildingNumber' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/buildingNumber

PUT /corePatterns/companies/{companyKey}/buildingNumber

PUT Set CityName Company

Updates the value of attribute 'CityName' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/cityName

PUT /corePatterns/companies/{companyKey}/cityName

PUT Set CompanyKey Company

Updates the value of attribute 'CompanyKey' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/companyKey

PUT /corePatterns/companies/{companyKey}/companyKey

PUT Set CompanyRegistrationData Company

Updates the value of attribute 'CompanyRegistrationData' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/companyRegistrationData

PUT /corePatterns/companies/{companyKey}/companyRegistrationData

PUT Set CompanyTaxID Company

Updates the value of attribute 'CompanyTaxID' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/companyTaxID

PUT /corePatterns/companies/{companyKey}/companyTaxID

PUT Set Country Company

Updates the value of attribute 'Country' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/country

PUT /corePatterns/companies/{companyKey}/country

PUT Set ElectronicMail Company

Updates the value of attribute 'ElectronicMail' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/electronicMail

PUT /corePatterns/companies/{companyKey}/electronicMail

PUT Set EquityCapital Company

Updates the value of attribute 'EquityCapital' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/equityCapital

PUT /corePatterns/companies/{companyKey}/equityCapital

PUT Set ForceFromOrganizationConfiguration Company

Updates the value of attribute 'ForceFromOrganizationConfiguration' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/forceFromOrganizationConfiguration

PUT /corePatterns/companies/{companyKey}/forceFromOrganizationConfiguration

PUT Set IsActive Company

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/isActive

PUT /corePatterns/companies/{companyKey}/isActive

PUT Set IsExternal Company

Updates the value of attribute 'IsExternal' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/isExternal

PUT /corePatterns/companies/{companyKey}/isExternal

PUT Set Logo Company

Updates the value of attribute 'Logo' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/logo

PUT /corePatterns/companies/{companyKey}/logo

PUT Set Mobile Company

Updates the value of attribute 'Mobile' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/mobile

PUT /corePatterns/companies/{companyKey}/mobile

PUT Set Name Company

Updates the value of attribute 'Name' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/name

PUT /corePatterns/companies/{companyKey}/name

PUT Set PostalZone Company

Updates the value of attribute 'PostalZone' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/postalZone

PUT /corePatterns/companies/{companyKey}/postalZone

PUT Set RegistrationNumber Company

Updates the value of attribute 'RegistrationNumber' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/registrationNumber

PUT /corePatterns/companies/{companyKey}/registrationNumber

PUT Set RegistrationOffice Company

Updates the value of attribute 'RegistrationOffice' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/registrationOffice

PUT /corePatterns/companies/{companyKey}/registrationOffice

PUT Set SearchTerm Company

Updates the value of attribute 'SearchTerm' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/searchTerm

PUT /corePatterns/companies/{companyKey}/searchTerm

PUT Set ShowExchangeRateReversed Company

Updates the value of attribute 'ShowExchangeRateReversed' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/showExchangeRateReversed

PUT /corePatterns/companies/{companyKey}/showExchangeRateReversed

PUT Set StreetName Company

Updates the value of attribute 'StreetName' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/streetName

PUT /corePatterns/companies/{companyKey}/streetName

PUT Set TeleFax Company

Updates the value of attribute 'TeleFax' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/teleFax

PUT /corePatterns/companies/{companyKey}/teleFax

PUT Set Telephone Company

Updates the value of attribute 'Telephone' in the specified entity record.

The following elements are required:

companyKey	(string) The key for de company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}/telephone

PUT /corePatterns/companies/{companyKey}/telephone

DELETE Operations

DELETE Company by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{id}

DELETE /corePatterns/companies/{id}

DELETE Company by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey

(string) The key for de company.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/companies/{companyKey}

DELETE /corePatterns/companies/{companyKey}

Resources

ApiCompanyResource

The following elements are required:

companyKey	(string) The key for de company.
name	(string) The company's name.
companyTaxID	(string) The company's tax identifier.
country	(string) The company's country.
baseCurrency	(string) The company's base currency.

The following elements are optional:

isExternal	(bool) Is External.
showExchangeRateReversed	(bool) Indicates wheter the exchange rate for the base currency is presented with reversed logic.
searchTerm	(string) Search Term.
telephone	(string) The company's telephone.
teleFax	(string) The company's telefax.
mobile	(string) The company's mobile.
electronicMail	(string) The company's electronic mail.
equityCapital	(string) The equity capital is defined as the amount of capital provided by the company's owner(s).
registrationOffice	(string) The company's registration office.
registrationNumber	(string) The company's registration number.
buildingNumber	(string) The company's building number.
streetName	(string) The company's street name.
cityName	(string) The company's city name.
postalZone	(string) The company's postal code.
address	(string) The company's address.
logo	(string) The company's image.
forceFromOrganizationConfiguration	(bool) Force From Configuration.
companyRegistrationData	(string) Company Registration Data.

CompanyDataResource

The following elements are required:

companyKey	(string) The key for de company.
companyTaxID	(string) The company's tax identifier.
name	(string) The company's name.

CompanyResource

The following elements are required:

companyKey	(string) The key for de company.
name	(string) The company's name.
companyTaxID	(string) The company's tax identifier.
country	(string) The company's country.
baseCurrency	(string) The company's base currency.

The following elements are optional:

isExternal	(bool) Is External.
showExchangeRateReversed	(bool) Indicates wheter the exchange rate for the base currency is presented with reversed logic.
searchTerm	(string) Search Term.
telephone	(string) The company's telephone.
teleFax	(string) The company's telefax.
mobile	(string) The company's mobile.
electronicMail	(string) The company's electronic mail.
equityCapital	(string) The equity capital is defined as the amount of capital provided by the company's owner(s).
registrationOffice	(string) The company's registration office.
registrationNumber	(string) The company's registration number.
buildingNumber	(string) The company's building number.
streetName	(string) The company's street name.
cityName	(string) The company's city name.
postalZone	(string) The company's postal code.
address	(string) The company's address.
logo	(string) The company's image.
forceFromOrganizationConfiguration	(bool) Force From Configuration.
companyRegistrationData	(string) Company Registration Data.
accessClaim	(int) Access Claim.

UserCompanyResource

The following elements are required:

companyKey	(string) The key for de company.
name	(string) The company's name.
companyTaxID	(string) The company's tax identifier.

The following elements are optional:

logo	(string) The company's image.