Criar Proposta

POST /proposal/create

HTTP

POST /proposal/create HTTP/1.1
Host: {{URL}}
Content-Type: application/json
Accept: application/json
Authorization: Bearer {{token}}

Rota unica para crição da proposta.

Atributos para criação de proposta

Campo	Tipo	Descrição	Obrigatório
billingCode	number	Código do faturamento. Pode ser recuperado na rota de listagem de faturamentos.	✓
productCode	number	Código do produto.	✓
typeOfPayments	string	Tipo de pagamento da proposta. (Valores: DÉBITO EM CONTA ou DESCONTO EM FOLHA) Obs: De acordo com o tipo de pagamento, os campos obrigatórios podem variar.	✓
shippingType	string	Tipo de envio de contrato/assinatura. (valores: sms, whatsapp)	✓
customer	object	Este é o objeto referente aos dados do cliente.	✓
fullName	string	Nome completo do cliente. Necessário enviar ao menos duas palavras e não permite o envio de números.	✓
cpf	string	CPF do cliente, necessário ser um CPF válido.	✓
birthDate	string	Data de nascimento do cliente, o formato deverá ser AAAA-MM-DD.É necessário enviar uma data válida.	✓
gender	string	Genero do cliente, os valores validos são "Masculino" ou "Feminino".	✓
maritalStatus	string	Estado civildo cliente, os valores validos são "Solteiro", "Casado", "Separado", "Divorciado" ou "Viúvo".	✓
nationality	string	Paiz do cliente, exemplo: "Brasil".	✓
cellPhone	string	Numero do celular do cliente,o formato deverá ser (99) 99999-9999.	✓
phone	string	Numero do telefone fixo do cliente,o formato deverá ser (99) 9999-9999.	✗
email	string	Email do cliente, o email deve ser válido.	✓
profession	string	Profissão do cliente.	✓
salary	number	Salario do cliente, o formato deverá ser o valor direto em formato de inteiro, exemplo: 165200, para um salario de R$1.652,00 e o valor deve ser maior que 141200.	✓
working	boolean	Flag para informar se o cliente esta trabalhando ou não.	✗
publicServer	boolean	Flag para informar se o cliente é um funcionario publico ou não.	✗
pep	boolean	Flag para informar se o cliente éuma pessoa politicamente exposta ou não.	✗
absent	boolean	Flag para informar se o cliente esta ausente ou não.	✗
medication	boolean	Flag para informar se o cliente esta tomando algum medicamento ou não.	✗
medicationDescription	string	Caso estejá utilizando algum remedio, este campo é para enviar os nomes dos medicamentos.	✗
isIlliterate	boolean	Flag para informar se o cliente é analfabeto ou não.	✗
address	object	Este é o objeto referente aos dados de endereço do cliente.	✓
zipCode	string	Cep do endereço, o formato deverá ser somente numeros, exemplo: 70150900.	✓
address	string	Rua do endereço.	✓
number	string	Numero da residencia do endereço.	✓
neighborhood	string	Bairro do endereço.	✓
city	string	Cidade do endereço.	✓
state	string	Estado do endereço, o formato deverá ser a abreviação do estado, exemplo: MG.	✓
complement	object	Complemento do endereço	✗
discountOnSheet	object	Este é o objeto referente aos dados de pagamento para desconto em folha da proposta ou inss. O objeto é obrigatorio caso a forma de pagamento seja via desconto em folha ou inss.	✓
number	string	Numero do benefício/matrícula.	✓
specie	number	Numero da especie.	✓
type	string	Tipo do numero do benefíco, se ele é "BENEFÍCIO" ou "MATRÍCULA"	✓

Requisição

Body

{
    "billingCode": 1,
    "productCode": 46,
    "typeOfPayments": "DESCONTO EM FOLHA",
    "shippingType": "sms",
    "customer": {
        "fullName": "TESTE USER UM",
        "cpf": "12332112340",
        "birthDate": "1998-04-17",
        "gender": "Masculino",
        "maritalStatus": "Solteiro",
        "nationality": "Brasil",
        "cellPhone": "(31) 99999-9999",
        "phone": null,
        "email": "user@user.com.br",
        "profession": "Vendedores Ambulantes de Produtos Não Comestíveis",
        "salary": 141200,
        "working": true,
        "publicServer": false,
        "pep": false,
        "absent": false,
        "medication": false,
        "medicationDescription": null,
        "isIlliterate": false
    },
    "address": {
        "zipCode": "34004099",
        "address": "Rua Raimundo Ferreira Fonseca",
        "number": "87",
        "neighborhood": "Vila Madeira",
        "city": "Nova Lima",
        "state": "MG",
        "complement": null
    },
    "discountOnSheet": {
        "number": "8273463840",
        "specie": 88,
        "type": "BENEFÍCIO"
    }
}

Resposta

201

{
    "message": "Proposta: CI24 criada",
    "status": "success",
    "document": [
        {
            "id": 24,
            "identificador": "CI24",
            "id_jave": null,
            "valor": 3247,
            "cpf_cnpj_parceiro": "00000000000000",
            "id_representante": 8,
            "id_cliente": 24,
            "key_documento": null,
            "key_assinatura_requisicao": null,
            "reenvios": 0,
            "status": "NOVO",
            "alterado_por": "teste@teste.com.br",
            "alterado_em": "2024-05-28T15:30:10.053Z",
            "criado_em": "2024-05-28T15:30:10.053Z",
            "cnpj_associacao": "05183969000169",
            "cnpj_federacao": "21542071000196",
            "tipo_envio": "sms",
            "reenvio_notificacao": 0,
            "fluxo": null,
            "codigo_Associado": null,
            "id_motivacao": 168,
            "id_produto": 4,
            "id_gravacao": null,
            "id_convite": null
            "assinatura_eletronica": null,
            "codigo_faturamento": 6
        }
    ],
    "rowsAffected": [
        1
    ]
}

Errors

Código	Referência	Explicação
400	BAD REQUEST	O servidor não processará a solicitação devido a algo que é percebido como sendo um erro do cliente. Este é um erro genérico.
401	UNAUTHORIZED	O servidor não autorizou a requisição. Access Token inválido.
403	FORBIDDEN	O servidor não autorizou a requisição. O Access Token não possui permissão para acessar o recurso.
404	NOT FOUND	O servidor não encontrou o recurso ou não está disposto a divulgar sua existência.
422	UNPROCESSABLE ENTITY	O servidor não conseguiu processar as informações contidas na requisição.