Business Core | Exchange Rates Document

Service to manage entities of type 'ExchangeRatesDocument'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET ExchangeRatesDocuments (odata)
  • GET ExchangeRatesDocument by identifier
  • GET ExchangeRatesDocument by key
• POST:
  • POST ExchangeRatesDocuments
  • POST Exchange Rate Document Rate
  • POST Get Currency Exchange Rates
  • POST Get Currency Exchange Rates By Company
• PUT:
  • PUT Set Custom Attribute ExchangeRatesDocument
  • PUT Set Custom Attribute ExchangeRateDocumentRate
  • PUT Set IsActive ExchangeRatesDocument
  • PUT Set Number ExchangeRatesDocument
  • PUT Set ValidFrom ExchangeRatesDocument
  • PUT Set ExchangeRateType ExchangeRatesDocument
  • PUT Set ExternalId ExchangeRatesDocument
  • PUT Set ExternalVersion ExchangeRatesDocument
  • PUT Set IsExternallyManaged ExchangeRatesDocument
  • PUT Set ConversionFactor ExchangeRateDocumentRate
  • PUT Set ToCurrency ExchangeRateDocumentRate
  • PUT Set FromCurrency ExchangeRateDocumentRate
  • PUT Set FromExchangeRateId ExchangeRateDocumentRate
  • PUT Set ToExchangeRateId ExchangeRateDocumentRate
• DELETE:
  • DELETE Exchange Rate Document Rate by identifier
  • DELETE ExchangeRatesDocument by identifier
  • DELETE ExchangeRatesDocument by key

All Resources

This service uses the following resources:

• ApiExchangeRatesDocumentExchangeRateDocumentRatesResource
• ApiExchangeRatesDocumentResource
• ExchangeCurrencyRate
• ExchangeRatesDocumentResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• ExchangeRateType

GET Operations

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

Response status codes:

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

Resource URL:

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:

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:

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.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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:

POST Exchange Rate Document Rate

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.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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:

POST Get Currency Exchange Rates

Custom operation 'GetCurrencyExchangeRates'.

The following elements are required:

currencyFromKey	(string) CurrencyFromKey.
currencyToKey	(string) CurrencyToKey.
referencedDate	(DateTime?) ReferencedDate.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains a resource of type 'ExchangeCurrencyRate'. See ExchangeCurrencyRate.

Resource URL:

POST Get Currency Exchange Rates By Company

Custom operation 'GetCurrencyExchangeRatesByCompany'.

The following elements are required:

currencyKey	(string) CurrencyKey.
companyKey	(string) CompanyKey.
referencedDate	(DateTime?) ReferencedDate.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains a resource of type 'ExchangeCurrencyRate'. See ExchangeCurrencyRate.

Resource URL:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

PUT Set Custom Attribute ExchangeRatesDocument

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

number	(int) The exchange rates document's number.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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 Custom Attribute ExchangeRateDocumentRate

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

number	(int) The exchange rates document's number.
lineId	(string) The detail identifier.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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:

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:

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:

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:

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.

ExchangeCurrencyRate

The following elements are optional:

currencyFromKey	(string) Currency From Key.
currencyToKey	(string) Currency To Key.
exchangeRate	(decimal) Exchange Rate.
exchangeRateDate	(DateTime) Exchange Rate Date.

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.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

ExchangeRateType

1	Market
2	Organization
3	User