GET payroll/employees/{id}/residences

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Residence
NameDescriptionTypeAdditional information
ID

integer

None.

EmployeeID

integer

None.

Employee

ListItem

None.

Address

Address

None.

MunicipalityID

integer

None.

Municipality

ListItem

None.

From

date

None.

To

date

None.

Audit

Audit

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": 1,
    "EmployeeID": 2,
    "Employee": {
      "Key": 1,
      "Value": "sample string 2"
    },
    "Address": {
      "Street": "sample string 1",
      "Postcode": "sample string 2",
      "City": "sample string 3",
      "CountryID": 4,
      "Country": {
        "ID": 1,
        "Name": "sample string 2",
        "CurrencyID": 1,
        "Currency": {
          "ID": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "Sign": "sample string 4",
          "Lookup": "sample string 5"
        },
        "ISO31661": 1,
        "Alpha2": "sample string 3",
        "Alpha3": "sample string 4",
        "Audit": {
          "AddUser": 1,
          "AddTime": "2024-03-29T08:15:25.4520048+00:00",
          "EditUser": 1,
          "EditTime": "2024-03-29T08:15:25.4520048+00:00"
        }
      }
    },
    "MunicipalityID": 3,
    "Municipality": {
      "Key": 1,
      "Value": "sample string 2"
    },
    "From": "2024-03-29T08:15:25.4520048+00:00",
    "To": "2024-03-29T08:15:25.4520048+00:00",
    "Audit": {
      "AddUser": 1,
      "AddTime": "2024-03-29T08:15:25.4520048+00:00",
      "EditUser": 1,
      "EditTime": "2024-03-29T08:15:25.4520048+00:00"
    }
  },
  {
    "ID": 1,
    "EmployeeID": 2,
    "Employee": {
      "Key": 1,
      "Value": "sample string 2"
    },
    "Address": {
      "Street": "sample string 1",
      "Postcode": "sample string 2",
      "City": "sample string 3",
      "CountryID": 4,
      "Country": {
        "ID": 1,
        "Name": "sample string 2",
        "CurrencyID": 1,
        "Currency": {
          "ID": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "Sign": "sample string 4",
          "Lookup": "sample string 5"
        },
        "ISO31661": 1,
        "Alpha2": "sample string 3",
        "Alpha3": "sample string 4",
        "Audit": {
          "AddUser": 1,
          "AddTime": "2024-03-29T08:15:25.4520048+00:00",
          "EditUser": 1,
          "EditTime": "2024-03-29T08:15:25.4520048+00:00"
        }
      }
    },
    "MunicipalityID": 3,
    "Municipality": {
      "Key": 1,
      "Value": "sample string 2"
    },
    "From": "2024-03-29T08:15:25.4520048+00:00",
    "To": "2024-03-29T08:15:25.4520048+00:00",
    "Audit": {
      "AddUser": 1,
      "AddTime": "2024-03-29T08:15:25.4520048+00:00",
      "EditUser": 1,
      "EditTime": "2024-03-29T08:15:25.4520048+00:00"
    }
  }
]

text/xml

Sample:
<ArrayOfResidence xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Payroll">
  <Residence>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>
        <d3p1:Alpha2>sample string 3</d3p1:Alpha2>
        <d3p1:Alpha3>sample string 4</d3p1:Alpha3>
        <d3p1:Audit xmlns:d5p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
          <d5p1:AddTime>2024-03-29T08:15:25.4520048+00:00</d5p1:AddTime>
          <d5p1:AddUser>1</d5p1:AddUser>
          <d5p1:EditTime>2024-03-29T08:15:25.4520048+00:00</d5p1:EditTime>
          <d5p1:EditUser>1</d5p1:EditUser>
        </d3p1:Audit>
        <d3p1:Currency>
          <d3p1:Code>sample string 2</d3p1:Code>
          <d3p1:ID>1</d3p1:ID>
          <d3p1:Lookup>sample string 5</d3p1:Lookup>
          <d3p1:Name>sample string 3</d3p1:Name>
          <d3p1:Sign>sample string 4</d3p1:Sign>
        </d3p1:Currency>
        <d3p1:CurrencyID>1</d3p1:CurrencyID>
        <d3p1:ID>1</d3p1:ID>
        <d3p1:ISO31661>1</d3p1:ISO31661>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Country>
      <d3p1:CountryID>4</d3p1:CountryID>
      <d3p1:Postcode>sample string 2</d3p1:Postcode>
      <d3p1:Street>sample string 1</d3p1:Street>
    </Address>
    <Audit xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
      <d3p1:AddTime>2024-03-29T08:15:25.4520048+00:00</d3p1:AddTime>
      <d3p1:AddUser>1</d3p1:AddUser>
      <d3p1:EditTime>2024-03-29T08:15:25.4520048+00:00</d3p1:EditTime>
      <d3p1:EditUser>1</d3p1:EditUser>
    </Audit>
    <Employee xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
      <d3p1:Key>1</d3p1:Key>
      <d3p1:Value>sample string 2</d3p1:Value>
    </Employee>
    <EmployeeID>2</EmployeeID>
    <From>2024-03-29T08:15:25.4520048+00:00</From>
    <ID>1</ID>
    <Municipality xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
      <d3p1:Key>1</d3p1:Key>
      <d3p1:Value>sample string 2</d3p1:Value>
    </Municipality>
    <MunicipalityID>3</MunicipalityID>
    <To>2024-03-29T08:15:25.4520048+00:00</To>
  </Residence>
  <Residence>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>
        <d3p1:Alpha2>sample string 3</d3p1:Alpha2>
        <d3p1:Alpha3>sample string 4</d3p1:Alpha3>
        <d3p1:Audit xmlns:d5p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
          <d5p1:AddTime>2024-03-29T08:15:25.4520048+00:00</d5p1:AddTime>
          <d5p1:AddUser>1</d5p1:AddUser>
          <d5p1:EditTime>2024-03-29T08:15:25.4520048+00:00</d5p1:EditTime>
          <d5p1:EditUser>1</d5p1:EditUser>
        </d3p1:Audit>
        <d3p1:Currency>
          <d3p1:Code>sample string 2</d3p1:Code>
          <d3p1:ID>1</d3p1:ID>
          <d3p1:Lookup>sample string 5</d3p1:Lookup>
          <d3p1:Name>sample string 3</d3p1:Name>
          <d3p1:Sign>sample string 4</d3p1:Sign>
        </d3p1:Currency>
        <d3p1:CurrencyID>1</d3p1:CurrencyID>
        <d3p1:ID>1</d3p1:ID>
        <d3p1:ISO31661>1</d3p1:ISO31661>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Country>
      <d3p1:CountryID>4</d3p1:CountryID>
      <d3p1:Postcode>sample string 2</d3p1:Postcode>
      <d3p1:Street>sample string 1</d3p1:Street>
    </Address>
    <Audit xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
      <d3p1:AddTime>2024-03-29T08:15:25.4520048+00:00</d3p1:AddTime>
      <d3p1:AddUser>1</d3p1:AddUser>
      <d3p1:EditTime>2024-03-29T08:15:25.4520048+00:00</d3p1:EditTime>
      <d3p1:EditUser>1</d3p1:EditUser>
    </Audit>
    <Employee xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
      <d3p1:Key>1</d3p1:Key>
      <d3p1:Value>sample string 2</d3p1:Value>
    </Employee>
    <EmployeeID>2</EmployeeID>
    <From>2024-03-29T08:15:25.4520048+00:00</From>
    <ID>1</ID>
    <Municipality xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
      <d3p1:Key>1</d3p1:Key>
      <d3p1:Value>sample string 2</d3p1:Value>
    </Municipality>
    <MunicipalityID>3</MunicipalityID>
    <To>2024-03-29T08:15:25.4520048+00:00</To>
  </Residence>
</ArrayOfResidence>