enduser:erp:developer:integracao:integracaowebservice:anexos:cliente
Tabela de conteúdos
GET - Consulta anexos de clientes
Este método consulta os anexos vinculados aos cliente. Na consulta geral, os filtros informados são combinados por interseção. Sem filtros, são considerados os cadastros ativos que possuem anexos. A rota por código resolve somente o cadastro informado na URL e aceita código interno ou CPF/CNPJ, com ou sem máscara.
Exemplo URL
Consulta geral:
api/anexos/cliente
Consulta de um cliente:
api/anexos/cliente/{codigo}
Parâmetros da URL
| Nome | Tipo | Tamanho | Descrição | Obrigatório? |
|---|---|---|---|---|
| codigo | String | Código interno ou CPF/CNPJ do cliente. Utilizado somente na rota por código. | Sim, na rota por código | |
Parâmetros do Header
| Nome | Descrição |
|---|---|
| auth | Token adquirido no Login. |
| Content-Type | application/json |
Parâmetros do Body
| Nome | Tipo | Tamanho | Descrição | Obrigatório? |
|---|---|---|---|---|
| Codigos | Array de Long | Códigos internos dos clientes. | Não | |
| Documentos | Array de String | CPF/CNPJ com ou sem máscara. | Não | |
| CodigoInicial | Long | Código interno inicial da faixa. | Não | |
| CodigoFinal | Long | Código interno final da faixa. | Não | |
| Situacao | String | Situação do cadastro: ativo ou cancelado. Padrão: ativo. | Não | |
| DataAlteracaoInicial | String | Data inicial nos formatos dd-MM-yyyy ou yyyy-MM-ddTHH:mm:ss. | Não | |
| DataAlteracaoFinal | String | Data final nos formatos dd-MM-yyyy ou yyyy-MM-ddTHH:mm:ss. | Não | |
| Extensoes | Array de String | Extensões aceitas, com ou sem ponto. Exemplo: pdf ou .jpg. | Não | |
| Pagina | Integer | Número da página, iniciando em 1. Padrão: 1. | Não | |
| TamanhoPagina | Integer | Quantidade de arquivos por página, de 1 a 500. Padrão: 500. | Não | |
Os campos Codigos, Documentos, CodigoInicial, CodigoFinal, Situacao e datas de alteração não selecionam o registro na rota por código. Valores inválidos ainda podem ser recusados pela validação compartilhada.
Exemplo de Body
{
"Codigos": [15001, 15002],
"Documentos": ["11.222.333/0001-81", "11222333000181"],
"CodigoInicial": 15000,
"CodigoFinal": 16000,
"Situacao": "ativo",
"DataAlteracaoInicial": "01-01-2026",
"DataAlteracaoFinal": "31-12-2026",
"Extensoes": ["pdf"],
"Pagina": 1,
"TamanhoPagina": 50
}
Sucesso
{
"TotalRegistros": 1,
"BemSucedido": true,
"Dados": [
{
"CodigoCliente": 15001,
"NomeCliente": "CLIENTE EXEMPLO",
"Documento": "11222333000181",
"NomeArquivo": "contrato.pdf",
"Extensao": ".pdf",
"ConteudoBase64": "JVBERi0xLjQ..."
}
]
}
enduser/erp/developer/integracao/integracaowebservice/anexos/cliente.txt · Última modificação: por 127.0.0.1