1. Exemplo do json:
...
2.1 - Buscar configurações de nota pelo código
Endpoint: /nota-configuracao
Tipo: get
Parâmetros:
codigoInterno: Tipo: Inteiro. Código da configuração de nota no banco de dados do CRM.
...
2.2 - Buscar todas as configurações de nota
Endpoint: /nota-configuracao/todos
Tipo: get
Resposta: Status 200 - Retorna a lista das configurações de nota no formato documentado na sessão Exemplo do json
2.3 - Cadastrar ou editar
...
notas de configuração
Endpoint:/nota-configuracao
Tipo: post
Notas:
Informe no corpo da requisição o json conforme exemplo na sessão 1.
Para cadastrar uma configuração de nota não informe o campo “codigo”;
Para editar uma configuração de nota já existente informe o campo “codigo” com o código da configuração de nota que deseja editar;
Serão permitidos o cadastro/edição de até 20 itens por vez.
...
2.4 - Inativar uma configuração de nota
Não é possível deletar um conceitouma configuração de nota, apenas inativar, pois a configuração pode ter vinculo com pedidos/notas. Nesse caso, a configuração de nota continua no banco de dados porém com o status inativo.
Endpoint:/nota-configuracao
Tipo: delete
Parâmetros:
codigoInterno: Tipo: Inteiro. Código da configuração de nota no banco de dados do CRM.
codigoExterno:Tipo: String.Código da configuração de nota no banco de dados do sistema integrado, caso existir.
...
2.5 - Retornar os metadados das configurações de nota
Endpoint: /nota-configuracao/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 configuração de nota
2.6 - Pesquisar
Endpoint: /nota-configuracao/pesquisa
Tipo: post
Notas:
Esse endpointretorna as configurações de nota baseado nos filtros e na ordenação informados;
Exemplo do corpo da requisição:
...