PUT Countries/{id}

Archive/ unarchive an existing country record. Add/ update/ delete VAT rates. Use the ForDelete flag on the VatRate to delete a VAT rate associated with the country.

Request Parameters
Request Samples
Response Samples

Parameters

Name	Description	Additional information
id	The Id of the Country to modify	Define this parameter in the request URI.
request	Country	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "CountryId": 0,
  "CountryName": null,
  "GlobalCountryId": 1,
  "VatRates": [
    {
      "ExpenseSubCategoryId": 1,
      "Vat": 100.0,
      "VatPercent": 20.0
    }
  ],
  "Archived": false
}

application/xml, text/xml

Sample:

<Country xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types">
  <Archived>false</Archived>
  <CountryId>0</CountryId>
  <CountryName i:nil="true" />
  <GlobalCountryId>1</GlobalCountryId>
  <VatRates>
    <VatRate>
      <ExpenseSubCategoryId>1</ExpenseSubCategoryId>
      <Vat>100</Vat>
      <VatPercent>20</VatPercent>
    </VatRate>
  </VatRates>
</Country>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response body formats

Updated country data and VAT rates

application/json, text/json

Sample:

{
  "Item": {
    "CountryId": 1,
    "CountryName": "sample string 2",
    "GlobalCountryId": 3,
    "VatRates": [
      {
        "ExpenseSubCategoryId": 1,
        "Vat": 2.1,
        "VatPercent": 3.1
      },
      {
        "ExpenseSubCategoryId": 1,
        "Vat": 2.1,
        "VatPercent": 3.1
      },
      {
        "ExpenseSubCategoryId": 1,
        "Vat": 2.1,
        "VatPercent": 3.1
      }
    ],
    "Archived": true
  },
  "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:

<CountryResponse 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:Archived>true</d2p1:Archived>
    <d2p1:CountryId>1</d2p1:CountryId>
    <d2p1:CountryName>sample string 2</d2p1:CountryName>
    <d2p1:GlobalCountryId>3</d2p1:GlobalCountryId>
    <d2p1:VatRates>
      <d2p1:VatRate>
        <d2p1:ExpenseSubCategoryId>1</d2p1:ExpenseSubCategoryId>
        <d2p1:Vat>2.1</d2p1:Vat>
        <d2p1:VatPercent>3.1</d2p1:VatPercent>
      </d2p1:VatRate>
      <d2p1:VatRate>
        <d2p1:ExpenseSubCategoryId>1</d2p1:ExpenseSubCategoryId>
        <d2p1:Vat>2.1</d2p1:Vat>
        <d2p1:VatPercent>3.1</d2p1:VatPercent>
      </d2p1:VatRate>
      <d2p1:VatRate>
        <d2p1:ExpenseSubCategoryId>1</d2p1:ExpenseSubCategoryId>
        <d2p1:Vat>2.1</d2p1:Vat>
        <d2p1:VatPercent>3.1</d2p1:VatPercent>
      </d2p1:VatRate>
    </d2p1:VatRates>
  </Item>
</CountryResponse>

PUT Countries/{id}

Parameters

Request body formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response body formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body