Ferramentas do usuário

Ferramentas do site


enduser:erp:developer:integracao:integracaowebservice:anexos:cliente

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

NomeTipoTamanhoDescriçãoObrigatório?
codigoStringCódigo interno ou CPF/CNPJ do cliente. Utilizado somente na rota por código.Sim, na rota por código

Parâmetros do Header

NomeDescrição
authToken adquirido no Login.
Content-Typeapplication/json

Parâmetros do Body

NomeTipoTamanhoDescriçãoObrigatório?
CodigosArray de LongCódigos internos dos clientes.Não
DocumentosArray de StringCPF/CNPJ com ou sem máscara.Não
CodigoInicialLongCódigo interno inicial da faixa.Não
CodigoFinalLongCódigo interno final da faixa.Não
SituacaoStringSituação do cadastro: ativo ou cancelado. Padrão: ativo.Não
DataAlteracaoInicialStringData inicial nos formatos dd-MM-yyyy ou yyyy-MM-ddTHH:mm:ss.Não
DataAlteracaoFinalStringData final nos formatos dd-MM-yyyy ou yyyy-MM-ddTHH:mm:ss.Não
ExtensoesArray de StringExtensões aceitas, com ou sem ponto. Exemplo: pdf ou .jpg.Não
PaginaIntegerNúmero da página, iniciando em 1. Padrão: 1.Não
TamanhoPaginaIntegerQuantidade 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

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki