Endpoints - Forma de parcelamento

1. Exemplo do json:

[
  {
    "codigo": 1,
    "descricao": "Parcelamento em 12x",
    "carencia_primeira_parcela": 30,
    "dia_entre_parcela": 30,
    "quantidade_parcela": 12,
    "vencimento_emissao": "S",
    "vencimento_dia_fixo": "N",
    "proximo_mes": "S",
    "vencimento_configuravel": "N",
    "dia_vencimento_fixo": 15,
    "dia_vencimento_semana": "SEGUNDA",
    "data_vencimento_fixo": "15/01/2023",
    "vencimento_dia_semana_especifico": "N",
    "proxima_semana": "S",
    "dia_tolerancia": 5,
    "valida_vencimento_data_emissao": "S",
    "codigo_externo": "EXT789",
    "data_alteracao": "2024-08-31T21:11:19.546Z",
    "ativo": "S"
  }
]

Campos:

codigo: ID único da forma de parcelamento
descricao: Descrição da forma de parcelamento
carencia_primeira_parcela: Carência para a primeira parcela em dias
dia_entre_parcela: Dias entre cada parcela
quantidade_parcela: Quantidade total de parcelas
vencimento_emissao: Indica se o vencimento é na data de emissão. Valores disponíveis: S - Sim, N - Não
vencimento_dia_fixo: Indica se o vencimento é em dia fixo. Valores disponíveis: S - Sim, N - Não
proximo_mes: Indica se o vencimento é no próximo mês. Valores disponíveis: S - Sim, N - Não
vencimento_configuravel: Indica se o vencimento é configurável. Valores disponíveis: S - Sim, N - Não
dia_vencimento_fixo: Dia fixo de vencimento
dia_vencimento_semana: Dia da semana para vencimento. Valores disponíveis: DOMINGO - domingo, SEGUNDA - segunda, TERCA - terça, QUARTA - quarta, QUINTA - quinta, SEXTA - sexta, SABADO - sábado
data_vencimento_fixo: Data fixa de vencimento
vencimento_dia_semana_especifico: Indica se o vencimento é em dia específico da semana. Valores disponíveis: S - Sim, N - Não
proxima_semana: Indica se o vencimento é na próxima semana. Valores disponíveis: S - Sim, N - Não
dia_tolerancia: Dias de tolerância para o vencimento
valida_vencimento_data_emissao: Indica se valida o vencimento com a data de emissão. Valores disponíveis: S - Sim, N - Não
codigo_externo: Código externo da forma de parcelamento
data_alteracao: Data da última alteração do registro
ativo: Indica se a forma de parcelamento está ativa Valores aceitos: S - Sim, N - Não

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

2. Endpoints

2.1 - Buscar uma forma de parcelamento pelo código

Endpoint: /forma-parcelamento

Tipo: get

Parâmetros:

codigoInterno: Tipo: Inteiro. Código da forma de parcelamento no banco de dados do CRM.
codigoExterno: Tipo: String. Código da forma de parcelamento 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 a forma de parcelamento no formato documentado na sessão Exemplo do json

2.2 - Buscar todas as formas de parcelamento

Endpoint: /forma-parcelamento/todos

Tipo: get

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

2.3 - Cadastrar ou editar forma de parcelamento

Endpoint: /forma-parcelamento

Tipo: post

Notas:

Informe no corpo da requisição o json conforme exemplo na sessão 1.
Para cadastrar uma nova forma de parcelamento não informe o campo “codigo”;
Para editar uma forma de parcelamento já existente informe o campo “codigo” com o código da forma de parcelamento que deseja editar;
Serão permitidos o cadastro/edição de até 20 itens por vez.

Resposta: Status 200 - Retorna a forma de parcelamento cadastrada, no formato documentado na sessão Exemplo do json

2.4 - Inativar uma forma de parcelamento

Não é possível deletar uma forma de parcelamento, apenas inativar, pois a forma de parcelamento pode ter vinculo com um pedido ou outros registros. Nesse caso, a forma de parcelamento continuar no banco de dados porém com o status inativo.

Endpoint: /forma-parcelamento

Tipo: delete

Parâmetros:

codigoInterno: Tipo: Inteiro. Código da forma de parcelamento no banco de dados do CRM.
codigoExterno: Tipo: String. Código da forma de parcelamento no banco de dados do sistema integrado, caso existir.

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

2.5 - Retornar os metadados da forma de parcelamento

Endpoint: /forma-parcelamento/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 da forma de parcelamento

2.6 - Pesquisar

Endpoint: /forma-parcelamento/pesquisa

Tipo: post

Notas:

Esse endpoint retorna as formas de parcelamento baseado nos filtros e na ordenação informados;
Exemplo do corpo da requisição:
{ "pagina": 1, "quantidadeRegistros": 2, "filtros": [ { "campo": "descricao", "comparacao": "CONTEM", "valor": "C" } ], "ordenacao": [ { "campo": "descricao", "ordenacao": "ASC" } ] }
Nesse exemplo, estamos filtrando todas as formas de parcelamento cuja descrição possua o texto “C”, também estamos ordenando os registros pela descrição de forma ascendente.