Endpoints - Tipos de limite de crédito

1. Exemplo do json:

[
  {
    "codigo": 1,
    "descricao": "Limite de Crédito Padrão",
    "controla_produto_limite": "S",
    "codigo_externo": "EXT123",
    "data_alteracao": "2024-09-14T20:07:55.262Z",
    "ativo": "S"
  }
]

Campos:

codigo: Código único do tipo de limite no nosso sistema.
descricao: Descrição do tipo de limite.
controla_produto_limite: Indica se controla o limite de produtos. Valores aceitos: S (Sim), N (Não)
codigo_externo: Código externo do tipo de limite
data_alteracao: Data da última alteração do registro. Não deve ser enviado no json, pois é preenchido automaticamente pelo sistema.
ativo: Indica se o tipo de limite está ativo. Valores aceitos: S (Sim), N (Não)

2. Endpoints

2.1 - Buscar tipos de limite pelo código

Endpoint: /limite-credito-tipo

Tipo: get

Parâmetros:

codigoInterno: Tipo: Inteiro. Código do limite de crédito no banco de dados do CRM.

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

2.2 - Buscar todos os tipos de limite

Endpoint: /limite-credito-tipo/todos

Tipo: get

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

2.3 - Cadastrar ou editar tipos de limite

Endpoint: /limite-credito-tipo

Tipo: post

Notas:

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

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

2.4 - Inativar um tipo de limite

Não é possível deletar um tipo de limite, apenas inativar, pois o tipo de limite pode ter vinculo com ´limites de crédito. Nesse caso, o tipo de limite continua no banco de dados porém com o status inativo.

Endpoint: /limite-credito-tipo

Tipo: delete

Parâmetros:

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

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

2.5 - Retornar os metadados dos tipos de limite

Endpoint: /tipo-limite-credito/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 dos tipos de limite de crédito.

2.6 - Pesquisar

Endpoint: /tipo-limite-credito/pesquisa

Tipo: post

Notas:

Esse endpoint retorna os tipos de limite baseado nos filtros e na ordenação informados;
Exemplo do corpo da requisição:

{
  "pagina": 1,
  "quantidadeRegistros": 10,
  "filtros": [
    {
      "campo": "descricao",
      "comparacao": "COMECA_COM",
      "valor": "C"
    }
  ],
  "ordenacao": [
    {
      "campo": "descricao",
      "ordenacao": "ASC"
    }
  ]
}

Nesse exemplo, estamos filtrando todos os tipos de limite cuja descrição começa com a letra C, ordenados por descrição;