Agora no Bluesoft ERP, é possível incluir e consultar tipos e cláusulas de contrato de fornecimento via API
1. Gestão de Tipos de Cláusula
Permite que sistemas externos consultem e cadastrem os Tipos de Cláusula que são usados para classificar as cláusulas no ERP.
| Funcionalidade | Endpoint | Descrição |
| Consulta (GET) | /api/compras/tipos-de-clausula | Consulta a lista de Tipos de Cláusula existentes. Retorna tipoClausulaKey e nome. |
| Cadastro (POST) | /api/compras/tipos-de-clausula | Cria um novo Tipo de Cláusula de Contrato. Sucesso retorna 200 OK. |
Critérios de Validação Chave:
• O campo nome é obrigatório para o cadastro.
• Não é permitido o cadastro de um Tipo de Cláusula com o mesmo nome já existente (Validação de Unicidade).
• É necessário ter a permissão adequada para inclusão de Tipos de Cláusula.
Exemplo de Consulta:
Exemplo de Requisição (Cadastro de tipo de cláusula)
Para criar uma nova cláusula, é necessário fornecer o conteúdo (nome)
{
"nome": "LOGISTICA E FRETE"
}2. Gestão de Cláusulas de Contrato
Permite a consulta e o cadastro (criação) de novas Cláusulas de Contrato de Fornecimento, que serão vinculadas aos novos Contratos.
| Funcionalidade | Endpoint | Descrição |
| Consulta (GET) | /api/compras/clausulas-de-contrato | Consulta as cláusulas existentes. Permite filtros por clausulaContratoKey ou tipoClausulaKey. |
| Cadastro (POST) | /api/compras/clausulas-de-contrato | Cria uma nova Cláusula. Sucesso retorna 200 OK. |
Critérios de Validação Chave:
• Os campos obrigatórios para cadastro são: clausula (conteúdo formatado/HTML) e tipoClausulaKey.
• A tipoClausulaKey deve ser enviada e corresponder a um registro válido e ativo no cadastro de Tipos de Cláusula.
• O usuário deve possuir a permissão adequada para inclusão de cláusulas.
• Em caso de ausência de campos obrigatórios ou chaves inválidas, o status 400 Bad Request é retornado.
Exemplo de Consulta:
Exemplo de Requisição (Cadastro de Cláusula)
Para criar uma nova cláusula, é necessário fornecer o conteúdo (clausula) e o tipo (tipoClausulaKey).
{
"clausula": "<div>O pagamento das faturas será realizado em 30 (trinta) dias contados a partir da data de faturamento...</div>",
"tipoClausulaKey": 2
}Para conhecer mais sobre como é a utilização dessa ferramenta, clique aqui.
Para saber mais sobre a utilização das APIs do ERP, clique aqui.