Você está na página 1de 32

Levantamento de escopo técnico

Integração CPJ
Levantamento de Escopo Técnico

Nelson Wilians

Data: 09/03/2021

Versão Responsável Data


1.0 Vinicyus Sanches 28/10/2020
2.0 Marco Soares 09/03/2021
2.1 Marco Soares 15/03/2021
2.2 Marco Soares 05/05/2021
2.3 Marco Soares 31/05/2021
3.0 Marco Soares 13/08/2021
4.0 Marco Soares 18/08/2021

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 1 de 32
Levantamento de escopo técnico

Sumário
1. Introdução ........................................................................................................ 3
1.1. O que é o CPJ .................................................................................... 3
2. Cenário previsto .............................................................................................. 3
3. Processo Técnico ............................................................................................ 4
 Regra de validação cruzada ............................................................... 6
 Processo de integração ...................................................................... 7
 Processo de integração: compra e venda .......................................... 9
 Processo de vendas ......................................................................... 10
 Processo de compras ....................................................................... 11
 Processo de integração de parceiro de negócios ............................ 12
 Processo de integração de itens ...................................................... 13
4. Premissas para início de desenvolvimento – PENDENTE DE
LEVANTAMENTO COM EQUIPE TÉCNICA CPJ. AGUARDANDO
APROVAÇÃO – PREÂMBULO IRÁ CRIAR API PARA A INTEGRAÇÃO. ... 14

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 2 de 32
Levantamento de escopo técnico

1. Introdução

O CPJ é um ERP de controle processual, utilizado pela Nelson Willians, e que efetua a gestão dos
faturamentos e pagamentos em face desses processos, a nível de informação financeira (gestão
financeira é feita no SAP Business One). E diante da necessidade de se integrar as informações
com o SAP Business One, é necessário especificar e detalhar o processo para que os
PAGAMENTOS e RECEBIMENTOS sejam exportados para que a efetivação seja efetuada, pois o
CPJ não é um ERP fiscal/financeiro/contábil.

A integração será efetuada via API, e os seguintes documentos serão gerados no SAP, com as
informações inseridas pelos usuários no CPJ:

 PEDIDO DE COMPRAS;
 PEDIDO DE VENDAS.

O processo, após a inserção dos documentos, segue processo padrão do SAP Business One.

A partir do input desses documentos no SAP, os demais processos serão efetuados,


manualmente, pelos usuários determinados.

1.1. O que é o CPJ


“É um sistema de gestão do ambiente jurídico com controle processual, agenda, gerador de
relatórios e documentos, acompanhamento financeiro com módulos integrados de conta
corrente (custas/honorários), contas a pagar e receber (fluxo de caixa e mapa de resultados) e
contas bancárias, também é possível controlar os depósitos judiciais e recursais. O usuário pode
criar campos na ficha de processos conforme a necessidade de cada ação. O sistema fornece
desde estatísticas sobre a quantificação de processos por ações, matérias, eventos e fases
processuais, até mapeamento por análise de risco, permitindo obter-se estimativa dos
montantes envolvidos nas ações. “. ConJur, novembro de 2020.

https://www.conjur.com.br/2015-jun-24/conheca-softwares-juridicos-usados-advogadosn

2. Cenário previsto

O processo de compras e vendas serão gerados com base nas informações enviadas pelo CPJ.
Os cadastros de parceiros de negócio e itens terão origem no SAP.
A baixa dos documentos de “Contas a Receber” e “Contas a pagar” serão efetuados via
integração bancária (Add-On Integration Bank, no Sap Business One) ou baixas manuais.

O integrador deverá ser preparado de forma que funcione sem problemas no Agendador de
tarefas do Windows.
O sistema funcionará no mínimo de 5 em 5 minutos.

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 3 de 32
Levantamento de escopo técnico

Fluxograma marco processo de integração

Para controle de status, será criada uma tabela de logs. A integração irá inserir as mensagens de
erro ou sucesso, assim como identificador único, ID de processo (vide tabela abaixo), status de
erro ou sucesso e data de integração. Para buscar novos dados no CPJ, essa tabela deverá ser
utilizada como filtro a partir do status de integração e identificador único.

ID de processo Processo
0 Enviar parceiro de negócios
1 Cobrança
2 Pagamento
3 Enviar itens
4 Dimensão / Centro de custo (Un. Negócios e Núcleo)
5 Dimensão Clientes
6 Contratos – Projeto Financeiro (SAP)

3. Processo Técnico
Vamos iniciar o detalhamento técnico da integração, inicialmente informando a origem das
informações:

 SAP – Terão origem no SAP as seguintes informações:


o Cadastro de Clientes – São feitos manualmente pelo financeiro, após conclusão
do processo em sistema de CRM;

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 4 de 32
Levantamento de escopo técnico

o Cadastro de Fornecedores – Serão efetuados manualmente no SAP, mediante


necessidade ou oriundos do sistema NIMBI (via integração);
o Cadastro de Itens – Serão efetuados no SAP mediante necessidade;
o Baixa de Contas a Pagar – Efetuada no SAP, via integração bancária ou
manualmente;
o Baixa de Contas a Receber – Efetuada no SAP, via integração bancária ou
manualmente;
o Cadastro de Centro de Custo – Referente a regra de validação cruzada, os itens
abaixo terão origem no SAP:
 Filial Fiscal (Cadastro de Filiais do SAP);
 Centro de custos da dimensão Unidade de Negócios;
 Centro de Custo da dimensão Núcleo.
OBSERVAÇÃO: INFORMAÇÕES DISPONÍVEIS NA API DO SAP.
 CPJ – Terão origem no CPJ as seguintes informações:
o Pedido de Faturamento – Inserido no CPJ, integrando no SAP;
o Pedido de Pagamentos – Inserido no CPJ, integrando no SAP;
o Cadastro de Centro de Custo – Referente a regra de validação cruzada, os itens
abaixo terão origem no CPJ:
 Centro de custos da dimensão Cliente;
 Contrato (Projeto Financeiro no SAP).

Quando o pedido for inserido no CPJ (tanto pedido de compras como pedido de vendas) via
integração, será inserido no SAP. Após a inserção desses documentos, o processo será efetivado
manualmente pelo usuário com acesso ao SAP, até a baixa do financeiro (tanto CP quanto CR,
que pode ser feito manualmente ou via integração bancária).

Após o retorno bancário, com a confirmação do pagamento, será necessário informar ao CPJ a
confirmação da baixa e o comprovante (no caso de contas a pagar). Com isso, o usuário que
acessa o CPJ pode verificar quando foi efetuado o pagamento e ter acesso ao comprovante.

Em relação aos comprovantes, a equipe de desenvolvimento da Invent (fornecedor do add-on


de integração bancária) fará uma customização para que os comprovantes sejam gerados de
forma que seja possível identificar, pelo nome do arquivo, a qual documento do CPJ está
vinculado.

O SAP enviará o código da forma de pagamento utilizado para o CPJ após ocorrer a integração
do processo de compra e venda, caso o CPJ tenha campo para informar a FORMA DE
PAGAMENTO.

Ao efetuar o cadastro de um novo cliente, esse deverá ser feito no SAP, e via integração, e os
processos são gerados no CPJ.

Quando os pedidos forem inseridos no SAP, além das informações básicas, serão obrigatórias:

 Informações de Dimensões x Centros de Custos;


 Cód. do Projeto Financeiro (contrato).

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 5 de 32
Levantamento de escopo técnico

Essas informações são necessárias para as análises e relatórios, assim como base para apuração
das comissões.

 Regra de validação cruzada


Teremos os seguintes níveis de centro de custo para geração da regra de validação cruzada:

 Dimensão Unidade de Negócio


 Dimensão Núcleo
 Dimensão Cliente

E além das dimensões de centros de custos, teremos:

 Filial Fiscal;
 Contrato (Projeto Financeiro SAP).

A filial será a filial fiscal do sistema SAP, onde serão filiais com CNPJ próprio da Nelson Willians.

As unidades de negócio são as filiais (onde eles legalmente estão constituídos) ou as unidades
de negócio em cidades que a empresa possui uma unidade, que por questões estratégicas, ainda
não possuem uma filial legal. Cada filial poderá ter N unidades de negócio.

Os núcleos são as áreas de negócio jurídico nas quais o escritório atua. Cada unidade de negócio
poderá ter N núcleos.

O cliente é o cliente atendido pela Nelson Willians. Exemplo são os clientes Banco do Brasil e
Riachuelo. Um núcleo poderá ter N clientes (a nível da dimensão Cliente, e não ao cadastro de
PN).

O contrato será o projeto financeiro do SAP, por onde é feito o controle de despesas x receitas.
Um único cliente poderá ter mais de um contrato.

Unidade de Negócio, Núcleo e Cliente são centros de custos das dimensões do SAP. Contrato
será Projeto no SAP.

OBSERVAÇÃO 1: PROCESSO DEPENDE DA APROVAÇÃO DE OUTRO DESENVOLVIMENTO, QUE


AINDA ESTÁ EM ANÁLISE PELA EQUIPE FUNCIONAL E EQUIPE NELSON WILLIANS. CASO O
DESENVOLVIMENTO NÃO SEJA APROVADO, ESSE TÓPICO NÃO SERÁ CONSIDERADO NO
DESENVOLVIMENTO DESSA ESPECIFICAÇÃO.

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 6 de 32
Levantamento de escopo técnico

 Processo de integração
Integração de cadastro cruzado: CPJ > SAP

Essa integração terá por objetivo realizar a busca das informações das dimensões de centros
de custos, necessárias também para a regra de validação cruzada:

Para isso, o SAP deverá disponibilizar API com as informações de FILIAL + UNIDADE DE
NEGÓCIO + NÚCLEO, contendo os campos:

Campo SAP Descrição Campo CPJ Descrição


OBPL.BPLId Cód. Filial legal
OBPL.BPLName ID único CPJ
OBPL.Address Endereço da Filial
OPRC.DimCode Cód. Dimensão – Un. Negócio
OPRC.PrcCode Cód. C. de Custo – Un. Negócio
OPRC.DimCode Cód. Dimensão – Núcleo
OPRC.PrcCode Cód. C. de Custo – Núcleo
Status
ID SAP
Mensagem

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 7 de 32
Levantamento de escopo técnico

Para isso, o CPJ deverá disponibilizar API com as informações da dimensão Cliente + Contrato
(Projeto Financeiro SAP), contendo os campos:

Nome unidade de negócio


ID unidade de negócio
Nome núcleo
ID núcleo
Nome Cliente
ID Cliente
Status
ID SAP
Mensagem
Os sistemas deverão trazer somente dados ainda não cadastrados, para isso deverá ser
permitida a escrita nos campos "status, ID (SAP/CPJ) , mensagem".

Os campos serão preenchidos da seguinte forma:

Status Valores válidos


A Aguardando integração
E Erro
I Integrando
P Processado
O campo mensagem deverá conter "sucesso" ou a mensagem de erro.

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 8 de 32
Levantamento de escopo técnico

Para todos os novos casos, o campo de status deverá ser carregado com A, sendo
posteriormente atualizado pela integração.

O integrador irá inserir nos sistemas as informações, apresentando posteriormente o status


PROCESSADO, finalizando os cadastros.

A integração carregara os dados na tabela de projetos. Criar trava no SAP para que o cadastro
de projeto seja feito exclusivamente pela integração.

Campos necessários para a integração do contrato (Projetos SAP Business One) – Tabela OPRJ:

 PrjCode – Cód. Projeto;


 PrjName – Nome do Projeto;
 ValidFrom – Validade Inicial do Projeto;
 ValidFor – Validade Final do Projeto;
 Active – Se o projeto está ativo/inativo (Y-ativo/N-inativo).

 Processo de integração: compra e venda

OBSERVAÇÃO: NO RETORNO, O SAP ENVIARÁ AO CPJ O CÓDIGOS DA FORMA DE PAGAMENTO,


MESMO QUE O CPJ NÃO FARÁ USO (SOMENTE A INFORMAÇÃO DA BAIXA NO FINANCEIRO).
AO ENVIAR O PEDIDO PARA O SAP, CPJ IRÁ ENVIAR A FORMA DE PAGAMENTO. NO CAMPO
DE OBSERVAÇÕES DOS PEDIDOS, VIRÃO AS INFORMAÇÕES BÁSICAS DO CONTRATO.

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 9 de 32
Levantamento de escopo técnico

 Processo de vendas
Para o processo de vendas, deverá ser disponibilizada a tabela com as seguintes informações:

Descrição De – CPJ Para - SAP


Campos de Cabeçalho
Título CPJ CPR titulo ORDR.U_NumCPJ
Código Cliente CPR PES z_codigo_sap ORDR.CardCode
Cliente CPR PES nome ORDR.CardName
Data de Emissão CPR data_lancamento ORDR.DocDate
Data de Inclusão Data atual ORDR.DocDate
Data de Vencimento CPR data_vencimento ORDR.DocDueDate
Forma de Pgto CPR PES z_forma_pagamento ORDR.PeyMethod
Valor Total CPR valor ORDR.DocTotal
Descrição da nota CPR discriminacao_nf OINV.Footer
Filial Receita CONTRATO id_unidade ORDR.BPLId
Filial Fiscal CONTRATO z_unidade_fiscal ORDR.U_BplId
Mensagem ORDR.U_Status
ID SAP ORDR.DocEntry
Status ORDR.DocStatus
Observações Concatenação de dados ORDR.Comments
Linhas
Título CPJ CPR titulo RDR1.U_NumCPJ
ID SAP CPR titulo RDR1.DocEntry
Cód. Item CPR CON icontabil_con RDR1.ItemCode
Descrição Item CPR CON icontabil_con RDR1.Dscription
Quantidade Padrão “1” RDR1.Quantity
Preço Unitário SUM do GROUP BY RDR1.Price
Total do Item SUM do GROUP BY RDR1.LineTotal
Utilização Vazio ou padrão RDR1.Usage
Núcleo UNIDADE + NULEO (Alterável 2) RDR1.OcrCode
Cliente CONTRATO PES z_codigo_sap RDR1.OcrCode2
Unidade de negócio UNIDADE z_unidade_negocio RDR1.OcrCode3
Código do contrato CONTRATO código RDR1.ProjectCode

Cabeçalho (1ª tabela), linhas (2ª tabela). Relação Cab-Lin -> 1 : N , Chave: Título CPJ.

Para cada linha do cabeçalho, poderemos ter N linhas de linha de documento. Iremos realizar a
junção das duas informações através da chave: Título CPJ.

A integração gerará um pedido de venda que aguardará aprovação. Após o pedido ter sido
aprovado (SAP), o usuário, de forma manual, irá gerar a nota fiscal de saída (gera de forma
automática o CR). Após a geração da nota, será efetuado o envio para validação junto a
prefeitura (que pode ser automático ou manual, dependendo de cada prefeitura). Após a
validação da nota na prefeitura (onde é gerado o número da NFS-e) via integração, será

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 10 de 32
Levantamento de escopo técnico

disponibilizado o número da nota para o CPJ. Via integração os dados dos documentos gerados
serão disponibilizados para o CPJ (nota e financeiro).

Evento – Cancelamento: Ao cancelar um documento no CPJ, deverá ser criado um evento que
enviará, via integração, um aviso no SAP que o documento deve ser cancelado. Caso o pedido
ainda esteja com status “Aberto”, via integração ele será cancelado. Caso o pedido já tenha
sido convertido em Nota Fiscal, será enviado um aviso (alerta) para usuários (grupo
FATURAMENTO e FINANCEIRO FILIAIS), solicitando o cancelamento da nota fiscal e do pedido.
Após o cancelamento ser efetivado, a informação do cancelamento será enviada ao CPJ, via
API, finalizando o processo.

 Processo de compras
Diferente do processo de vendas, o pedido de compra nascerá aprovado do CPJ, portanto a
integração gerará a nota fiscal (modelo NADA) de entrada (contas a pagar gerado
automaticamente pelo SAP) e caso seja uma nota reembolsável, gerará um contas a receber
(regras de acordo com o item da nota fiscal de entrada: Reembolsável ou Adiantável) de acordo
com o valor de reembolso. Ao gerar a nota fiscal de entrada, o número da nota deverá ser
retornado ao CPJ (via integração).

Para o processo de vendas, deverá ser disponibilizada a tabela com as seguintes informações:
ATUALIZAR TABELA PARA NOTA FISCAL DE ENTRADA / NOTA FISCAL DE SAÍDA

Descrição DE - CPJ Para - SAP


Campos de Cabeçalho
Título CPJ CPR titulo Campo de usuário
Código Fornecedor CPR PES z_codigo_sap OPOR.CardCode
Fornecedor CPR PES nome OPOR.CardName
Data de Emissão CPR data_lancamento OPOR.DocDate
Data de Inclusão Data atual OPOR.DocDate
Data de Vencimento CPR data_vencimento OPOR.DocDueDate
Forma de Pgto CPR PES z_forma_pagamento OPOR.PeyMethod
Valor Total CPR valor OPOR.DocTotal
Descrição da nota CPR discriminacao_nf OPCH.Footer
Filial Receita Inserir somente em processo de VENDAS OPOR.BPLId
Filial Fiscal CONTRATO z_unidade_fiscal OPOR.U_BplId
Mensagem Campo de usuário
ID SAP OPOR.DocEntry
Status OPOR.DocStatus
Observações Concatenação de dados OPOR.Comments
Linhas
Título CPJ CPR titulo POR1.U_NumCPJ
ID SAP CPR titulo POR1.DocEntry
Cód. Item CPR CON icontabil_con POR1.ItemCode
Descrição Item CPR CON icontabil_con POR1.Dscription
Quantidade Padrão “1” POR1.Quantity

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 11 de 32
Levantamento de escopo técnico

Preço Unitário SUM do GROUP BY POR1.Price


Total do Item SUM do GROUP BY POR1.LineTotal
Utilização Vazio ou padrão POR1.Usage
Núcleo UNIDADE + NULEO (Alterável 2) POR1.OcrCode
Cliente CONTRATO PES z_codigo_sap POR1.OcrCode2
Unidade de negócio UNIDADE z_unidade_negocio POR1.OcrCode3
Código do contrato CONTRATO código POR1.ProjectCode

OBSERVAÇÃO: SERÁ NECESSÁRIO INSERIR LINHA DIGITÁVEL/CÓD. BARRAS DO BOLETO NOS


CAMPOS DA TABELA “IV_IB_BoletoComplemnento” (Add-On Invent) para que os
documentos a pagar do tipo BOLETO estejam devidamente prontos para a geração do
arquivo de remessa e posterior envio ao banco para pagamento (Informação que deverá ser
passada pela Invent).

Caso o cód. de barras seja inserido de forma incorreta, o pagamento não será efetuado e
somente no retorno bancário será possível identificar.

O CPJ também deverá disponibilizar procedure para o retorno da informação FINANCEIRA.


Essas informações serão, no primeiro momento, o código do título do CPJ, e em segundo
momento, após ser baixado, o valor líquido e o número da nota fiscal.

COMPROVANTES – Serão disponibilizados os comprovantes em um repositório e via integração,


serão disponibilizados para o sistema CPJ.

ENVIO DO BOLETO – O usuário no CPJ irá anexar o boleto e inserir manualmente a linha digitável
em um campo de observação. Via integração, o .PDF do boleto será enviado no documento, para
o SAP e a linha digitável será inserida no Tabela.Campo do ADd-On de integração bancária.

Evento – Cancelamento: Ao cancelar um documento no CPJ, deverá ser criado um evento que
enviará, via integração, um aviso no SAP que o documento deve ser cancelado. Caso nota
gerada ainda esteja com status “Aberto”, via integração ele será cancelado. Caso a nota já
tenha sido paga (baixa no financeiro), será enviado aviso ao usuário (CPJ) que o documento já
foi pago. Considerar no processo a emissão de nota de reembolso (seguir o mesmo fluxo).

 Processo de integração de parceiro de negócios

O SAP deverá disponibilizar as informações de parceiro de negócio com os campos:

Parceiro de negócio
PARA - CPJ DE – SAP Tipo Observação
cpf_cnpj CRD7.TaxId0 varchar(20) CNPJ do cliente. Campo chave obrigatório
cpf_cnpj CRD7.TaxId4 varchar(20) CPF do cliente. Campo chave obrigatório
nome OCRD.CardName varchar(60) razão social do cliente, campo obrigatório
fisica_juridica U_TipoPN smallint 1 para pessoa física e 2 para pessoa jurídica
telefones OCRD.Phone1 varchar(30) relação de números de telefone do cliente

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 12 de 32
Levantamento de escopo técnico

Rg/IE CRD7.TaxId1 varchar(20) número do RG ou Inscrição Estadual do


cliente
endereço CRD1.Street char(60) endereço do cliente
complemento CRD1.Building varchar(40) complemento do endereço do cliente
cep CRD1.ZipCode varchar(9) número do CEP do cliente
cidade CRD1.County char(40) nome da cidade do cliente
estado CRD1.State char(2) Sigla da UF do cliente
email OCRD.E_Mail varchar(50) endereço de e-mail do cliente
celular OCRD.Cellular char(30) número do celular do cliente
bairro CRD1.Block char(40) nome do bairro do cliente
codigo_sap OCRD.CardCode Int código do cliente no SAP
FALTANDO OCRD.CardName nome fantasia
FALTANDO OCPR.Profession Cargo representante comercial
FALTANDO U_Simples Simples nacional
FALTANDO OCPR.Name nome do representante
integracao_situacao Sempre enviar como 0 Smallint preencher com 0 em caso de inclusão ou
atualização
cliente Smallint preencher como 1 para indicar como
cliente do escritório
fornecedor Smallint preencher como 1 para indicar como
fornecedor do escritório
status
mensagem
ID SAP

A integração deverá verificar se o PN já foi cadastro no CPJ a partir do campo CRD7.TaxId4.


Caso o PN já tenha sido cadastrado no CPJ, a integração deverá atualizar o PN com os novos
dados informados. Caso não exista, o PN deverá ser criado. Criar campo de usuário para definir
se o cadastro de PN deve ou não ser integrado ao CPJ.

OBSERVAÇÃO: SERÁ CRIADO UM CAMPO DE USUÁRIO PARA IDENTIFICAR SE O CADASTRO DE


PN SERÁ OU NÃO INTEGRADO AO CPJ.

 Processo de integração de itens


O SAP deverá disponibilizar as informações dos itens com os campos:

Itens
CAMPO SAP DESCRIÇÃO CAMPO CPJ
OITM.ItemCode Código do item
OITM.ItemName Nome do item
OITM.FrgnName Nome estrangeiro
OITM.ItemType Tipo do item
OITM.ItemGrpCod Grupo do item
OITM.UgrEntry

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 13 de 32
Levantamento de escopo técnico

OITM.ListName Lista de preço


status
mensagem
ID SAP
A integração deverá verificar se o item já foi cadastro no CPJ a partir do campo OITM.ItemName.
Caso o item já tenha sido cadastrado no SAP, a integração deverá atualizar o item com os novos
dados informados. Caso não exista, o PN deverá ser criado.

OBSERVAÇÃO: SERÁ CRIADO UM CAMPO DE USUÁRIO PARA IDENTIFICAR SE O ITEM SERÁ OU


NÃO INTEGRADO AO CPJ.

4. Premissas para início de desenvolvimento – PENDENTE DE


LEVANTAMENTO COM EQUIPE TÉCNICA CPJ. AGUARDANDO
APROVAÇÃO – PREÂMBULO IRÁ CRIAR API PARA A
INTEGRAÇÃO.

Para o início do desenvolvimento, os seguintes itens devem ser atendidos:

I. Será criada uma tabela de log, para registro de todos os eventos integrados (CPJ > SAP
e SAP > CPJ). Com isso, teremos um painel que registra os eventos, onde serão
informados:
a. ID do documento;
b. Tipo do documento;
c. Data/hora da integração;
d. Status – Integrado ou ocorreu erro;
Caso ocorra o erro, será necessário reprocessar. E para isso, pode-se aguardar
novo envio ou disponibilizar botão para reprocessar. E também um filtro de
data para exibição, facilitando identificar a data/hora onde o erro ocorreu.
II. CPJ deverá disponibilizar a forma como a integração será feita.

R: API. SERÁ NECESSÁRIO DEFINIR AGENDA PARA DEFINIÇÃO E ACESSO A API. CPJ-3C
está instalado na infraestrutura de nuvem AWS, a NW dever disponibilizar um
endpoint com um gateware/proxy via https.

III. CPJ deverá disponibilizar a autenticação e endpoint’s de acesso.


R: JSON método POST, com autenticação via token
IV. CPJ deverá disponibilizar
a. Métodos JSON
b. Tipo de chamada (POST, PUT, GET)
c. Método de autenticação (usuário e senha)
d. Tipo de autenticação (OAuth, JWT..)
V. Caso o CPJ utilize WebService, deverá disponibilizar

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 14 de 32
Levantamento de escopo técnico

R: Será disponibilizada documentação no


formado swagger, https://swagger.io/tools/swagger-editor/

VI. CPJ deve disponibilizar documentação e especificação própria sobre ordem de


integração

R: JSOJ com base64 encode

VII. CPJ deve disponibilizar como receberá os arquivos de OCR

R: JSOJ com base64 encode

VIII. CPJ deverá disponibilizar como enviará os arquivos de OCR


IX.
X. ENVIO DO BOLETO SEM INTERAÇÃO DE USUÁRIO – Foi solicitado, visando a segurança
nos pagamentos, um processo onde fosse efetuada a leitura da linha digitável, sem
necessidade de inserção manual. Dessa forma, ao gerar o pedido e enviar para o SAP, a
consistência seria efetuada de forma automatizada, a fim de evitar possíveis fraudes.
Porém é um processo que não é padrão no SAP, onde seria necessário aquisição de
ferramenta de raspagem de dados em arquivos do tipo PDF, e a cada alteração de layout
do boleto (cada TJ possui um layout específico), seria necessário manutenção, devido
aos erros de leitura que ocorreriam, fazendo com que fosse necessário abertura de
chamado para ajuste. PONTO PENDENTE, A SER VERIFICADO EM UM SEGUNDO
MOMENTO.

ANEXO TÉCNICO SEIDOR – API´S

1 – Login na Sevice Layer:

EndPoint: https://SRVNELSONWNLB01.B1CLOUD.COM.BR:52484/b1s/v1/Login

JSON:

"CompanyDB": "SBO_NW_TST",

"UserName": "INTEGRA_LEGADO",

"Password": "@1234@"

O Login retorna um SessionID a ser utilizada nas demais integrações.

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 15 de 32
Levantamento de escopo técnico

Exemplo:

2 – Centro de Custo

EndPoint: https://SRVNELSONWNLB01.B1CLOUD.COM.BR:52484/b1s/v1/ProfitCenters

JSON:

"CenterCode": "NY_B", //código

"CenterName": "New York Branch", //descrição

"EffectiveFrom": "2021-01-01", //data de

"EffectiveTo": "2099-12-31", // data até

"InWhichDimension": 1 //Dimensão 1 – Unidade, 2 Núcleo, 3 - Cliente

Exemplo:

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 16 de 32
Levantamento de escopo técnico

3 – Parceiro de Negócios: O fluxo de cadastro de PN será B1->CPJ (o SAP consumirá API a ser
disponibilizada pelo CPJ).

4 – Pedido de Venda

EndPoint: https://SRVNELSONWNLB01.B1CLOUD.COM.BR:52484/b1s/v1/Orders

JSON:

"CardCode": "C00120",

"CardName": "Nome Cliente",

"U_NumCPJ": "",

"DocDate": "2021-07-06",

"DocDueDate": "2021-07-06",

"PaymentMethod": "",//PeyMethod

"DocTotal": 3765.0, // Não é necessário enviar, B1 calcula

"ClosingRemarks": null,//Footer

"BPL_IDAssignedToInvoice": 1,//BPLId

"U_BplId": "",

"U_Status": "",

"Comments": "",

"U_LinhaDigitavel": "000000000000000000000000000000000",

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 17 de 32
Levantamento de escopo técnico

"U_DetalhesProcessoCPJ": "Texto ",

"DocumentLines": [ //linhas

"U_NumCPJ": "",

"ItemCode": "SERVP001",

"ItemDescription": "Descrição Item",// Se não informar o SAP assume a descrição do


Cadastro

"Quantity": 3.0,

"Price": 1255.0,

"LineTotal": 3765.0,

"Usage": 3,

"CostingCode": "001",//OcrCode centro de custo dimensão 1

"CostingCode2": "OPR00041",//OcrCode2 centro de custo dimensão 2

"CostingCode3": null,//OcrCode3 centro de custo dimensão 3

"ProjectCode": "" // Projeto

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 18 de 32
Levantamento de escopo técnico

Exemplo:

O DocEntry retornado (476 no caso do exemplo) é o código único do pedido gerado no SAP.
Da mesma forma como no caso dos clientes, ele pode ser consultado pelo mesmo endpoint
como GET

5 - Pedido de Compra

EndPoint: https://SRVNELSONWNLB01.B1CLOUD.COM.BR:52484/b1s/v1/PurchaseOrders

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 19 de 32
Levantamento de escopo técnico

JSON:

"CardCode": "F02704396000183",

"CardName": "NUBE NUCLEO BRASILEIRO DE ESTAGIOS", // se não informar, o SAP assume


do Cadastro do CardCode.

"U_NumCPJ": "",

"DocDate": "2021-07-06",

"DocDueDate": "2021-07-06",

"PaymentMethod": "",//PeyMethod

"DocTotal": 3765.0, // Não é necessário enviar, B1 calcula

"ClosingRemarks": null,//Footer

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 20 de 32
Levantamento de escopo técnico

"BPL_IDAssignedToInvoice": 1,//BPLId

"U_BplId": "",

"U_Status": "",

"Comments": "Observação teste",

"U_LinhaDigitavel": "000000000000000000000000000000000",

"U_DetalhesProcessoCPJ": "Texto ",

"DocumentLines": [ //linhas

"U_NumCPJ": "",

"ItemCode": "RH0007",

"ItemDescription": "CURSOS E TREINAMENTOS",// Se não informar o SAP assume a


descrição do Cadastro

"Quantity": 1.0,

"Price": 50.0,

"LineTotal": 50.0,

"Usage": 17, // necessario confirmar com consultor quais valores preencher na


utilização

"CostingCode": "001",//OcrCode centro de custo dimensão 1

"CostingCode2": "ADM00004",//OcrCode2 centro de custo dimensão 2

"CostingCode3": null,//OcrCode3 centro de custo dimensão 3

"ProjectCode": "" // Projeto

Exemplo:

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 21 de 32
Levantamento de escopo técnico

Gerado 7764
Pode ser consultado em:

6 – Itens

CPJ consultando estes campos da base do B1.

EndPoint:
https://SRVNELSONWNLB01.B1CLOUD.COM.BR:52484/b1s/v1/Items?$select=ItemCode,ItemN
ame,ForeignName,ItemType,ItemsGroupCode,UoMGroupEntry,ItemPrices

JSON: parâmetros na própria consulta.

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 22 de 32
Levantamento de escopo técnico

Exemplo:

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 23 de 32
Levantamento de escopo técnico

Por serem muitos itens, a API gera paginação e o link para a próxima página vem no final do
retorno

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 24 de 32
Levantamento de escopo técnico

7 – Contrato (Projeto Financeiro SAP)

EndPoint: https://SRVNELSONWNLB01.B1CLOUD.COM.BR:52484/b1s/v1/Projects

JSON:

{
"Code": "NW-003",
"Name": "TESTE",
"ValidFrom": "2021-05-01",
"ValidTo": "2022-05-01",
"Active": "tYES",
"U_IdExt": null
}

Exemplo:

8 - Alertas

EndPoint: https://SRVNELSONWNLB01.B1CLOUD.COM.BR:52484/b1s/v1/Messages

JSON:

"MessageDataColumns": [

"ColumnName": "Document",

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 25 de 32
Levantamento de escopo técnico

"Link": "tYES",

"MessageDataLines": [

"Object": "17",

"ObjectKey": "476",

"Value": "Pedido XYZ"

],

"RecipientCollection": [

"SendInternal": "tYES",

"UserCode": "INTEGRA_LEGADO"

],

"Subject": "Cancelamento pedido XYZ",

"Text": "Favor cancelar o pedido XYZ ABCD XXXXXXXXXXXXX"

Alertas (pedido de Venda o Object é 17 e o de compra é 22)

Exemplo:

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 26 de 32
Levantamento de escopo técnico

9 – Anexos.

Para vincular arquivos anexos aos registros do B1, é necessário primeiro enviar o arquivo e o
EndPoint vai retornar um ID de anexo criado.

Exemplo:

Neste caso o id do anexo criado é o 1495

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 27 de 32
Levantamento de escopo técnico

Informar este valor na tag AttachmentEntry , do JSON dos EndPoint de Pedidos, os quais
precisem anexar arquivos.

10 – Regras de Negócio (Validação Cruzada)

EndPoint:
https://SRVNELSONWNLB01.B1CLOUD.COM.BR:52484/b1s/v1/REGRASCENTROCUSTO

JSON:

"U_Filial": 128,

"U_Dimensao_UN": "038",

"U_Dimensao_NC": "ADM00015",

"U_Cliente": "C-001",

"U_Projeto": "NW-001",

"U_Ativo": "Y"

Exemplo:

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 28 de 32
Levantamento de escopo técnico

Gerado DocEntry 25 no exemplo, que também pode ser consultado via GET.

Equivalente ao preencher a tela do add-on de validação cruzada:

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 29 de 32
Levantamento de escopo técnico

11 – Cancelamento.

Pedido de Compra e Pedido de venda.

Para cancelar pedidos é necessário primeiro chamar o EndPoint de Consulta informando com
parâmetro o NumeroCPJ daquele pedido.

EndPoint (Pedido Venda):

https://SRVNELSONWNLB01.B1CLOUD.COM.BR:52484/b1s/v1/Orders?$select=DocEntry,Docu
mentStatus&$filter=U_NumCPJ eq 'XXXX'

Isso irá retornar o ID interno do Pedido no SAP e o Status:

Tag DocEntry é o ID SAP.

Apenas pedidos com DocumentStatus = bost_Open, podem ser cancelados. Status diferentes
deste, não são possíveis de cancelar via API e devem ser tratados manualmente no SAP.

Exemplo:

No caso do exemplo, o NumCPJ 322, equivale ao número interno 517 no SAP.

Com este numero interno deve ser acionado o end point com parâmetro Cancel

EndPoint: https://SRVNELSONWNLB01.B1CLOUD.COM.BR:52484/b1s/v1/Orders(XXX)/Cancel

Para Pedidos de Compra a dinâmica e layout de retorno são iguais, mudando o EndPoint.

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 30 de 32
Levantamento de escopo técnico

EndPoint: https://SRVNELSONWNLB01.B1CLOUD.COM.BR:52484/b1s/v1/PurchaseOrders

Detalhamento Técnico CPJ:

1 – Retorno de pagamento: O CPJ-3C deverá disponibilizar API para o SAP enviar:

 Número do título: U_NumCPJ


 Situação: 1 - pagamento efetuado com sucesso ou 2 - erro
 Erro: descrição do erro
 Data do pagamento: formato AAAA-MM-DD
 Valor pago: n.nn
 Comprovante de pagamento: para nós pode ser um campo encode64 nesta
mesma API ou o SAP deve disponibilizar uma API pelo número do título

{
"numTitulo": 1234,
“situacao”: 1
“erro”: “”
“dataPagamento”: "2021-07-06",
“valorPago”: 1230.5,
“comprovante”, “XXXXXX”

2 – Retorno de recebimento: O CPJ-3C deverá disponibilizar API para o SAP enviar:

 Número do título: U_NumCPJ


 Situação: 1 - Pagamento efetuado com sucesso ou 2 - erro
 Erro: descrição do erro
 Número da nota fiscal
 Data de emissão da nota fiscal: formato AAAA-MM-DD
 Data do recebimento: formato AAAA-MM-DD
 Valor líquido recebido: n.nn

{
"numTitulo": 1234,
“situacao”: 1
“erro”: “”
“num_NF”

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 31 de 32
Levantamento de escopo técnico

“dataEmissaoNF”: "2021-07-01",
“dataRecebimento”: "2021-07-06",
“valorRecebido”: 1230.5

3 – Solicitação de cancelamento: Está faltando API no SAP para o CPJ solicitar o cancelamento
de pagamento/ recebimento através do número do título (campo SAP U_NumCPJ)

 Número do título: U_NumCPJ


 Motivo: “”

{
"numTitulo": 1234,
“motivo”: “o cliente glosou o pagamento”
}

Grupo SEIDOR – SAP Channel Partner – SAP Business One – www.seidor.com Página 32 de 32

Você também pode gostar