GET common/partners?skip={skip}&take={take}&sort={sort}&id={id}&name={name}&vat={vat}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| skip | integer |
Default value is 0 |
|
| take | integer |
Default value is 50 |
|
| sort | string |
None. |
|
| id | integer |
None. |
|
| name | string |
None. |
|
| vat | string |
None. |
Body Parameters
None.
Response Information
Resource Description
PagedDataOfPartner| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of Partner |
None. |
|
| Count | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"CompanyID": 1,
"ID": 2,
"Lookup": "2 - sample string 6",
"InvoiceType": "sample string 4",
"OrganizationTypeID": 1,
"Status": 5,
"ClosedDate": "2025-12-13T18:00:55.6092103+00:00",
"Details": {
"IBAN": "sample string 1",
"EMail": "sample string 2",
"Phone": "sample string 3",
"DueDays": 1
},
"Audit": {
"AddUser": 1,
"AddTime": "2025-12-13T18:00:55.6092103+00:00",
"EditUser": 1,
"EditTime": "2025-12-13T18:00:55.6092103+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": "2025-12-13T18:00:55.6092103+00:00",
"EditUser": 1,
"EditTime": "2025-12-13T18:00:55.6092103+00:00"
}
}
},
"VAT": "sample string 7"
},
{
"CompanyID": 1,
"ID": 2,
"Lookup": "2 - sample string 6",
"InvoiceType": "sample string 4",
"OrganizationTypeID": 1,
"Status": 5,
"ClosedDate": "2025-12-13T18:00:55.6092103+00:00",
"Details": {
"IBAN": "sample string 1",
"EMail": "sample string 2",
"Phone": "sample string 3",
"DueDays": 1
},
"Audit": {
"AddUser": 1,
"AddTime": "2025-12-13T18:00:55.6092103+00:00",
"EditUser": 1,
"EditTime": "2025-12-13T18:00:55.6092103+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": "2025-12-13T18:00:55.6092103+00:00",
"EditUser": 1,
"EditTime": "2025-12-13T18:00:55.6092103+00:00"
}
}
},
"VAT": "sample string 7"
}
],
"Count": 1
}
text/xml
Sample:
<PagedDataOfPartneru0eXouiG 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.Common">
<d2p1:Partner>
<Address>
<d2p1:City>sample string 3</d2p1:City>
<d2p1:Country>
<d2p1:Alpha2>sample string 3</d2p1:Alpha2>
<d2p1:Alpha3>sample string 4</d2p1:Alpha3>
<d2p1:Audit>
<AddTime>2025-12-13T18:00:55.6092103+00:00</AddTime>
<AddUser>1</AddUser>
<EditTime>2025-12-13T18:00:55.6092103+00:00</EditTime>
<EditUser>1</EditUser>
</d2p1:Audit>
<d2p1:Currency>
<d2p1:Code>sample string 2</d2p1:Code>
<d2p1:ID>1</d2p1:ID>
<d2p1:Lookup>sample string 5</d2p1:Lookup>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:Sign>sample string 4</d2p1:Sign>
</d2p1:Currency>
<d2p1:CurrencyID>1</d2p1:CurrencyID>
<d2p1:ID>1</d2p1:ID>
<d2p1:ISO31661>1</d2p1:ISO31661>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:Country>
<d2p1:CountryID>4</d2p1:CountryID>
<d2p1:Postcode>sample string 2</d2p1:Postcode>
<d2p1:Street>sample string 1</d2p1:Street>
</Address>
<Name>sample string 6</Name>
<VAT>sample string 7</VAT>
<d2p1:Audit>
<AddTime>2025-12-13T18:00:55.6092103+00:00</AddTime>
<AddUser>1</AddUser>
<EditTime>2025-12-13T18:00:55.6092103+00:00</EditTime>
<EditUser>1</EditUser>
</d2p1:Audit>
<d2p1:ClosedDate>2025-12-13T18:00:55.6092103+00:00</d2p1:ClosedDate>
<d2p1:CompanyID>1</d2p1:CompanyID>
<d2p1:Details>
<d2p1:DueDays>1</d2p1:DueDays>
<d2p1:EMail>sample string 2</d2p1:EMail>
<d2p1:IBAN>sample string 1</d2p1:IBAN>
<d2p1:Phone>sample string 3</d2p1:Phone>
</d2p1:Details>
<d2p1:ID>2</d2p1:ID>
<d2p1:InvoiceType>sample string 4</d2p1:InvoiceType>
<d2p1:Lookup>2 - sample string 6</d2p1:Lookup>
<d2p1:OrganizationTypeID>1</d2p1:OrganizationTypeID>
<d2p1:Status>5</d2p1:Status>
</d2p1:Partner>
<d2p1:Partner>
<Address>
<d2p1:City>sample string 3</d2p1:City>
<d2p1:Country>
<d2p1:Alpha2>sample string 3</d2p1:Alpha2>
<d2p1:Alpha3>sample string 4</d2p1:Alpha3>
<d2p1:Audit>
<AddTime>2025-12-13T18:00:55.6092103+00:00</AddTime>
<AddUser>1</AddUser>
<EditTime>2025-12-13T18:00:55.6092103+00:00</EditTime>
<EditUser>1</EditUser>
</d2p1:Audit>
<d2p1:Currency>
<d2p1:Code>sample string 2</d2p1:Code>
<d2p1:ID>1</d2p1:ID>
<d2p1:Lookup>sample string 5</d2p1:Lookup>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:Sign>sample string 4</d2p1:Sign>
</d2p1:Currency>
<d2p1:CurrencyID>1</d2p1:CurrencyID>
<d2p1:ID>1</d2p1:ID>
<d2p1:ISO31661>1</d2p1:ISO31661>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:Country>
<d2p1:CountryID>4</d2p1:CountryID>
<d2p1:Postcode>sample string 2</d2p1:Postcode>
<d2p1:Street>sample string 1</d2p1:Street>
</Address>
<Name>sample string 6</Name>
<VAT>sample string 7</VAT>
<d2p1:Audit>
<AddTime>2025-12-13T18:00:55.6092103+00:00</AddTime>
<AddUser>1</AddUser>
<EditTime>2025-12-13T18:00:55.6092103+00:00</EditTime>
<EditUser>1</EditUser>
</d2p1:Audit>
<d2p1:ClosedDate>2025-12-13T18:00:55.6092103+00:00</d2p1:ClosedDate>
<d2p1:CompanyID>1</d2p1:CompanyID>
<d2p1:Details>
<d2p1:DueDays>1</d2p1:DueDays>
<d2p1:EMail>sample string 2</d2p1:EMail>
<d2p1:IBAN>sample string 1</d2p1:IBAN>
<d2p1:Phone>sample string 3</d2p1:Phone>
</d2p1:Details>
<d2p1:ID>2</d2p1:ID>
<d2p1:InvoiceType>sample string 4</d2p1:InvoiceType>
<d2p1:Lookup>2 - sample string 6</d2p1:Lookup>
<d2p1:OrganizationTypeID>1</d2p1:OrganizationTypeID>
<d2p1:Status>5</d2p1:Status>
</d2p1:Partner>
</Data>
</PagedDataOfPartneru0eXouiG>