Platform | Organization Configuration

Service to manage entities of type 'OrganizationConfiguration'.

Overview

api/{tenantKey}/{orgKey}/corePatterns/organizationConfigurations

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

All Operations

This service includes the following operations:

GET:
POST:
- POST OrganizationConfigurations
PUT:
DELETE:
- DELETE OrganizationConfiguration by identifier
- DELETE OrganizationConfiguration by key

All Resources

This service uses the following resources:

ApiOrganizationConfigurationResource
OrganizationConfigurationResource

GET Operations

GET OrganizationConfigurations

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/organizationConfigurations

GET /corePatterns/organizationConfigurations

GET OrganizationConfigurations (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 OrganizationConfigurationResource.

Response status codes:

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

Resource URL:

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

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

GET OrganizationConfiguration 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 OrganizationConfigurationResource.

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/organizationConfigurations/{id}

GET /corePatterns/organizationConfigurations/{id}

GET OrganizationConfiguration by key

Returns the entity record that matches the specified key.

The following elements are required:

organizationKey

(string) Organization.

Response:

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

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/organizationConfigurations/{organizationKey}

GET /corePatterns/organizationConfigurations/{organizationKey}

GET Print OrganizationConfiguration 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/organizationConfigurations/{id}/print?template={template}

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

GET Print OrganizationConfiguration by key

Prints the specified entity record.

The following elements are required:

organizationKey

(string) Organization.

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/organizationConfigurations/{organizationKey}/print

GET /corePatterns/organizationConfigurations/{organizationKey}/print

GET Original Print OrganizationConfigurationOriginal 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/organizationConfigurations/{id}/printOriginal?template={template}

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

GET Original Print OrganizationConfiguration by key

Prints the specified entity record.

The following elements are required:

organizationKey

(string) Organization.

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/organizationConfigurations/{organizationKey}/printOriginal

GET /corePatterns/organizationConfigurations/{organizationKey}/printOriginal

POST Operations

POST OrganizationConfigurations

Creates a new entity record.

The following elements are required:

organizationConfigurationResource

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

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 ApiOrganizationConfigurationResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/organizationConfigurations

POST /corePatterns/organizationConfigurations

PUT Operations

PUT Set IsActive OrganizationConfiguration

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

The following elements are required:

organizationKey	(string) Organization.
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/organizationConfigurations/{organizationKey}/isActive

PUT /corePatterns/organizationConfigurations/{organizationKey}/isActive

PUT Set OrganizationKey OrganizationConfiguration

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

The following elements are required:

organizationKey	(string) Organization.
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/organizationConfigurations/{organizationKey}/organizationKey

PUT /corePatterns/organizationConfigurations/{organizationKey}/organizationKey

PUT Set ReportingCurrency OrganizationConfiguration

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

The following elements are required:

organizationKey	(string) Organization.
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/organizationConfigurations/{organizationKey}/reportingCurrency

PUT /corePatterns/organizationConfigurations/{organizationKey}/reportingCurrency

PUT Set RequiresInitialization OrganizationConfiguration

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

The following elements are required:

organizationKey	(string) Organization.
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/organizationConfigurations/{organizationKey}/requiresInitialization

PUT /corePatterns/organizationConfigurations/{organizationKey}/requiresInitialization

DELETE Operations

DELETE OrganizationConfiguration 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/organizationConfigurations/{id}

DELETE /corePatterns/organizationConfigurations/{id}

DELETE OrganizationConfiguration by key

Deletes the entity record that matches the specified key.

The following elements are required:

organizationKey

(string) Organization.

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/organizationConfigurations/{organizationKey}

DELETE /corePatterns/organizationConfigurations/{organizationKey}

Resources

ApiOrganizationConfigurationResource

The following elements are required:

organizationKey	(string) Organization.
reportingCurrency	(string) Reporting Currency.
taxAuthorityCountry	(string) Tax Authority Country.
taxAuthorityCurrency	(string) Tax Authority Currency.
forceCountryAndCurrencyToCompanies	(bool) Force Country And Currency.
requiresInitialization	(bool) Requires Initialization.

OrganizationConfigurationResource

The following elements are required:

organizationKey	(string) Organization.
reportingCurrency	(string) Reporting Currency. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
taxAuthorityCountry	(string) Tax Authority Country. (fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
taxAuthorityCurrency	(string) Tax Authority Currency. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
forceCountryAndCurrencyToCompanies	(bool) Force Country And Currency.
requiresInitialization	(bool) Requires Initialization.