Consultar propostas: CPF/CNPJ do cliente

Utilizando o termo de busca: CPF/CNPJ do cliente


<a name="endpoint"></a>

Endpoint

{warning} Observe que essa URI não está incluindo api/{sua-empresa}. Isso significa que a url deve ser: <br>https://api.ecorban.com/api/{sua-empresa}/propostas/cliente-cpf-cnpj/{cpf-cnpj-do-cliente}.

Method URI Headers
GET /propostas/cliente-cpf-cnpj/{cpf-cnpj-do-cliente}?page=1 Authorization

{info} Essa pesquisa retorna uma coleção de propostas paginadas referente ao CPF/CNPJ procurado.

<a name="endpoint"></a>

Respostas

{success} Sucesso

Código 200

Conteúdo

{
    "dados": [
        {
            "id": 1,
            "data_proposta": "06/01/2021",
            "loja": "Loja 1",
            "vendedor": "Vendedor 1",
            "vendedor_participante": null,
            "numero_proposta": "123321",
            "numero_contrato": "123321",
            "prazo": "72",
            "valor_financiado": 5000,
            "valor_divida": 0,
            "valor_liberado": 5000,
            "valor_parcela": 265.2,
            "valor_base": 5000,
            "valor_multiplicador": 150.0,
            "data_averbacao": "10/01/2021",
            "data_pagamento_cliente": "15/01/2021",
            "data_cancelamento": null,
            "data_conclusao": "20/01/2021",
            "status": {
                "nome": "Aprovado",
                "data": "10/01/2021"
            },
            "banco": {
                "nome": "BMG",
                "codigo": "318",
                "login": "user123"
            },
            "promotora": "Promotora",
            "produto": "INSS",
            "operacao": "NOVO",
            "tabela_convenio": "BMG - INSS - NOVO",
            "origem_venda": "TELEMARKETING",
            "cliente": {
                "cpf_cnpj_cliente": "123.456.789-10",
                "nome_cliente": "Cliente 1",
                "beneficio": {
                    "numero_beneficio": "123456",
                    "especie": "41",
                    "uf": "SP",
                    "salario": "1500",
                    "margem": "500",
                    "dib": "01/01/2020",
                    "ddb": "31/12/2050",
                    "dados_bancarios": {
                        "tipo_conta": "Conta Corrente",
                        "banco": "BMG",
                        "codigo_banco": "318",
                        "agencia": "0101",
                        "conta": "12345-6"
                    }
                }
            },
            "portabilidade": {
                "valor_parcela": null,
                "prazo_original": null,
                "parcelas_pagas": null,
                "parcelas_restantes": null,
                "numero_contrato": null,
                "saldo_aberto": null,
                "saldo_pago": null,
                "data_saldo_pago": null,
                "banco": {
                    "nome": null,
                    "codigo": null
                }
            }
        },
        {
            "id": 2,
            "data_proposta": "30/10/2020",
            "loja": "Matriz",
            "vendedor": "Vendedor 3",
            "vendedor_participante": null,
            "numero_proposta": "5000",
            "numero_contrato": "5000",
            "prazo": "16",
            "valor_financiado": 50000,
            "valor_divida": 5000,
            "valor_liberado": 45000,
            "valor_parcela": 1000,
            "valor_base": 45000,
            "valor_multiplicador": 1350.0,
            "data_averbacao": "05/11/2020",
            "data_pagamento_cliente": "10/11/2020",
            "data_cancelamento": null,
            "data_conclusao": "15/11/2020",
            "status": {
                "nome": "Pago",
                "data": "15/11/2020"
            },
            "banco": {
                "nome": "BMG",
                "codigo": "318",
                "login": "user456"
            },
            "promotora": null,
            "produto": "INSS",
            "operacao": "NOVO",
            "tabela_convenio": "BMG - INSS - NOVO",
            "origem_venda": "BALCÃO",
            "cliente": {
                "cpf_cnpj_cliente": "123.456.789-10",
                "nome_cliente": "Cliente 1",
                "beneficio": {
                    "numero_beneficio": null,
                    "especie": null,
                    "uf": null,
                    "salario": null,
                    "margem": null,
                    "dib": null,
                    "ddb": null,
                    "dados_bancarios": {
                        "tipo_conta": null,
                        "banco": null,
                        "codigo_banco": null,
                        "agencia": null,
                        "conta": null
                    }
                }
            },
            "portabilidade": {
                "valor_parcela": null,
                "prazo_original": null,
                "parcelas_pagas": null,
                "parcelas_restantes": null,
                "numero_contrato": null,
                "saldo_aberto": null,
                "saldo_pago": null,
                "data_saldo_pago": null,
                "banco": {
                    "nome": null,
                    "codigo": null
                }
            }
        }
    ],
    "links": {
        "first": "http://ecorban-api.test/api/cliente/propostas/cliente-cpf-cnpj/12345678910?page=1",
        "last": "http://ecorban-api.test/api/cliente/propostas/cliente-cpf-cnpj/12345678910?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Anterior",
                "active": false
            },
            {
                "url": "http://ecorban-api.test/api/cliente/propostas/cliente-cpf-cnpj/12345678910?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Próximo &raquo;",
                "active": false
            }
        ],
        "path": "http://ecorban-api.test/api/cliente/propostas/cliente-cpf-cnpj/12345678910",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

{info} Significa que a pesquisa foi realizada com sucesso porém nenhum dado foi encontrado

Código 200

Conteúdo

{
    "success": false,
    "error": {
        "message": "Ops, não encontramos nenhum registro.",
        "errors": [],
        "exception_message": "",
        "type": "Bad Request"
    }
}

{warning} URL não encontrada

Code 404

Razão URL requisitada não existe

Conteúdo

{
    "message": "Not Found"
}

{danger} Erro

Code 500

Razão Erro interno do nosso servidor

Conteúdo

{
    "message": "Server Error"
}

Caso esse erro aconteça, entre em contato com o nosso time de suporte.