POST Allowances

Adds an Allowance.


Parameters

NameDescriptionAdditional information
request 
The Allowance to add. 
            When adding a new Allowance through the API, the following properties are required:
            Id: Must be set to 0, or the add will throw an error.
            Label: Must be set to something meaningful, or the add will throw an error.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Label": "sample string 2",
  "Description": "sample string 3",
  "CurrencyId": 4,
  "NightHours": 5,
  "NightRate": 6.0,
  "AllowanceRates": [
    {
      "Id": 1,
      "AllowanceId": 2,
      "HourThreshold": 3,
      "HourlyRate": 4.0
    },
    {
      "Id": 1,
      "AllowanceId": 2,
      "HourThreshold": 3,
      "HourlyRate": 4.0
    },
    {
      "Id": 1,
      "AllowanceId": 2,
      "HourThreshold": 3,
      "HourlyRate": 4.0
    }
  ]
}

application/xml, text/xml

Sample: 
<Allowance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types">
  <AllowanceRates>
    <AllowanceRate>
      <AllowanceId>2</AllowanceId>
      <HourThreshold>3</HourThreshold>
      <HourlyRate>4</HourlyRate>
      <Id>1</Id>
    </AllowanceRate>
    <AllowanceRate>
      <AllowanceId>2</AllowanceId>
      <HourThreshold>3</HourThreshold>
      <HourlyRate>4</HourlyRate>
      <Id>1</Id>
    </AllowanceRate>
    <AllowanceRate>
      <AllowanceId>2</AllowanceId>
      <HourThreshold>3</HourThreshold>
      <HourlyRate>4</HourlyRate>
      <Id>1</Id>
    </AllowanceRate>
  </AllowanceRates>
  <CurrencyId>4</CurrencyId>
  <Description>sample string 3</Description>
  <Id>1</Id>
  <Label>sample string 2</Label>
  <NightHours>5</NightHours>
  <NightRate>6</NightRate>
</Allowance>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response body formats

An AllowanceResponse.

application/json, text/json

Sample: 
{
  "Item": {
    "Id": 1,
    "Label": "sample string 2",
    "Description": "sample string 3",
    "CurrencyId": 4,
    "NightHours": 5,
    "NightRate": 6.0,
    "AllowanceRates": [
      {
        "Id": 1,
        "AllowanceId": 2,
        "HourThreshold": 3,
        "HourlyRate": 4.0
      },
      {
        "Id": 1,
        "AllowanceId": 2,
        "HourThreshold": 3,
        "HourlyRate": 4.0
      },
      {
        "Id": 1,
        "AllowanceId": 2,
        "HourThreshold": 3,
        "HourlyRate": 4.0
      }
    ]
  },
  "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: 
<AllowanceResponse 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:AllowanceRates>
      <d2p1:AllowanceRate>
        <d2p1:AllowanceId>2</d2p1:AllowanceId>
        <d2p1:HourThreshold>3</d2p1:HourThreshold>
        <d2p1:HourlyRate>4</d2p1:HourlyRate>
        <d2p1:Id>1</d2p1:Id>
      </d2p1:AllowanceRate>
      <d2p1:AllowanceRate>
        <d2p1:AllowanceId>2</d2p1:AllowanceId>
        <d2p1:HourThreshold>3</d2p1:HourThreshold>
        <d2p1:HourlyRate>4</d2p1:HourlyRate>
        <d2p1:Id>1</d2p1:Id>
      </d2p1:AllowanceRate>
      <d2p1:AllowanceRate>
        <d2p1:AllowanceId>2</d2p1:AllowanceId>
        <d2p1:HourThreshold>3</d2p1:HourThreshold>
        <d2p1:HourlyRate>4</d2p1:HourlyRate>
        <d2p1:Id>1</d2p1:Id>
      </d2p1:AllowanceRate>
    </d2p1:AllowanceRates>
    <d2p1:CurrencyId>4</d2p1:CurrencyId>
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Label>sample string 2</d2p1:Label>
    <d2p1:NightHours>5</d2p1:NightHours>
    <d2p1:NightRate>6</d2p1:NightRate>
  </Item>
</AllowanceResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body