{"components":{"responses":{"4XX_Client_Error_Response":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorResponse"}}},"description":"error response for all http error codes in range 4XX"},"5XX_Server_Error_Response":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorResponse"}}},"description":"error response for all http error codes in range 5XX"}},"schemas":{"ConversionRequest":{"properties":{"baseMonetaryValue":{"$ref":"#/components/schemas/MonetaryAmountDto_1"},"targetCurrency":{"description":"The target currency, to which the monetary value will be converter.\nMust not be null.","example":"EUR","type":"string"}},"required":["baseMonetaryValue","targetCurrency"],"type":"object"},"ConversionResult":{"properties":{"baseValue":{"$ref":"#/components/schemas/MonetaryAmountDto_2"},"exchangeRate":{"description":"The exchange rate used for the conversion","type":"number"},"exchangeRateDate":{"description":"The data from which the conversion rate was used","format":"date","type":"string"},"provider":{"description":"The provider, that provided the exchange rates","type":"string"},"targetValue":{"$ref":"#/components/schemas/MonetaryAmountDto_3"}},"type":"object"},"CurrenciesToAddRequest":{"properties":{"currenciesToAdd":{"description":"Must not be empty.","items":{"enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"minItems":1,"type":"array"}},"required":["currenciesToAdd"],"type":"object"},"ExchangeRatesCreationRequest":{"properties":{"baseCurrency":{"description":"Currency that foreign exchange values will be converted into, should be same as the functional currency of your tenant.\nMust not be null.","example":"EUR","type":"string"},"date":{"description":"The date for which these exchange rates shall be used as daily rate. Remember: Conversions are always done with the daily rate of the previous day.\nMust not be null.","example":"2022-03-24","format":"date","type":"string"},"exchangeRates":{"additionalProperties":{"description":"Exchange rates for the different currencies. The key is the 3 char currency code. Example: Key: 'PLN', Value: 4.15513","type":"number"},"description":"Exchange rates for the different currencies. The key is the 3 char currency code. Example: Key: 'PLN', Value: 4.15513.\nMust not be empty.","minProperties":1,"type":"object"}},"required":["baseCurrency","date","exchangeRates"],"type":"object"},"ExchangeRatesDto":{"properties":{"baseCurrency":{"default":"EUR","description":"Currency that foreign exchange values will be converted into, should be same as the functional currency of your tenant","example":"EUR","type":"string"},"date":{"description":"Date on wich the exhange rate was valid","example":"2022-03-30","format":"date","type":"string"},"exchangeRates":{"additionalProperties":{"description":"Exchange rates for the given baseCurrency","readOnly":true,"type":"number"},"description":"Exchange rates for the given baseCurrency","readOnly":true,"type":"object"},"provider":{"default":"fixer.io","description":"Provider of the given exchange rates","example":"fixer.io","type":"string"}},"type":"object"},"GlobalErrorResponse":{"description":"error response providing details about the error occurred","properties":{"errors":{"description":"optional list of multiple errors occurred","items":{"type":"object"},"type":"array"},"message":{"description":"message describing the error","type":"string"},"path":{"description":"URL path where the error occurred","type":"string"},"status":{"description":"textual representation of http status code, e.g. 'BAD_REQUEST' for status code 400","type":"string"},"timestamp":{"description":"timestamp in UTC when the error occurred","format":"date-time","type":"string"},"uuid":{"description":"UUID generated by the server to identify the error occurred, should be stated in case of any inquiries","format":"uuid","type":"string"}},"type":"object"},"MonetaryAmountDto_1":{"description":"Monetary value, that is to be converted to the target currency.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryAmountDto_2":{"description":"Monetary value, that was passed in as the monetary amount to convert.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"MonetaryAmountDto_3":{"description":"Monetary value after the conversion to the target currency.\nA monetary amount along with a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"TenantConfigDto":{"properties":{"selfProvided":{"description":"Must not be null.","type":"boolean"}},"required":["selfProvided"],"type":"object"}},"securitySchemes":{"oauth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.isx-stage-westeurope.instellix.io/<tenant_short>/oauth2/token"}},"type":"oauth2"}}},"info":{"description":"API Description for Currency Converter","title":"Currency Converter API","version":"v2-preview-1.11.2"},"openapi":"3.0.1","paths":{"/v2/exchange-rates":{"get":{"description":"Get the exchange rates for a given date.","operationId":"getExchangeRates","parameters":[{"description":"Must be in the past or present.","in":"query","name":"date","required":true,"schema":{"format":"date","type":"string"}},{"description":"The base currency to request.","in":"query","name":"baseCurrency","required":true,"schema":{"description":"The base currency to request.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"}},{"description":"A list of target currencies to request exchange rates for. When null or empty, all known target currencies are returned.","in":"query","name":"targetCurrencies","schema":{"description":"A list of target currencies to request exchange rates for. When null or empty, all known target currencies are returned.","items":{"description":"A list of target currencies to request exchange rates for. When null or empty, all known target currencies are returned.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"type":"array","uniqueItems":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeRatesDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"summary":"Get exchange rates","tags":["Currency Converter"]},"post":{"description":"A request to post self provided exchange rates.","operationId":"postSelfProvidedExchangeRates","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeRatesCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeRatesDto"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"summary":"Post self provided exchange rates","tags":["Currency Converter"]}}},"security":[{"oauth2":[]}],"servers":[{"description":"Instellix Stage","url":"https://api.isx-stage-westeurope.instellix.io"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true}}