GET common/partners/search?name={name}&vat={vat}&street={street}&city={city}&postcode={postcode}&countryid={countryid}

Request Information

URI Parameters

Name	Type	Additional information
name	string	None.
vat	string	None.
street	string	None.
city	string	None.
postcode	string	None.
countryid	integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of Partner

Name	Type	Additional information
CompanyID	integer	None.
ID	integer	None.
Lookup	string	None.
InvoiceType	string	None.
OrganizationTypeID	integer	None.
Status	integer	None.
ClosedDate	date	None.
Details	PartnerDetails	None.
Audit	Audit	None.
Name	string	None.
Address	Address	None.
VAT	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CompanyID": 1,
    "ID": 2,
    "Lookup": "2 - sample string 6",
    "InvoiceType": "sample string 4",
    "OrganizationTypeID": 1,
    "Status": 5,
    "ClosedDate": "2024-04-26T02:31:01.7925376+00:00",
    "Details": {
      "IBAN": "sample string 1",
      "EMail": "sample string 2",
      "Phone": "sample string 3",
      "DueDays": 1
    },
    "Audit": {
      "AddUser": 1,
      "AddTime": "2024-04-26T02:31:01.8081742+00:00",
      "EditUser": 1,
      "EditTime": "2024-04-26T02:31:01.8081742+00:00"
    },
    "Name": "sample string 6",
    "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-26T02:31:01.8081742+00:00",
          "EditUser": 1,
          "EditTime": "2024-04-26T02:31:01.8081742+00:00"
        }
      }
    },
    "VAT": "sample string 7"
  },
  {
    "CompanyID": 1,
    "ID": 2,
    "Lookup": "2 - sample string 6",
    "InvoiceType": "sample string 4",
    "OrganizationTypeID": 1,
    "Status": 5,
    "ClosedDate": "2024-04-26T02:31:01.7925376+00:00",
    "Details": {
      "IBAN": "sample string 1",
      "EMail": "sample string 2",
      "Phone": "sample string 3",
      "DueDays": 1
    },
    "Audit": {
      "AddUser": 1,
      "AddTime": "2024-04-26T02:31:01.8081742+00:00",
      "EditUser": 1,
      "EditTime": "2024-04-26T02:31:01.8081742+00:00"
    },
    "Name": "sample string 6",
    "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-26T02:31:01.8081742+00:00",
          "EditUser": 1,
          "EditTime": "2024-04-26T02:31:01.8081742+00:00"
        }
      }
    },
    "VAT": "sample string 7"
  }
]

text/xml

Sample:

<ArrayOfPartner xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
  <Partner>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common" xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
      <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>
          <AddTime>2024-04-26T02:31:01.8081742+00:00</AddTime>
          <AddUser>1</AddUser>
          <EditTime>2024-04-26T02:31:01.8081742+00:00</EditTime>
          <EditUser>1</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>
    <Name xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO">sample string 6</Name>
    <VAT xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO">sample string 7</VAT>
    <Audit xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
      <d3p1:AddTime>2024-04-26T02:31:01.8081742+00:00</d3p1:AddTime>
      <d3p1:AddUser>1</d3p1:AddUser>
      <d3p1:EditTime>2024-04-26T02:31:01.8081742+00:00</d3p1:EditTime>
      <d3p1:EditUser>1</d3p1:EditUser>
    </Audit>
    <ClosedDate>2024-04-26T02:31:01.7925376+00:00</ClosedDate>
    <CompanyID>1</CompanyID>
    <Details>
      <DueDays>1</DueDays>
      <EMail>sample string 2</EMail>
      <IBAN>sample string 1</IBAN>
      <Phone>sample string 3</Phone>
    </Details>
    <ID>2</ID>
    <InvoiceType>sample string 4</InvoiceType>
    <Lookup>2 - sample string 6</Lookup>
    <OrganizationTypeID>1</OrganizationTypeID>
    <Status>5</Status>
  </Partner>
  <Partner>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common" xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
      <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>
          <AddTime>2024-04-26T02:31:01.8081742+00:00</AddTime>
          <AddUser>1</AddUser>
          <EditTime>2024-04-26T02:31:01.8081742+00:00</EditTime>
          <EditUser>1</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>
    <Name xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO">sample string 6</Name>
    <VAT xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO">sample string 7</VAT>
    <Audit xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
      <d3p1:AddTime>2024-04-26T02:31:01.8081742+00:00</d3p1:AddTime>
      <d3p1:AddUser>1</d3p1:AddUser>
      <d3p1:EditTime>2024-04-26T02:31:01.8081742+00:00</d3p1:EditTime>
      <d3p1:EditUser>1</d3p1:EditUser>
    </Audit>
    <ClosedDate>2024-04-26T02:31:01.7925376+00:00</ClosedDate>
    <CompanyID>1</CompanyID>
    <Details>
      <DueDays>1</DueDays>
      <EMail>sample string 2</EMail>
      <IBAN>sample string 1</IBAN>
      <Phone>sample string 3</Phone>
    </Details>
    <ID>2</ID>
    <InvoiceType>sample string 4</InvoiceType>
    <Lookup>2 - sample string 6</Lookup>
    <OrganizationTypeID>1</OrganizationTypeID>
    <Status>5</Status>
  </Partner>
</ArrayOfPartner>