Mudanças entre as edições de "Realizar atualização da integração de verbas"

Edição atual tal como às 11h52min de 17 de julho de 2026

Histórico de Alterações

Data	Quem	Comentários
17/07/2026	Renato Lima	Criação do documento

Necessidade

O cliente utiliza a funcionalidade de verbas vinculadas aos pedidos e atualmente realiza a integração dessas informações por meio de uma view disponibilizada no banco de dados, consumida por seu processo de integração com o ERP.

Com a evolução da arquitetura de integração para utilização exclusiva de APIs REST, o cliente necessita que as informações das verbas lançadas nos pedidos também sejam disponibilizadas através da API em formato JSON, eliminando a dependência de acesso direto ao banco de dados e padronizando o processo de integração.

Essa necessidade permitirá que todas as informações relacionadas ao pedido, incluindo as verbas aplicadas, sejam consumidas por um único mecanismo de integração, garantindo maior segurança, padronização e aderência à arquitetura atual do cliente.

Solução

Será realizada a evolução da API de integração de pedidos para disponibilizar, no retorno em formato JSON, as informações referentes às verbas vinculadas ao pedido.

A implementação contemplará a inclusão de uma estrutura específica para verbas dentro do objeto do pedido, contendo os mesmos dados atualmente disponibilizados pela view utilizada pelo cliente, preservando a consistência das informações já consumidas pelo processo de integração.

Com essa alteração, o integrador poderá obter todas as informações necessárias por meio da API, sem necessidade de consultas adicionais ao banco de dados, mantendo o padrão de comunicação baseado em serviços REST e simplificando a manutenção das integrações futuras.

Regras de Negócios

[RN01] – As verbas vinculadas ao pedido deverão ser disponibilizadas no retorno da API de pedidos em formato JSON.

[RN02] – O retorno das verbas deverá conter todas as informações atualmente disponibilizadas pela view utilizada pelo processo de integração, garantindo compatibilidade com a implementação existente.

[RN03] – Para pedidos que não possuírem verbas associadas, a API deverá retornar a estrutura de verbas vazia (array vazio), mantendo o padrão do contrato da API.

[RN04] – Cada verba vinculada ao pedido deverá ser retornada como um objeto individual dentro da coleção de verbas do pedido.

[RN05] – A API deverá refletir o estado atual das verbas registradas no sistema no momento da consulta, considerando inclusões, alterações e exclusões já efetivadas.

[RN06] – A inclusão das informações de verbas não deverá alterar o comportamento atual da API para consumidores que não utilizam esse novo conjunto de dados, preservando a compatibilidade com integrações existentes.

[RN07] – A estrutura JSON deverá seguir o padrão de nomenclatura e serialização já adotado pelas demais entidades disponibilizadas pela API.

[RN08] – A disponibilização das verbas deverá respeitar os mesmos critérios de autenticação, autorização e segurança aplicados aos demais dados retornados pela API.

Aprovação

Considero aprovada a documentação da funcionalidade especificada acima, e autorizo a implementação da mesma no Sistema GeoSales, em nome da Organização a qual estou vinculado.

GeoSales

Setor	Aprovado Por	Data
Desenvolvimento - GeoSales	Pessoa que aprovou	00/00/0000
Integração - GeoSales	Pessoa que aprovou	00/00/0000
Configurações - GeoSales	Pessoa que aprovou	00/00/0000

Empresa solicitante

Setor	Aprovado Por	Data
Gerente TI - Cliente	Pessoa que aprovou	00/00/0000
Gerente de Projeto - Cliente	Pessoa que aprovou	00/00/0000
Gerente Comercial - Cliente	Pessoa que aprovou	00/00/0000

@@ Linha 17: / Linha 17: @@
 == Solução ==
+Será realizada a evolução da API de integração de pedidos para disponibilizar, no retorno em formato JSON, as informações referentes às verbas vinculadas ao pedido.
+A implementação contemplará a inclusão de uma estrutura específica para verbas dentro do objeto do pedido, contendo os mesmos dados atualmente disponibilizados pela view utilizada pelo cliente, preservando a consistência das informações já consumidas pelo processo de integração.
+Com essa alteração, o integrador poderá obter todas as informações necessárias por meio da API, sem necessidade de consultas adicionais ao banco de dados, mantendo o padrão de comunicação baseado em serviços REST e simplificando a manutenção das integrações futuras.
 == Regras de Negócios ==
-'''[RN01] –'''
+'''[RN01] –''' As verbas vinculadas ao pedido deverão ser disponibilizadas no retorno da API de pedidos em formato JSON.
+'''[RN02] –''' O retorno das verbas deverá conter todas as informações atualmente disponibilizadas pela view utilizada pelo processo de integração, garantindo compatibilidade com a implementação existente.
+'''[RN03] –''' Para pedidos que não possuírem verbas associadas, a API deverá retornar a estrutura de verbas vazia (array vazio), mantendo o padrão do contrato da API.
-'''[RN02] –'''
+'''[RN04] –''' Cada verba vinculada ao pedido deverá ser retornada como um objeto individual dentro da coleção de verbas do pedido.
-'''[RN03] –'''
+'''[RN05] –''' A API deverá refletir o estado atual das verbas registradas no sistema no momento da consulta, considerando inclusões, alterações e exclusões já efetivadas.
-'''[RN04] –'''
+'''[RN06] –''' A inclusão das informações de verbas não deverá alterar o comportamento atual da API para consumidores que não utilizam esse novo conjunto de dados, preservando a compatibilidade com integrações existentes.
-'''[RN05] –'''
+'''[RN07] –''' A estrutura JSON deverá seguir o padrão de nomenclatura e serialização já adotado pelas demais entidades disponibilizadas pela API.
-'''[RN06] –'''
+'''[RN08] –''' A disponibilização das verbas deverá respeitar os mesmos critérios de autenticação, autorização e segurança aplicados aos demais dados retornados pela API.
 == Aprovação ==