GET payroll/residences?skip={skip}&take={take}&from={from}&to={to}&employee={employee}&vat={vat}&sort={sort}

Request Information

URI Parameters

Name	Type	Additional information
skip	integer	Default value is 0
take	integer	Default value is 50
from	date	None.
to	date	None.
employee	string	None.
vat	string	None.
sort	string	None.

Body Parameters

None.

Response Information

Resource Description

PagedDataOfResidence

Name	Description	Type	Additional information
Data		Collection of Residence	None.
Count		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": [
    {
      "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-04-26T11:13:59.4253635+00:00",
            "EditUser": 1,
            "EditTime": "2024-04-26T11:13:59.4253635+00:00"
          }
        }
      },
      "MunicipalityID": 3,
      "Municipality": {
        "Key": 1,
        "Value": "sample string 2"
      },
      "From": "2024-04-26T11:13:59.4253635+00:00",
      "To": "2024-04-26T11:13:59.4253635+00:00",
      "Audit": {
        "AddUser": 1,
        "AddTime": "2024-04-26T11:13:59.4253635+00:00",
        "EditUser": 1,
        "EditTime": "2024-04-26T11:13:59.4253635+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-04-26T11:13:59.4253635+00:00",
            "EditUser": 1,
            "EditTime": "2024-04-26T11:13:59.4253635+00:00"
          }
        }
      },
      "MunicipalityID": 3,
      "Municipality": {
        "Key": 1,
        "Value": "sample string 2"
      },
      "From": "2024-04-26T11:13:59.4253635+00:00",
      "To": "2024-04-26T11:13:59.4253635+00:00",
      "Audit": {
        "AddUser": 1,
        "AddTime": "2024-04-26T11:13:59.4253635+00:00",
        "EditUser": 1,
        "EditTime": "2024-04-26T11:13:59.4253635+00:00"
      }
    }
  ],
  "Count": 1
}

text/xml

Sample:

<PagedDataOfResidenceJWMx1l1K xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
  <Count>1</Count>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Payroll">
    <d2p1:Residence>
      <d2p1:Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>
          <d4p1:Alpha2>sample string 3</d4p1:Alpha2>
          <d4p1:Alpha3>sample string 4</d4p1:Alpha3>
          <d4p1:Audit>
            <AddTime>2024-04-26T11:13:59.4253635+00:00</AddTime>
            <AddUser>1</AddUser>
            <EditTime>2024-04-26T11:13:59.4253635+00:00</EditTime>
            <EditUser>1</EditUser>
          </d4p1:Audit>
          <d4p1:Currency>
            <d4p1:Code>sample string 2</d4p1:Code>
            <d4p1:ID>1</d4p1:ID>
            <d4p1:Lookup>sample string 5</d4p1:Lookup>
            <d4p1:Name>sample string 3</d4p1:Name>
            <d4p1:Sign>sample string 4</d4p1:Sign>
          </d4p1:Currency>
          <d4p1:CurrencyID>1</d4p1:CurrencyID>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:ISO31661>1</d4p1:ISO31661>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:Country>
        <d4p1:CountryID>4</d4p1:CountryID>
        <d4p1:Postcode>sample string 2</d4p1:Postcode>
        <d4p1:Street>sample string 1</d4p1:Street>
      </d2p1:Address>
      <d2p1:Audit>
        <AddTime>2024-04-26T11:13:59.4253635+00:00</AddTime>
        <AddUser>1</AddUser>
        <EditTime>2024-04-26T11:13:59.4253635+00:00</EditTime>
        <EditUser>1</EditUser>
      </d2p1:Audit>
      <d2p1:Employee>
        <Key>1</Key>
        <Value>sample string 2</Value>
      </d2p1:Employee>
      <d2p1:EmployeeID>2</d2p1:EmployeeID>
      <d2p1:From>2024-04-26T11:13:59.4253635+00:00</d2p1:From>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Municipality>
        <Key>1</Key>
        <Value>sample string 2</Value>
      </d2p1:Municipality>
      <d2p1:MunicipalityID>3</d2p1:MunicipalityID>
      <d2p1:To>2024-04-26T11:13:59.4253635+00:00</d2p1:To>
    </d2p1:Residence>
    <d2p1:Residence>
      <d2p1:Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>
          <d4p1:Alpha2>sample string 3</d4p1:Alpha2>
          <d4p1:Alpha3>sample string 4</d4p1:Alpha3>
          <d4p1:Audit>
            <AddTime>2024-04-26T11:13:59.4253635+00:00</AddTime>
            <AddUser>1</AddUser>
            <EditTime>2024-04-26T11:13:59.4253635+00:00</EditTime>
            <EditUser>1</EditUser>
          </d4p1:Audit>
          <d4p1:Currency>
            <d4p1:Code>sample string 2</d4p1:Code>
            <d4p1:ID>1</d4p1:ID>
            <d4p1:Lookup>sample string 5</d4p1:Lookup>
            <d4p1:Name>sample string 3</d4p1:Name>
            <d4p1:Sign>sample string 4</d4p1:Sign>
          </d4p1:Currency>
          <d4p1:CurrencyID>1</d4p1:CurrencyID>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:ISO31661>1</d4p1:ISO31661>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:Country>
        <d4p1:CountryID>4</d4p1:CountryID>
        <d4p1:Postcode>sample string 2</d4p1:Postcode>
        <d4p1:Street>sample string 1</d4p1:Street>
      </d2p1:Address>
      <d2p1:Audit>
        <AddTime>2024-04-26T11:13:59.4253635+00:00</AddTime>
        <AddUser>1</AddUser>
        <EditTime>2024-04-26T11:13:59.4253635+00:00</EditTime>
        <EditUser>1</EditUser>
      </d2p1:Audit>
      <d2p1:Employee>
        <Key>1</Key>
        <Value>sample string 2</Value>
      </d2p1:Employee>
      <d2p1:EmployeeID>2</d2p1:EmployeeID>
      <d2p1:From>2024-04-26T11:13:59.4253635+00:00</d2p1:From>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Municipality>
        <Key>1</Key>
        <Value>sample string 2</Value>
      </d2p1:Municipality>
      <d2p1:MunicipalityID>3</d2p1:MunicipalityID>
      <d2p1:To>2024-04-26T11:13:59.4253635+00:00</d2p1:To>
    </d2p1:Residence>
  </Data>
</PagedDataOfResidenceJWMx1l1K>