Endpoints - Desconto Pontualidade

1. Exemplo do json:

Campos:

• descricao: Descrição do desconto de pontualidade

• tipo_aplicacao_calculo: Tipo de aplicação do cálculo. Valores disponíveis: (D) - Direto, (P) - Por dia

• tipo_calculo_valor: Tipo de cálculo do valor. Valores disponíveis: (N) - Normal, (V) - Valor, (M) - Montante

• tipo_juros: Tipo de juros aplicado. Valores disponíveis: (S) - Simples, (C) - Composto

• tipo_saldo: Tipo de saldo considerado. Valores disponíveis: (A) - Anterior, (O) - Original, (S) - Líquido

• tipo_prazo_pagamento: Tipo de prazo de pagamento. Valores disponíveis: (ADV) - Antes do vencimento, (AOV) - Até o vencimento, (DIV) - Dia do vencimento, (DPV) - Depois do vencimento, (S) - Sempre, (VCE) - Depois do vencimento com carência específica

• tipo_pessoa: Tipo de pessoa. Valores disponíveis: (A) - Associados, (T) - Terceiros, (S) - Todos

• desconto_extra: Indica se há desconto extra. Valores aceitos: (S) - Sim, (N) - Não

• codigo_externo: Código externo do desconto de pontualidade

• data_alteração: Data da última alteração do registro no banco de dados do CRM. Não deve ser enviado no JSON, pois é preenchido automaticamente ao salvar/editar o registro.

Todos os endpoints, com exceção do deletar, retornam o json nesse formato.

2. Endpoints

2.1 - Buscar um desconto pontualidade pelo código

Endpoint: /desconto-pontualidade

Tipo: get

Parâmetros:

• codigoInterno: Tipo: Inteiro. Código do desconto no banco de dados do CRM.

• codigoExterno: Tipo: String. Código do desconto no banco de dados do sistema integrado

Validações: É necessário informar pelo menos um dos parâmetros. Caso informado os dois o sistema prioriza o código externo.

Resposta: Status 200 - Retorna o desconto no formato documentado na sessão Exemplo do json

2.2 - Buscar todas os descontos

Endpoint: /desconto-pontualidade/todos

Tipo: get

Resposta: Status 200 - Retorna a lista de descontos no formato documentado na sessão Exemplo do json

2.3 - Cadastrar ou editar descontos

Endpoint: /desconto-pontualidade

Tipo: post

Notas:

• Informe no corpo da requisição o json conforme exemplo na sessão 1.

• Para cadastrar um novo desconto não informe o campo “codigo”;

• Para editar um desconto já existente informe o campo “codigo” com o código do desconto que deseja editar;

• O campo descrição é obrigatório;

• Serão permitidos o cadastro/edição de até 20 itens por vez.

Resposta: Status 200 - Retorna o desconto cadastrado, no formato documentado na sessão Exemplo do json

2.4 - Deletar um desconto pontualidade

Endpoint: /desconto-pontualidade

Tipo: delete

Parâmetros:

• codigoInterno: Tipo: Inteiro. Código do desconto no banco de dados do CRM.

• codigoExterno: Tipo: String. Código do desconto no banco de dados do sistema integrado, caso existir.

Resposta: Status 200 - Mensagem: Registro deletado com sucesso.

2.5 - Retornar os metadados do desconto pontualidade

Endpoint: /desconto-pontualidade/metadados

Tipo: get

Descrição: Retorna os campos do json, com as informações de tipo, tamanho máximo, se o campo é requerido, filtrável e/ou ordenável

Resposta: Status 200 - Retorna um json com as informações dos campos do desconto

2.6 - Pesquisar

Endpoint: /desconto-pontualidade/pesquisa

Tipo: post

Notas:

• Esse endpoint retorna os descontos baseado nos filtros e na ordenação informados;

• Exemplo do corpo da requisição:

• { "pagina": 1, "quantidadeRegistros": 10, "filtros": [ { "campo": "descricao", "comparacao": "CONTEM", "valor": "desconto" } ], "ordenacao": [ { "campo": "descricao", "ordenacao": "ASC" } ] }

• Nesse exemplo, estamos filtrando todas os descontos cuja descrição possua o texto “desconto”, também estamos ordenando os registros pela descrição de forma ascendente.