GET api/Admin/CurrencyConversionRate?CurrencyTypeIdFrom={CurrencyTypeIdFrom}&CurrencyTypeIdTo={CurrencyTypeIdTo}

This API method will allow getting the collection of any currency conversion rate between two currency types.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CurrencyTypeIdFrom

The primary identifier of the currency type which the conversion rate applies from.

integer

Required

CurrencyTypeIdTo

The primary identifier of the currency type which the conversion rate applies to.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of CurrencyConversionRate
NameDescriptionTypeAdditional information
ID

The primary identifier of the currency conversion rate.

integer

None.

CurrencyTypeFrom

This is the identifier of the selected currency where rate will be applied.

integer

None.

CurrencyTypeTo

This is the identifier of the selected currency where rate will be applied.

integer

None.

RateCommission

Rate at which this currency is converted from the Base Currency.

decimal number

None.

StartDate

Date that this rate is in effect from.

date

None.

EndDate

Date that this rate is in effect to.

date

None.

CurrencyConversionAreaTypeID

Area of the system that this rate is applicable for.

integer

None.

IsActive

Indicates if this rate is currently active.

boolean

None.

DateCreated

Date when this record was created.

date

None.

CreatedBy

User name of person who created this record.

string

None.

DateLastModified

Last date when this record was modified.

date

None.

LastModifiedBy

User name of last person who modified this record.

string

None.

Response Formats

application/xml, text/xml

Sample:
<ListOfCurrencyConversionRate>
  <CurrencyConversionRate>
    <ID>1</ID>
    <CurrencyTypeFrom>2</CurrencyTypeFrom>
    <CurrencyTypeTo>3</CurrencyTypeTo>
    <RateCommission>4</RateCommission>
    <StartDate>01/09/2025 01:43:01</StartDate>
    <EndDate>01/09/2025 01:43:01</EndDate>
    <CurrencyConversionAreaTypeID>7</CurrencyConversionAreaTypeID>
    <IsActive>True</IsActive>
    <DateCreated>01/09/2025 01:43:01</DateCreated>
    <CreatedBy>sample string 10</CreatedBy>
    <DateLastModified>01/09/2025 01:43:01</DateLastModified>
    <LastModifiedBy>sample string 11</LastModifiedBy>
  </CurrencyConversionRate>
  <CurrencyConversionRate>
    <ID>1</ID>
    <CurrencyTypeFrom>2</CurrencyTypeFrom>
    <CurrencyTypeTo>3</CurrencyTypeTo>
    <RateCommission>4</RateCommission>
    <StartDate>01/09/2025 01:43:01</StartDate>
    <EndDate>01/09/2025 01:43:01</EndDate>
    <CurrencyConversionAreaTypeID>7</CurrencyConversionAreaTypeID>
    <IsActive>True</IsActive>
    <DateCreated>01/09/2025 01:43:01</DateCreated>
    <CreatedBy>sample string 10</CreatedBy>
    <DateLastModified>01/09/2025 01:43:01</DateLastModified>
    <LastModifiedBy>sample string 11</LastModifiedBy>
  </CurrencyConversionRate>
</ListOfCurrencyConversionRate>

application/json, text/json

Sample:
[
  {
    "ID": 1,
    "CurrencyTypeFrom": 2,
    "CurrencyTypeTo": 3,
    "RateCommission": 4.0,
    "StartDate": "2025-01-09T01:43:01.0908438-05:00",
    "EndDate": "2025-01-09T01:43:01.0908438-05:00",
    "CurrencyConversionAreaTypeID": 7,
    "IsActive": true,
    "DateCreated": "2025-01-09T01:43:01.0908438-05:00",
    "CreatedBy": "sample string 10",
    "DateLastModified": "2025-01-09T01:43:01.0908438-05:00",
    "LastModifiedBy": "sample string 11"
  },
  {
    "ID": 1,
    "CurrencyTypeFrom": 2,
    "CurrencyTypeTo": 3,
    "RateCommission": 4.0,
    "StartDate": "2025-01-09T01:43:01.0908438-05:00",
    "EndDate": "2025-01-09T01:43:01.0908438-05:00",
    "CurrencyConversionAreaTypeID": 7,
    "IsActive": true,
    "DateCreated": "2025-01-09T01:43:01.0908438-05:00",
    "CreatedBy": "sample string 10",
    "DateLastModified": "2025-01-09T01:43:01.0908438-05:00",
    "LastModifiedBy": "sample string 11"
  }
]