Settings | Company Setting
Service to manage entities of type 'CompanySetting'.
This service extends Companies.
Overview
| URL | api/{tenantKey}/{orgKey}/settings/companySettings |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
GET CompanySettings (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 CompanySettingResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET CompanySetting 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 CompanySettingResource. |
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 CompanySetting 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 CompanySettingResource. |
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 CompanySettings (with Company)
Returns the list of all the entity records available. Each record contains both data from the entity and the base entity.
Response:
| When successful, the response body contains the list of records available. See BaseCompanySettingResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET CompanySettings (with Company) (paged)
Returns a page of the list of all the entity records available. Each record contains both data from the entity and the base entity.
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 BaseCompanySettingResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET CompanySetting (with Company) by identifier
Returns the entity record that matches the specified identifier. The record contains both data from the entity and the base entity.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See BaseCompanySettingResource. |
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 CompanySetting (with Company) by key
Returns the entity record that matches the specified key. The record contains both data from the entity and the base entity.
The following elements are required:
| companyKey | (string) The key for de company. |
Response:
| When successful, the response body contains the entity record. See BaseCompanySettingResource. |
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 Time Zones
Custom operation 'GetTimeZones'.
Response:
| When successful, the response body contains a list of resources of type 'TimeZoneResource'. See TimeZoneResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST CompanySettings
Creates a new entity record.
The following elements are required:
| companySettingResource | (ApiCompanySettingResource) The request body should contain the entity record that should be created. See ApiCompanySettingResource. |
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 ApiCompanySettingResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST CompanySettings (with ApiBaseCompanySetting)
Creates a new entity record. The record shoud contain both data from the entity and the base entity.
The following elements are required:
| companySettingResource | (ApiCompanySettingResource) The request body should contain the entity record that should be created. See ApiCompanySettingResource. |
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 ApiBaseCompanySettingResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Currency CompanySetting
Updates the value of attribute 'Currency' 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 EnableCustomAttributes CompanySetting
Updates the value of attribute 'EnableCustomAttributes' 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 ExchangeRate CompanySetting
Updates the value of attribute 'ExchangeRate' in the specified entity record.
The following elements are required:
| companyKey | (string) The key for de company. |
| value | (decimal) 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 ExchangeRateDate CompanySetting
Updates the value of attribute 'ExchangeRateDate' in the specified entity record.
The following elements are required:
| companyKey | (string) The key for de company. |
| value | (DateTime) 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 CompanySetting
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 TimeZoneDescription CompanySetting
Updates the value of attribute 'TimeZoneDescription' 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 TimeZoneId CompanySetting
Updates the value of attribute 'TimeZoneId' 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 CompanySetting 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 CompanySetting 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
ApiBaseCompanySettingResource
The following elements are required:
| exchangeRate | (decimal) Exchange Rate. |
| 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:
| timeZoneId | (string) Time Zone Id. |
| timeZoneDescription | (string) Time Zone Description. |
| exchangeRateDate | (DateTime) Exchange Rate Date. |
| enableCustomAttributes | (bool) Enable Custom Attributes. |
| currency | (string) Organization Currency. |
| 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. |
ApiCompanySettingResource
The following elements are required:
| exchangeRate | (decimal) Exchange Rate. |
| companyKey | (string) The key for de company. |
The following elements are optional:
| timeZoneId | (string) Time Zone Id. |
| timeZoneDescription | (string) Time Zone Description. |
| exchangeRateDate | (DateTime) Exchange Rate Date. |
| enableCustomAttributes | (bool) Enable Custom Attributes. |
| currency | (string) Organization Currency. |
BaseCompanySettingResource
The following elements are required:
| exchangeRate | (decimal) Exchange Rate. |
| 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:
| timeZoneId | (string) Time Zone Id. |
| timeZoneDescription | (string) Time Zone Description. |
| exchangeRateDate | (DateTime) Exchange Rate Date. |
| enableCustomAttributes | (bool) Enable Custom Attributes. |
| currency | (string) Organization Currency. |
| 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. |
CompanySettingResource
The following elements are required:
| exchangeRate | (decimal) Exchange Rate. |
| companyKey | (string) The key for de company. |
The following elements are optional:
| timeZoneId | (string) Time Zone Id. |
| timeZoneDescription | (string) Time Zone Description. |
| exchangeRateDate | (DateTime) Exchange Rate Date. |
| enableCustomAttributes | (bool) Enable Custom Attributes. |
| currency | (string) Organization Currency.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
TimeZoneResource
The following elements are optional:
| timeZoneId | (string) Time Zone Id. |
| timeZoneDescription | (string) Time Zone Description. |