Platform | Company
Service to manage entities of type 'Company'.
Overview
URL | api/{tenantKey}/{orgKey}/corePatterns/companies |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set IsActive Company
- PUT Set CompanyKey Company
- PUT Set IsExternal Company
- PUT Set ShowExchangeRateReversed Company
- PUT Set Name Company
- PUT Set SearchTerm Company
- PUT Set CompanyTaxID Company
- PUT Set Telephone Company
- PUT Set TeleFax Company
- PUT Set Mobile Company
- PUT Set ElectronicMail Company
- PUT Set EquityCapital Company
- PUT Set RegistrationOffice Company
- PUT Set RegistrationNumber Company
- PUT Set BuildingNumber Company
- PUT Set StreetName Company
- PUT Set CityName Company
- PUT Set PostalZone Company
- PUT Set Country Company
- PUT Set BaseCurrency Company
- PUT Set Address Company
- PUT Set Logo Company
- PUT Set ForceFromOrganizationConfiguration Company
- PUT Set CompanyRegistrationData Company
- DELETE:
All Resources
This service uses the following resources:
GET Companies (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
opts | (ODataQueryOptions) OData query option. |
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:
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:
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:
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:
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:
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:
GET Get User Companies
Custom operation 'GetUserCompanies'.
The following elements are required:
userId | (Guid) The user unique identifier. |
Response:
When successful, the response body contains a list of resources of type 'CompanyDataResource'. See CompanyDataResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
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:
POST Is Multiple Company
Custom operation 'IsMultipleCompany'.
Response:
When successful, the response body contains an item of type 'boolean'. |
Resource URL:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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. |