Master Data Business Entities | Exchange Rates Document

Service to manage entities of type 'ExchangeRatesDocument'.

Overview

api/{tenantKey}/{orgKey}/businessCore/exchangeRatesDocuments

URL	api/{tenantKey}/{orgKey}/businessCore/exchangeRatesDocuments
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST ExchangeRatesDocuments
- POST Exchange Rates Document
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiExchangeRatesDocumentExchangeRateDocumentRatesResource
ApiExchangeRatesDocumentResource
ExchangeRateDocumentRateResource
ExchangeRatesDocumentResource

All Enumerations

This service uses the following enumerations:

ExchangeRateType

GET Operations

GET ExchangeRatesDocuments

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/exchangeRatesDocuments

GET /businessCore/exchangeRatesDocuments

GET ExchangeRatesDocuments (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 ExchangeRatesDocumentResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/exchangeRatesDocuments?page={page}&pageSize={pageSize}

GET /businessCore/exchangeRatesDocuments?page={page}&pageSize={pageSize}

GET ExchangeRatesDocument 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 ExchangeRatesDocumentResource.

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

GET /businessCore/exchangeRatesDocuments/{id}

GET ExchangeRatesDocument by key

Returns the entity record that matches the specified key.

The following elements are required:

number

(int) The exchange rates document's number.

Response:

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

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}/businessCore/exchangeRatesDocuments/{number}

GET /businessCore/exchangeRatesDocuments/{number}

GET Print ExchangeRatesDocument 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}/businessCore/exchangeRatesDocuments/{id}/print?template={template}

GET /businessCore/exchangeRatesDocuments/{id}/print?template={template}

GET Print ExchangeRatesDocument by key

Prints the specified entity record.

The following elements are required:

number

(int) The exchange rates document's number.

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}/businessCore/exchangeRatesDocuments/{number}/print

GET /businessCore/exchangeRatesDocuments/{number}/print

GET Original Print ExchangeRatesDocumentOriginal 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}/businessCore/exchangeRatesDocuments/{id}/printOriginal?template={template}

GET /businessCore/exchangeRatesDocuments/{id}/printOriginal?template={template}

GET Original Print ExchangeRatesDocument by key

Prints the specified entity record.

The following elements are required:

number

(int) The exchange rates document's number.

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}/businessCore/exchangeRatesDocuments/{number}/printOriginal

GET /businessCore/exchangeRatesDocuments/{number}/printOriginal

POST Operations

POST ExchangeRatesDocuments

Creates a new entity record.

The following elements are required:

exchangeRatesDocumentResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/exchangeRatesDocuments

POST /businessCore/exchangeRatesDocuments

POST Exchange Rates Document

Inserts a new 'Exchange Rate Document Rate' in the 'Exchange Rates Document'.

The following elements are required:

number	(int) The exchange rates document's number.
value	(ApiExchangeRatesDocumentExchangeRateDocumentRatesResource) The ApiExchangeRatesDocumentExchangeRateDocumentRatesResource instance. See ApiExchangeRatesDocumentExchangeRateDocumentRatesResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/exchangeRatesDocuments/{number}/exchangeRateDocumentRates

POST /businessCore/exchangeRatesDocuments/{number}/exchangeRateDocumentRates

PUT Operations

PUT Set ConversionFactor ExchangeRateDocumentRate

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

The following elements are required:

number	(int) The exchange rates document's number.
lineId	(string) The detail identifier.
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:

api/{tenantKey}/{orgKey}/businessCore/exchangeRatesDocuments/{number}/exchangeRateDocumentRates/{lineId}/conversionFactor

PUT /businessCore/exchangeRatesDocuments/{number}/exchangeRateDocumentRates/{lineId}/conversionFactor

PUT Set ExchangeRateType ExchangeRatesDocument

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

The following elements are required:

number	(int) The exchange rates document's number.
value	(enum ExchangeRateType) The request body should contain the new value for the attribute. See ExchangeRateType.

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}/businessCore/exchangeRatesDocuments/{number}/exchangeRateType

PUT /businessCore/exchangeRatesDocuments/{number}/exchangeRateType

PUT Set ExternalId ExchangeRatesDocument

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

The following elements are required:

number	(int) The exchange rates document's number.
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}/businessCore/exchangeRatesDocuments/{number}/externalId

PUT /businessCore/exchangeRatesDocuments/{number}/externalId

PUT Set ExternalVersion ExchangeRatesDocument

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

The following elements are required:

number	(int) The exchange rates document's number.
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}/businessCore/exchangeRatesDocuments/{number}/externalVersion

PUT /businessCore/exchangeRatesDocuments/{number}/externalVersion

PUT Set FromCurrency ExchangeRateDocumentRate

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

The following elements are required:

number	(int) The exchange rates document's number.
lineId	(string) The detail identifier.
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}/businessCore/exchangeRatesDocuments/{number}/exchangeRateDocumentRates/{lineId}/fromCurrency

PUT /businessCore/exchangeRatesDocuments/{number}/exchangeRateDocumentRates/{lineId}/fromCurrency

PUT Set FromExchangeRateId ExchangeRateDocumentRate

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

The following elements are required:

number	(int) The exchange rates document's number.
lineId	(string) The detail identifier.
value	(Guid) 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}/businessCore/exchangeRatesDocuments/{number}/exchangeRateDocumentRates/{lineId}/fromExchangeRateId

PUT /businessCore/exchangeRatesDocuments/{number}/exchangeRateDocumentRates/{lineId}/fromExchangeRateId

PUT Set IsActive ExchangeRatesDocument

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

The following elements are required:

number	(int) The exchange rates document's number.
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}/businessCore/exchangeRatesDocuments/{number}/isActive

PUT /businessCore/exchangeRatesDocuments/{number}/isActive

PUT Set IsExternallyManaged ExchangeRatesDocument

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

The following elements are required:

number	(int) The exchange rates document's number.
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}/businessCore/exchangeRatesDocuments/{number}/isExternallyManaged

PUT /businessCore/exchangeRatesDocuments/{number}/isExternallyManaged

PUT Set Number ExchangeRatesDocument

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

The following elements are required:

number	(int) The exchange rates document's number.
value	(int) 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}/businessCore/exchangeRatesDocuments/{number}/number

PUT /businessCore/exchangeRatesDocuments/{number}/number

PUT Set ToCurrency ExchangeRateDocumentRate

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

The following elements are required:

number	(int) The exchange rates document's number.
lineId	(string) The detail identifier.
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}/businessCore/exchangeRatesDocuments/{number}/exchangeRateDocumentRates/{lineId}/toCurrency

PUT /businessCore/exchangeRatesDocuments/{number}/exchangeRateDocumentRates/{lineId}/toCurrency

PUT Set ToExchangeRateId ExchangeRateDocumentRate

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

The following elements are required:

number	(int) The exchange rates document's number.
lineId	(string) The detail identifier.
value	(Guid) 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}/businessCore/exchangeRatesDocuments/{number}/exchangeRateDocumentRates/{lineId}/toExchangeRateId

PUT /businessCore/exchangeRatesDocuments/{number}/exchangeRateDocumentRates/{lineId}/toExchangeRateId

PUT Set ValidFrom ExchangeRatesDocument

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

The following elements are required:

number	(int) The exchange rates document's number.
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:

api/{tenantKey}/{orgKey}/businessCore/exchangeRatesDocuments/{number}/validFrom

PUT /businessCore/exchangeRatesDocuments/{number}/validFrom

DELETE Operations

DELETE Exchange Rate Document Rate by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

number	(int) The exchange rates document's number.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. 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}/businessCore/exchangeRatesDocuments/{number}/exchangeRateDocumentRates/{lineId}

DELETE /businessCore/exchangeRatesDocuments/{number}/exchangeRateDocumentRates/{lineId}

DELETE ExchangeRatesDocument 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}/businessCore/exchangeRatesDocuments/{id}

DELETE /businessCore/exchangeRatesDocuments/{id}

DELETE ExchangeRatesDocument by key

Deletes the entity record that matches the specified key.

The following elements are required:

number

(int) The exchange rates document's number.

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}/businessCore/exchangeRatesDocuments/{number}

DELETE /businessCore/exchangeRatesDocuments/{number}

Resources

ApiExchangeRatesDocumentExchangeRateDocumentRatesResource

The following elements are required:

conversionFactor	(decimal) The exchange rate conversion factor. Reference value for the calculation of values. The price of one country's currency expressed in another country's currency.
toCurrency	(string) The exchange rate target currency. Money unit (currency) that establishes the target unit into which the calculation of a currency exchange will be done.
fromCurrency	(string) The exchange rate source currency. Original money unit (currency) that establishes the baseline for the calculation of a currency exchange.

The following elements are optional:

fromExchangeRateId	(Guid) The source exchange rate identifier.
toExchangeRateId	(Guid) The target exchange rate identifier.

ApiExchangeRatesDocumentResource

The following elements are required:

number	(int) The exchange rates document's number.
validFrom	(DateTime) The start date for validity period.
exchangeRateType	(enum ExchangeRateType) The exchange rates document's type. See ExchangeRateType.
isExternallyManaged	(bool) A flag indicating if the exchange rates document is externally managed.

The following elements are optional:

exchangeRateDocumentRates	(List of ApiExchangeRatesDocumentExchangeRateDocumentRatesResource) The rates contained on the exchange rates document. See ApiExchangeRatesDocumentExchangeRateDocumentRatesResource.
externalId	(string) The external id for the exchange rates document.
externalVersion	(string) The external version for the exchange rates document.

ExchangeRateDocumentRateResource

The following elements are required:

conversionFactor	(decimal) The exchange rate conversion factor. Reference value for the calculation of values. The price of one country's currency expressed in another country's currency.
toCurrency	(string) The exchange rate target currency. Money unit (currency) that establishes the target unit into which the calculation of a currency exchange will be done.
fromCurrency	(string) The exchange rate source currency. Original money unit (currency) that establishes the baseline for the calculation of a currency exchange.

The following elements are optional:

fromExchangeRateId	(Guid) The source exchange rate identifier.
toExchangeRateId	(Guid) The target exchange rate identifier.

ExchangeRatesDocumentResource

The following elements are required:

number	(int) The exchange rates document's number.
validFrom	(DateTime) The start date for validity period.
exchangeRateType	(enum ExchangeRateType) The exchange rates document's type. See ExchangeRateType.
isExternallyManaged	(bool) A flag indicating if the exchange rates document is externally managed.

The following elements are optional:

exchangeRateDocumentRates	(List of ExchangeRateDocumentRateResource) The rates contained on the exchange rates document. See ExchangeRateDocumentRateResource.
externalId	(string) The external id for the exchange rates document.
externalVersion	(string) The external version for the exchange rates document.

Enumerations

ExchangeRateType

1	Market
2	Organization
3	User