POST api/Clientes/Pesquisar

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CNPJ	string	None.
CPF	string	None.
NrContrCliOrigem	string	None.
NrContrCli	string	None.
TemVinculados	boolean	None.
UltNrContrCli	string	None.
Ordem	OrdemRegistrosClientes	None.
CpfCnpj	string	None.
Nome	string	None.
Ddd	string	None.
Telefone	string	None.
CdCli	string	None.
RestricaoVisualizacaoClientes	RestricaoVisualizacaoCliente	None.
NrContrCliUsuaLog	string	None.
NrContrCliRepr	string	None.
Endereco	string	None.
Cidade	string	None.
CdTpCli	string	None.
Uf	string	None.
OmitirTipoClientesFixos	boolean	None.
Codigo	string	None.
Situacao	string	None.
NomeCpfCnpj	string	None.
NrContrCliDif	string	None.
NmCli	string	None.
Email	string	None.
QtdRegistros	integer	None.
IdFiltros	string	None.
PageSize	integer	None.
PageNumber	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CNPJ": "sample string 1",
  "CPF": "sample string 2",
  "NrContrCliOrigem": "sample string 3",
  "NrContrCli": "sample string 4",
  "TemVinculados": true,
  "UltNrContrCli": "sample string 5",
  "Ordem": 0,
  "CpfCnpj": "sample string 6",
  "Nome": "sample string 7",
  "Ddd": "sample string 8",
  "Telefone": "sample string 9",
  "CdCli": "sample string 10",
  "RestricaoVisualizacaoClientes": 0,
  "NrContrCliUsuaLog": "sample string 11",
  "NrContrCliRepr": "sample string 12",
  "Endereco": "sample string 13",
  "Cidade": "sample string 14",
  "CdTpCli": "sample string 15",
  "Uf": "sample string 16",
  "OmitirTipoClientesFixos": true,
  "Codigo": "sample string 18",
  "Situacao": "sample string 19",
  "NomeCpfCnpj": "sample string 20",
  "NrContrCliDif": "sample string 21",
  "NmCli": "sample string 22",
  "Email": "sample string 23",
  "QtdRegistros": 24,
  "IdFiltros": "sample string 25",
  "PageSize": 26,
  "PageNumber": 27
}

application/xml, text/xml

Sample:

<ClienteFiltros xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VanRooy.CallSolution.Shared.FiltrosPesquisa">
  <IdFiltros xmlns="http://schemas.datacontract.org/2004/07/VanRooy.CallSolution.Shared.AbstractClasses">sample string 25</IdFiltros>
  <PageNumber xmlns="http://schemas.datacontract.org/2004/07/VanRooy.CallSolution.Shared.AbstractClasses">27</PageNumber>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/VanRooy.CallSolution.Shared.AbstractClasses">26</PageSize>
  <QtdRegistros xmlns="http://schemas.datacontract.org/2004/07/VanRooy.CallSolution.Shared.AbstractClasses">24</QtdRegistros>
  <CNPJ>sample string 1</CNPJ>
  <CPF>sample string 2</CPF>
  <CdCli>sample string 10</CdCli>
  <CdTpCli>sample string 15</CdTpCli>
  <Cidade>sample string 14</Cidade>
  <Codigo>sample string 18</Codigo>
  <CpfCnpj>sample string 6</CpfCnpj>
  <Ddd>sample string 8</Ddd>
  <Email>sample string 23</Email>
  <Endereco>sample string 13</Endereco>
  <NmCli>sample string 22</NmCli>
  <Nome>sample string 7</Nome>
  <NomeCpfCnpj>sample string 20</NomeCpfCnpj>
  <NrContrCli>sample string 4</NrContrCli>
  <NrContrCliDif>sample string 21</NrContrCliDif>
  <NrContrCliOrigem>sample string 3</NrContrCliOrigem>
  <NrContrCliRepr>sample string 12</NrContrCliRepr>
  <NrContrCliUsuaLog>sample string 11</NrContrCliUsuaLog>
  <OmitirTipoClientesFixos>true</OmitirTipoClientesFixos>
  <Ordem>NrContrCli</Ordem>
  <RestricaoVisualizacaoClientes>SemRestricao</RestricaoVisualizacaoClientes>
  <Situacao>sample string 19</Situacao>
  <Telefone>sample string 9</Telefone>
  <TemVinculados>true</TemVinculados>
  <Uf>sample string 16</Uf>
  <UltNrContrCli>sample string 5</UltNrContrCli>
</ClienteFiltros>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClienteFiltros'.

Response Information

Resource Description

Collection of ClienteQR

Name	Type	Additional information
NrContrCli	string	None.
CdCli	string	None.
NmCli	string	None.
Fantasia	string	None.
Cidade	string	None.
CPF	string	None.
CNPJ	string	None.
UF	string	None.
CdCondPag	string	None.
CdFrmPag	string	None.
CdNatOp	string	None.
CdOp	string	None.
TpFrete	string	None.
CdCtCorr	string	None.
CdModEnt	string	None.
CdTransp	string	None.
CdTbPrc	string	None.
CdTerritorio	string	None.
Suframa	string	None.
FisJur	string	None.
OptanteSimples	string	None.
Cep	string	None.
CdSegmento	string	None.
InscEst	string	None.
NrContrCliSub	string	None.
DescFrmPag	string	None.
NrContrCliExp	string	None.
CpfCnpj	string	None.
CdCidade	string	None.
CdTpClienteFatur	string	None.
StatusCli	string	None.
DddTelefone1	string	None.
DddTelefone2	string	None.
DddTelefone3	string	None.
EnderecoCompleto	string	None.
Emails	string	None.
DtNasc	date	None.
EnderecoGoogleMaps	string	None.
CorStatusCli	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "NrContrCli": "sample string 1",
    "CdCli": "sample string 2",
    "NmCli": "sample string 3",
    "Fantasia": "sample string 4",
    "Cidade": "sample string 5",
    "CPF": "sample string 6",
    "CNPJ": "sample string 7",
    "UF": "sample string 8",
    "CdCondPag": "sample string 9",
    "CdFrmPag": "sample string 10",
    "CdNatOp": "sample string 11",
    "CdOp": "sample string 12",
    "TpFrete": "sample string 13",
    "CdCtCorr": "sample string 14",
    "CdModEnt": "sample string 15",
    "CdTransp": "sample string 16",
    "CdTbPrc": "sample string 17",
    "CdTerritorio": "sample string 18",
    "Suframa": "sample string 19",
    "FisJur": "sample string 20",
    "OptanteSimples": "sample string 21",
    "Cep": "sample string 22",
    "CdSegmento": "sample string 23",
    "InscEst": "sample string 24",
    "NrContrCliSub": "sample string 25",
    "DescFrmPag": "sample string 26",
    "NrContrCliExp": "sample string 27",
    "CpfCnpj": "sample string 28",
    "CdCidade": "sample string 29",
    "CdTpClienteFatur": "sample string 30",
    "StatusCli": "sample string 31",
    "DddTelefone1": "sample string 32",
    "DddTelefone2": "sample string 33",
    "DddTelefone3": "sample string 34",
    "EnderecoCompleto": "sample string 35",
    "Emails": "sample string 36",
    "DtNasc": "2025-12-11T07:50:51.0192827-03:00",
    "EnderecoGoogleMaps": "sample string 37",
    "CorStatusCli": 1
  },
  {
    "NrContrCli": "sample string 1",
    "CdCli": "sample string 2",
    "NmCli": "sample string 3",
    "Fantasia": "sample string 4",
    "Cidade": "sample string 5",
    "CPF": "sample string 6",
    "CNPJ": "sample string 7",
    "UF": "sample string 8",
    "CdCondPag": "sample string 9",
    "CdFrmPag": "sample string 10",
    "CdNatOp": "sample string 11",
    "CdOp": "sample string 12",
    "TpFrete": "sample string 13",
    "CdCtCorr": "sample string 14",
    "CdModEnt": "sample string 15",
    "CdTransp": "sample string 16",
    "CdTbPrc": "sample string 17",
    "CdTerritorio": "sample string 18",
    "Suframa": "sample string 19",
    "FisJur": "sample string 20",
    "OptanteSimples": "sample string 21",
    "Cep": "sample string 22",
    "CdSegmento": "sample string 23",
    "InscEst": "sample string 24",
    "NrContrCliSub": "sample string 25",
    "DescFrmPag": "sample string 26",
    "NrContrCliExp": "sample string 27",
    "CpfCnpj": "sample string 28",
    "CdCidade": "sample string 29",
    "CdTpClienteFatur": "sample string 30",
    "StatusCli": "sample string 31",
    "DddTelefone1": "sample string 32",
    "DddTelefone2": "sample string 33",
    "DddTelefone3": "sample string 34",
    "EnderecoCompleto": "sample string 35",
    "Emails": "sample string 36",
    "DtNasc": "2025-12-11T07:50:51.0192827-03:00",
    "EnderecoGoogleMaps": "sample string 37",
    "CorStatusCli": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfClienteQR xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VanRooy.CallSolution.Shared.QueryResults">
  <ClienteQR>
    <CNPJ>sample string 7</CNPJ>
    <CPF>sample string 6</CPF>
    <CdCidade>sample string 29</CdCidade>
    <CdCli>sample string 2</CdCli>
    <CdCondPag>sample string 9</CdCondPag>
    <CdCtCorr>sample string 14</CdCtCorr>
    <CdFrmPag>sample string 10</CdFrmPag>
    <CdModEnt>sample string 15</CdModEnt>
    <CdNatOp>sample string 11</CdNatOp>
    <CdOp>sample string 12</CdOp>
    <CdSegmento>sample string 23</CdSegmento>
    <CdTbPrc>sample string 17</CdTbPrc>
    <CdTerritorio>sample string 18</CdTerritorio>
    <CdTpClienteFatur>sample string 30</CdTpClienteFatur>
    <CdTransp>sample string 16</CdTransp>
    <Cep>sample string 22</Cep>
    <Cidade>sample string 5</Cidade>
    <CorStatusCli>1</CorStatusCli>
    <CpfCnpj>sample string 28</CpfCnpj>
    <DddTelefone1>sample string 32</DddTelefone1>
    <DddTelefone2>sample string 33</DddTelefone2>
    <DddTelefone3>sample string 34</DddTelefone3>
    <DescFrmPag>sample string 26</DescFrmPag>
    <DtNasc>2025-12-11T07:50:51.0192827-03:00</DtNasc>
    <Emails>sample string 36</Emails>
    <EnderecoCompleto>sample string 35</EnderecoCompleto>
    <EnderecoGoogleMaps>sample string 37</EnderecoGoogleMaps>
    <Fantasia>sample string 4</Fantasia>
    <FisJur>sample string 20</FisJur>
    <InscEst>sample string 24</InscEst>
    <NmCli>sample string 3</NmCli>
    <NrContrCli>sample string 1</NrContrCli>
    <NrContrCliExp>sample string 27</NrContrCliExp>
    <NrContrCliSub>sample string 25</NrContrCliSub>
    <OptanteSimples>sample string 21</OptanteSimples>
    <StatusCli>sample string 31</StatusCli>
    <Suframa>sample string 19</Suframa>
    <TpFrete>sample string 13</TpFrete>
    <UF>sample string 8</UF>
  </ClienteQR>
  <ClienteQR>
    <CNPJ>sample string 7</CNPJ>
    <CPF>sample string 6</CPF>
    <CdCidade>sample string 29</CdCidade>
    <CdCli>sample string 2</CdCli>
    <CdCondPag>sample string 9</CdCondPag>
    <CdCtCorr>sample string 14</CdCtCorr>
    <CdFrmPag>sample string 10</CdFrmPag>
    <CdModEnt>sample string 15</CdModEnt>
    <CdNatOp>sample string 11</CdNatOp>
    <CdOp>sample string 12</CdOp>
    <CdSegmento>sample string 23</CdSegmento>
    <CdTbPrc>sample string 17</CdTbPrc>
    <CdTerritorio>sample string 18</CdTerritorio>
    <CdTpClienteFatur>sample string 30</CdTpClienteFatur>
    <CdTransp>sample string 16</CdTransp>
    <Cep>sample string 22</Cep>
    <Cidade>sample string 5</Cidade>
    <CorStatusCli>1</CorStatusCli>
    <CpfCnpj>sample string 28</CpfCnpj>
    <DddTelefone1>sample string 32</DddTelefone1>
    <DddTelefone2>sample string 33</DddTelefone2>
    <DddTelefone3>sample string 34</DddTelefone3>
    <DescFrmPag>sample string 26</DescFrmPag>
    <DtNasc>2025-12-11T07:50:51.0192827-03:00</DtNasc>
    <Emails>sample string 36</Emails>
    <EnderecoCompleto>sample string 35</EnderecoCompleto>
    <EnderecoGoogleMaps>sample string 37</EnderecoGoogleMaps>
    <Fantasia>sample string 4</Fantasia>
    <FisJur>sample string 20</FisJur>
    <InscEst>sample string 24</InscEst>
    <NmCli>sample string 3</NmCli>
    <NrContrCli>sample string 1</NrContrCli>
    <NrContrCliExp>sample string 27</NrContrCliExp>
    <NrContrCliSub>sample string 25</NrContrCliSub>
    <OptanteSimples>sample string 21</OptanteSimples>
    <StatusCli>sample string 31</StatusCli>
    <Suframa>sample string 19</Suframa>
    <TpFrete>sample string 13</TpFrete>
    <UF>sample string 8</UF>
  </ClienteQR>
</ArrayOfClienteQR>