GET Advances/GetAdvancesForCurrency?currencyId={currencyId}

Gets the available Advances for the currency supplied and current employee.


Parameters

NameDescriptionAdditional information
currencyId
The currency Id

Define this parameter in the request URI.

Response body formats

The AdvancesResponse

application/json, text/json

Sample:
{
  "List": [
    {
      "FloatId": 1,
      "EmployeeId": 2,
      "CurrencyId": 3,
      "Name": "sample string 4",
      "DisplayName": "sample string 5",
      "Available": true,
      "Outcome": "sample string 7"
    },
    {
      "FloatId": 1,
      "EmployeeId": 2,
      "CurrencyId": 3,
      "Name": "sample string 4",
      "DisplayName": "sample string 5",
      "Available": true,
      "Outcome": "sample string 7"
    },
    {
      "FloatId": 1,
      "EmployeeId": 2,
      "CurrencyId": 3,
      "Name": "sample string 4",
      "DisplayName": "sample string 5",
      "Available": true,
      "Outcome": "sample string 7"
    }
  ],
  "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:
<AdvancesResponse 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>
  <List xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types">
    <d2p1:Advance>
      <d2p1:Available>true</d2p1:Available>
      <d2p1:CurrencyId>3</d2p1:CurrencyId>
      <d2p1:DisplayName>sample string 5</d2p1:DisplayName>
      <d2p1:EmployeeId>2</d2p1:EmployeeId>
      <d2p1:FloatId>1</d2p1:FloatId>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:Outcome>sample string 7</d2p1:Outcome>
    </d2p1:Advance>
    <d2p1:Advance>
      <d2p1:Available>true</d2p1:Available>
      <d2p1:CurrencyId>3</d2p1:CurrencyId>
      <d2p1:DisplayName>sample string 5</d2p1:DisplayName>
      <d2p1:EmployeeId>2</d2p1:EmployeeId>
      <d2p1:FloatId>1</d2p1:FloatId>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:Outcome>sample string 7</d2p1:Outcome>
    </d2p1:Advance>
    <d2p1:Advance>
      <d2p1:Available>true</d2p1:Available>
      <d2p1:CurrencyId>3</d2p1:CurrencyId>
      <d2p1:DisplayName>sample string 5</d2p1:DisplayName>
      <d2p1:EmployeeId>2</d2p1:EmployeeId>
      <d2p1:FloatId>1</d2p1:FloatId>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:Outcome>sample string 7</d2p1:Outcome>
    </d2p1:Advance>
  </List>
</AdvancesResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body