Tabela de conteúdos

GET - Consulta o cliente

Este método realiza a consulta de clientes cadastrados no Prosyst a partir dos parâmetros informados na URL.

Exemplo URL

Exemplo 1 (Busca por um cliente especifico)

localhost:8090/api/Cliente/consulta?Documento=7000562978

Exemplo 2 (Busca por clientes alterados após a data informada )

localhost:8090/api/Cliente/DataAlteracao?DataBusca=2020-01-01

Parâmetros do Header

authToken adquirido no Login.

Exemplos de Retorno

Sucesso

{
    "bemSucedido": true,
    "mensagemFalha": null,
    "novoCodigo": null,
    "dados": {
        "codigoCliente": 3153,
        "codigoClientePrincipal"=0,
        "descricao": "TESTE",
        "stringSituacao": "Cancelado",
        "situacao": 9,
        "estado": "SC",
        "codMunicipio": 4209102,
        "municipio": "JOINVILLE",
        "bairro": "Santo Antônio",
        "endereco": "R Da Francisca, 99999",
        "numeroEndereco": "3400",
        "cEP": "89218112",
        "fone": "",
        "cpfCnpj": "070.005.629-78",
        "inscricaoEstadual": "ISENTO",
        "dataCadastro": "2020-01-09T00:00:00.0000000-03:00",
        "codRepresentante": 0,
        "representante": null,
        "codTabelaPreco": 0,
        "inadimplente": false,
        "atividades": [
           {"codigo": 1, "descricao": "Atividade do Cliente 1"},
           {"codigo": 2, "descricao": "Atividade do Cliente 2"}
        ],
        "dataUltimoPedido": "2024-11-19T00:00:00.0000000-03:00",
        "ultimoPedido": 131,
        "clientesDoGrupo": [
            {
                "codigo": 12346,
                "cpfCnpj": "12.345.678/0002-71",
                "descricao": "EMPRESA XYZ COMERCIO DE METAIS LTDA",
                "stringSituacao": "Cancelado",
                "dataCadastro": "2020-03-10T00:00:00-03:00"
            },
            {
                "codigo": 12347,
                "cpfCnpj": "98.765.432/0001-10",
                "descricao": "EMPRESA DEF RECICLAGEM SA",
                "stringSituacao": "Ativo",
                "dataCadastro": "2019-05-20T00:00:00-03:00"
            },
            {
                "codigo": 12348,
                "cpfCnpj": "11.222.333/0001-44",
                "descricao": "EMPRESA GHI EXTRUSAO LTDA",
                "stringSituacao": "Cancelado",
                "dataCadastro": "2020-08-05T00:00:00-03:00"
            },
            {
                "codigo": 12349,
                "cpfCnpj": "55.666.777/0001-88",
                "descricao": "EMPRESA JKL INDUSTRIA E COMERCIO LTDA",
                "stringSituacao": "Ativo",
                "dataCadastro": "2019-12-12T00:00:00-03:00"
            }
        ],
        "contatos": [
            {
                "nome": "Aarão Malta",
                "email": "noreply@prosyst.com.br",
                "telefone": "",
                "EnviaNfeEmail": false,
                "RecebeEmailCobranca": true,
                "EhContatoVendas": true,
                "EhContatoCompras": false
            }
        ],
        "limiteCredito": {
            "valorCredito": 80000.00,
            "valorCarteira": 0,
            "nrPedidosCarteira": 0,
            "valorContasReceber": 0,
            "nrTitulosContasReceber": 0,
            "nrDiasAtrasoPermitido": 0,
            "maiorNrDiasAtraso": 0,
            "menorVencimento": "9999-12-31T23:59:59.9999999-03:00",
            "antecipacaoAApropriar": 0,
            "saldoCredito": 80000.00
        },
        "empresaTurismo": false,
        "observacoes":"Observações",
        "dataFundacao":"2024-09-02T00:00:00.0000000-03:00",
        "codigoPortador":2,
        "descricaoPortador":"BANCO DO BRASIL PAG"
    }
}

Falha

{
    "bemSucedido": false,
    "mensagemFalha": "Nenhum cliente encontrado!",
    "novoCodigo": null,
    "dados": null
}