Jasmin Developers - Web API Reference

Platform | Organization Configuration

Service to manage entities of type 'OrganizationConfiguration'.

Overview


URL api/{tenantKey}/{orgKey}/corePatterns/organizationConfigurations
Methods Supported GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

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

Response status codes:

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

Resource URL:

GET /corePatterns/organizationConfigurations/odata

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:

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:

GET /corePatterns/organizationConfigurations/{organizationKey}

Resources


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.