PATCH CurrencyExchangeRates/{id}/DeleteExchangeRate/{exchangeRateTypeId}/{toCurrencyId}

Request Parameters
Response Samples

Parameters

Name	Description	Additional information
id	Currency Id	Define this parameter in the request URI.
exchangeRateTypeId	If monthly currency type, specify monthly currency id. If range type, specify currency range id. If static, then 0	Define this parameter in the request URI.
toCurrencyId	Destination currency id for conversion	Define this parameter in the request URI.

Response body formats

A CurrencyExchangeResponse with the item set to null upon a successful delete.

application/json, text/json

Sample:

{
  "Item": {
    "CurrencyId": 1,
    "CurrencyType": 1,
    "ExchangeRates": {
      "MonthlyExchangeRates": [
        {
          "CurrencyMonthId": 1,
          "Month": 2,
          "Year": 3,
          "ExchangeRateTable": {
            "1": 2.1,
            "3": 4.1,
            "5": 6.1
          },
          "ApiExchangeRateTable": [
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            },
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            },
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            }
          ]
        },
        {
          "CurrencyMonthId": 1,
          "Month": 2,
          "Year": 3,
          "ExchangeRateTable": {
            "1": 2.1,
            "3": 4.1,
            "5": 6.1
          },
          "ApiExchangeRateTable": [
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            },
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            },
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            }
          ]
        },
        {
          "CurrencyMonthId": 1,
          "Month": 2,
          "Year": 3,
          "ExchangeRateTable": {
            "1": 2.1,
            "3": 4.1,
            "5": 6.1
          },
          "ApiExchangeRateTable": [
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            },
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            },
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            }
          ]
        }
      ],
      "DateRangeExchangeRates": [
        {
          "CurrencyDateRangeId": 1,
          "StartDate": "2025-12-05T15:03:52.0776491+00:00",
          "EndDate": "2025-12-05T15:03:52.0776491+00:00",
          "ExchangeRateTable": {
            "1": 2.1,
            "3": 4.1,
            "5": 6.1
          },
          "ApiExchangeRateTable": [
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            },
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            },
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            }
          ]
        },
        {
          "CurrencyDateRangeId": 1,
          "StartDate": "2025-12-05T15:03:52.0776491+00:00",
          "EndDate": "2025-12-05T15:03:52.0776491+00:00",
          "ExchangeRateTable": {
            "1": 2.1,
            "3": 4.1,
            "5": 6.1
          },
          "ApiExchangeRateTable": [
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            },
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            },
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            }
          ]
        },
        {
          "CurrencyDateRangeId": 1,
          "StartDate": "2025-12-05T15:03:52.0776491+00:00",
          "EndDate": "2025-12-05T15:03:52.0776491+00:00",
          "ExchangeRateTable": {
            "1": 2.1,
            "3": 4.1,
            "5": 6.1
          },
          "ApiExchangeRateTable": [
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            },
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            },
            {
              "CurrencyId": 1,
              "ExchangeRate": 2.1
            }
          ]
        }
      ],
      "StaticExchangeRates": {
        "ExchangeRateTable": {
          "1": 2.1,
          "3": 4.1,
          "5": 6.1
        },
        "ApiExchangeRateTable": [
          {
            "CurrencyId": 1,
            "ExchangeRate": 2.1
          },
          {
            "CurrencyId": 1,
            "ExchangeRate": 2.1
          },
          {
            "CurrencyId": 1,
            "ExchangeRate": 2.1
          }
        ]
      }
    }
  },
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample:

<CurrencyExchangeRatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:CurrencyId>1</d2p1:CurrencyId>
    <d2p1:CurrencyType>Static</d2p1:CurrencyType>
    <d2p1:ExchangeRates>
      <d2p1:DateRangeExchangeRates>
        <d2p1:CurrencyDateRange>
          <d2p1:ApiExchangeRateTable>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
          </d2p1:ApiExchangeRateTable>
          <d2p1:ExchangeRateTable xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>1</d6p1:Key>
              <d6p1:Value>2.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>3</d6p1:Key>
              <d6p1:Value>4.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>5</d6p1:Key>
              <d6p1:Value>6.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
          </d2p1:ExchangeRateTable>
          <d2p1:CurrencyDateRangeId>1</d2p1:CurrencyDateRangeId>
          <d2p1:EndDate>2025-12-05T15:03:52.0776491+00:00</d2p1:EndDate>
          <d2p1:StartDate>2025-12-05T15:03:52.0776491+00:00</d2p1:StartDate>
        </d2p1:CurrencyDateRange>
        <d2p1:CurrencyDateRange>
          <d2p1:ApiExchangeRateTable>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
          </d2p1:ApiExchangeRateTable>
          <d2p1:ExchangeRateTable xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>1</d6p1:Key>
              <d6p1:Value>2.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>3</d6p1:Key>
              <d6p1:Value>4.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>5</d6p1:Key>
              <d6p1:Value>6.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
          </d2p1:ExchangeRateTable>
          <d2p1:CurrencyDateRangeId>1</d2p1:CurrencyDateRangeId>
          <d2p1:EndDate>2025-12-05T15:03:52.0776491+00:00</d2p1:EndDate>
          <d2p1:StartDate>2025-12-05T15:03:52.0776491+00:00</d2p1:StartDate>
        </d2p1:CurrencyDateRange>
        <d2p1:CurrencyDateRange>
          <d2p1:ApiExchangeRateTable>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
          </d2p1:ApiExchangeRateTable>
          <d2p1:ExchangeRateTable xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>1</d6p1:Key>
              <d6p1:Value>2.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>3</d6p1:Key>
              <d6p1:Value>4.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>5</d6p1:Key>
              <d6p1:Value>6.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
          </d2p1:ExchangeRateTable>
          <d2p1:CurrencyDateRangeId>1</d2p1:CurrencyDateRangeId>
          <d2p1:EndDate>2025-12-05T15:03:52.0776491+00:00</d2p1:EndDate>
          <d2p1:StartDate>2025-12-05T15:03:52.0776491+00:00</d2p1:StartDate>
        </d2p1:CurrencyDateRange>
      </d2p1:DateRangeExchangeRates>
      <d2p1:MonthlyExchangeRates>
        <d2p1:CurrencyMonth>
          <d2p1:ApiExchangeRateTable>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
          </d2p1:ApiExchangeRateTable>
          <d2p1:ExchangeRateTable xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>1</d6p1:Key>
              <d6p1:Value>2.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>3</d6p1:Key>
              <d6p1:Value>4.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>5</d6p1:Key>
              <d6p1:Value>6.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
          </d2p1:ExchangeRateTable>
          <d2p1:CurrencyMonthId>1</d2p1:CurrencyMonthId>
          <d2p1:Month>2</d2p1:Month>
          <d2p1:Year>3</d2p1:Year>
        </d2p1:CurrencyMonth>
        <d2p1:CurrencyMonth>
          <d2p1:ApiExchangeRateTable>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
          </d2p1:ApiExchangeRateTable>
          <d2p1:ExchangeRateTable xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>1</d6p1:Key>
              <d6p1:Value>2.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>3</d6p1:Key>
              <d6p1:Value>4.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>5</d6p1:Key>
              <d6p1:Value>6.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
          </d2p1:ExchangeRateTable>
          <d2p1:CurrencyMonthId>1</d2p1:CurrencyMonthId>
          <d2p1:Month>2</d2p1:Month>
          <d2p1:Year>3</d2p1:Year>
        </d2p1:CurrencyMonth>
        <d2p1:CurrencyMonth>
          <d2p1:ApiExchangeRateTable>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
            <d2p1:CurrencyWithRate>
              <d2p1:CurrencyId>1</d2p1:CurrencyId>
              <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
            </d2p1:CurrencyWithRate>
          </d2p1:ApiExchangeRateTable>
          <d2p1:ExchangeRateTable xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>1</d6p1:Key>
              <d6p1:Value>2.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>3</d6p1:Key>
              <d6p1:Value>4.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
            <d6p1:KeyValueOfintdouble>
              <d6p1:Key>5</d6p1:Key>
              <d6p1:Value>6.1</d6p1:Value>
            </d6p1:KeyValueOfintdouble>
          </d2p1:ExchangeRateTable>
          <d2p1:CurrencyMonthId>1</d2p1:CurrencyMonthId>
          <d2p1:Month>2</d2p1:Month>
          <d2p1:Year>3</d2p1:Year>
        </d2p1:CurrencyMonth>
      </d2p1:MonthlyExchangeRates>
      <d2p1:StaticExchangeRates>
        <d2p1:ApiExchangeRateTable>
          <d2p1:CurrencyWithRate>
            <d2p1:CurrencyId>1</d2p1:CurrencyId>
            <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
          </d2p1:CurrencyWithRate>
          <d2p1:CurrencyWithRate>
            <d2p1:CurrencyId>1</d2p1:CurrencyId>
            <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
          </d2p1:CurrencyWithRate>
          <d2p1:CurrencyWithRate>
            <d2p1:CurrencyId>1</d2p1:CurrencyId>
            <d2p1:ExchangeRate>2.1</d2p1:ExchangeRate>
          </d2p1:CurrencyWithRate>
        </d2p1:ApiExchangeRateTable>
        <d2p1:ExchangeRateTable xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfintdouble>
            <d5p1:Key>1</d5p1:Key>
            <d5p1:Value>2.1</d5p1:Value>
          </d5p1:KeyValueOfintdouble>
          <d5p1:KeyValueOfintdouble>
            <d5p1:Key>3</d5p1:Key>
            <d5p1:Value>4.1</d5p1:Value>
          </d5p1:KeyValueOfintdouble>
          <d5p1:KeyValueOfintdouble>
            <d5p1:Key>5</d5p1:Key>
            <d5p1:Value>6.1</d5p1:Value>
          </d5p1:KeyValueOfintdouble>
        </d2p1:ExchangeRateTable>
      </d2p1:StaticExchangeRates>
    </d2p1:ExchangeRates>
  </Item>
</CurrencyExchangeRatesResponse>

PATCH CurrencyExchangeRates/{id}/DeleteExchangeRate/{exchangeRateTypeId}/{toCurrencyId}

Parameters

Response body formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body