Page Comparison

1. Exemplo do json:

[
  {
    "codigo": 1,
    "id_forma_parcelamento": 10,
    "data_inicial": "01/01/2023",
    "data_final": "31/12/2023",
    "data_vencimento": "15/01/2023",
    "codigo_externo": "EXT123",
    "data_alteracao": "01/01/2023 12:00",
  "ativo": "S"
}}
]

Campos:

• codigo: ID único da regra de vencimento

• id_forma_parcelamento: ID da regra de vencimento da forma de parcelamento

• data_inicial: Data inicial da regra de vencimento

• data_final: Data final da regra de vencimento

• data_vencimento: Data de vencimento

• codigo_externo: Código externo da regra de vencimento

• data_alteracao: Data da última alteração do registroativo: Indica se a regra de vencimento está ativa Valores aceitos: S (Sim), N (Não)

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

...

2.1 - Buscar uma regra de vencimento da forma de parcelamento pelo código

Endpoint: /forma-parcelamento-regra-vencimento

Tipo: get

Parâmetros:

• codigoInterno: Tipo: Inteiro. Código da regra de vencimento da forma de parcelamento no banco de dados do CRM.

• codigoExterno:Tipo: String.Código da regra de vencimento da forma de parcelamento no banco de dados do sistema integrado

...

2.2 - Buscar todas as regras de vencimento de formas de parcelamento

Endpoint: /forma-parcelamento-regra-vencimento/todos

Tipo: get

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

2.3 - Cadastrar ou editar regra de vencimento da forma de parcelamento

Endpoint:/forma-parcelamento-regra-vencimento

Tipo: post

Notas:

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

• Para cadastrar uma nova regra de vencimento da forma de parcelamento não informe o campo “codigo”;

• Para editar uma regra de vencimento da forma de parcelamento já existente informe o campo “codigo” com o código da regra de vencimento 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 regra de vencimento da forma de parcelamento cadastrada, no formato documentado na sessão Exemplo do json

2.4 -

...

Excluir uma regra de vencimento da forma de parcelamento

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

Endpoint:/forma-parcelamento-regra-vencimento

Tipo: delete

Parâmetros:

• codigoInterno: Tipo: Inteiro. Código da regra de vencimento da forma de parcelamento no banco de dados do CRM.

• codigoExterno:Tipo: String.Código da regra de vencimento da forma de parcelamento no banco de dados do sistema integrado, caso existir.

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

2.5 - Retornar os metadados da regra de vencimento 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 regra de vencimento da forma de parcelamento

2.6 - Pesquisar

Endpoint: /forma-parcelamento/pesquisa

Tipo: post

Notas:

• Esse endpointretorna as regras de vencimento de formas de parcelamento baseado nos filtros e na ordenação informados;

• Exemplo do corpo da requisição:

• Code Block
  { "pagina": 1, "quantidadeRegistros": 2, "filtros": [ { "campo": "descricao", "comparacao": "CONTEM", "valor": "C" } ], "ordenacao": [ { "campo": "descricao", "ordenacao": "ASC" } ] }

• Nesse exemplo, estamos filtrando todas as regras de vencimento de formas de parcelamento cuja descrição possua o texto “C”, também estamos ordenando os registros pela descrição de forma ascendente.