APIs de Integração do Plano

Responsável:
Amanda Silva
13/12/2021
Especificação técnica
APIs de Integrações do Plano
SUMÁRIO
Página 1 de 15
Responsável:
Amanda Silva
13/12/2021
SUMÁRIO
1. OBJETIVO ............................................................................................................................................... 3
2. PROCESSO DE UTILIZAÇÃO .................................................................................................................. 3
3. AUTENTICAÇÃO .................................................................................................................................... 3
3.1 SOLICITANDO O USUÁRIO PARA INTEGRAÇÃO ................................................................................ 3
3.2 GERAÇÃO DE TOKEN ............................................................................................................................ 3
3.3 MENSAGENS E STATUS PADRÕES DE RETORNO................................................................................ 4
4. INTEGRAÇÕES ....................................................................................................................................... 4
4.1 DRE ......................................................................................................................................................... 4
4.2 FLUXO DE CAIXA ................................................................................................................................... 5
4.3 BALANÇO ............................................................................................................................................... 6
4.4 RECURSOS HUMANOS .......................................................................................................................... 7
4.4.1 MENSALISTA ...................................................................................................................................... 7
4.4.2 HORISTA ............................................................................................................................................ 8
4.5 TRANSFERÊNCIAS ................................................................................................................................. 9
4.5.1 TRANSFERIR .................................................................................................................................... 10
4.5.2 SUPLEMENTAÇÃO ........................................................................................................................... 11
4.5.3 ANTECIPAR/POSTERGAR ................................................................................................................ 12
4.5.4 REDUÇÃO ......................................................................................................................................... 13
4.5.5 MENSAGENS DE RETORNO ............................................................................................................ 13
5. STATUS E MENSAGENS PADRÕES DE RETORNO.............................................................................. 14
6. ACOMPANHAMENTO NA CENTRAL DE PROCESSOS ....................................................................... 15
Página 2 de 15
Responsável:
Amanda Silva
13/12/2021
1. OBJETIVO
O objetivo deste documento é detalhar o funcionamento do serviço API para integração de realizados
de aplicações externa com o Sistema Plano.
2. PROCESSO DE UTILIZAÇÃO
Com a disponibilização do serviço API de integração o usuário poderá realizar a inclusão de realizados
através do seu próprio ERP.
3. AUTENTICAÇÃO
Para realizar a autenticação com o sistema plano será necessário realizar os seguintes passos:
3.1 SOLICITANDO O USUÁRIO PARA INTEGRAÇÃO
Solicitar via PSA (Portal de Suporte AllStrategy), a liberação de um usuário exclusivo para a
utilização na API de integração, para essa solução será utilizado o mesmo usuário do
Integrador.
3.2 GERAÇÃO DE TOKEN
Endereço da API para geração do token:
https://auth.planoparasuaempresa.com.br/
Parâmetros de envio:
Campo Descrição Formato Modelo
LOGIN E-mail referente ao login do usuário. Texto livre integrador.xxx@allstrategy.com.br
PASSWORD Senha referente ao login do usuário. Texto livre z-%1lqR@
Os parâmetros devem ser passados via “GET” ou “POST” da seguinte maneira:
https://auth.planoparasuaempresa.com.br/?LOGIN=integrador.xxx@allstrategy.com.br
&PASSWORD=z-%1lqR@
Parâmetros de retorno:
1 – Verdadeiro / 0 -
status Valor verdadeiro (1) ou falso (0) 1
Falso
Mensagens referente ao status da execução da
msg Texto livre Dados validados com sucesso
API
auth_token Token de autenticação gerado pela API. Texto livre Conforme o exemplo de retorno.
O token tem o prazo de expiração de 30 segundos a partir do momento de sua criação, após
esse tempo deve ser gerado um novo token.
Exemplo:
{
"auth_token": "eyJJRCI6MTQyMjgsIkVNQUlMIjoiaW50ZWdyYWRvci4xODhAYWxsc3RyYXRlZ3kuY29tLmJyIiwiQVVUSF9U
T0tFTiI6Iko2d1J5cmhoUEtYYlhrUmFHUmtPN2lPTUcycGhNeU9weFJicnZ3WU45VG1BbVZYd1IyVThzQU5TZ1RVczB2YXNVbXpvVDN
QOWVlcHJyM21IWHl4ODJnPT0ifQ==",
"msg": "Dados validados com sucesso",
"status": 1
}
Página 3 de 15
Responsável:
Amanda Silva
13/12/2021
3.3 MENSAGENS E STATUS PADRÕES DE RETORNO
Autenticação bem-sucedida.
Status: 1;
msg: Dados validados com sucesso.
Parâmetros “LOGIN” ou “PASSWORD” não enviados ou incorretos.

- Status: 0;
msg: Login falhou, por favor verifique login e senha de usuário.
4. INTEGRAÇÕES
O sistema Plano permite realizar a integração de documentos de realizados para os seguintes

módulos:
4.1 DRE
Endereço da API para realizar a integração:

https://api.planoparasuaempresa.com.br/realizado/dre
Parâmetros de envio
Os parâmetros de envio deverão ser passados somente via “POST”.

AUTH_TOKEN Token válido gerado na autenticação. Texto livre eyJJRCI6NjM5NiwiRU...
Competência que os documentos serão
COMPETENCIA ano-mês-01 2019-05-01
integrados
Arquivo gerado para realizar a integração, ele
ARQUIVO deverá ser exatamente conforme mostrado no .csv, .xlsx ou .xls xxxxxxx.csv
modelo abaixo.
Somente quando estiver utilizando arquivos
DELIMITADOR Texto livre ;
com extensão .csv
Define se a integração será carga adicional ou
CARGA_ADICIONAL 0 = Não ou 1 = Sim 1
não
Ao enviar o campo CARGA_ADICIONAL com o valor 1, a API irá incluir os documentos sem
remover os documentos já existentes no Plano, campo não é obrigatório, caso não informado,
a API irá realizar a integração do arquivo como carga total.
Segue link com o modelo de arquivo para integração:
https://downloads.planoparasuaempresa.com.br/plano/especificacoes/realizados-dre.csv
Página 4 de 15
Responsável:
Amanda Silva
13/12/2021
O arquivo deve ter as seguintes colunas e ordem:
Campo Descrição Formato Modelo Tamanho

Número referente ao mês a ser
Mês MM 05 2
importado
Ano Número referente ao ano a ser importado AAAA 2019 4
Data Data de entrada do documento DD/MM/AAAA 22/05/2019 10
Código da unidade de negócio. O código
Texto ou número
Cód. da unidade tem que coincidir com o que está no 001 50
livre
cadastro no sistema Plano
Código do centro de custo. O código tem
Cód. do centro de Texto ou número
que coincidir com o que está no cadastro 001 50
custo livre
no sistema Plano
Descrição do Descrição do centro de custo cadastrado
Texto livre Controladoria 50
centro de custo no sistema plano.
Cód. da conta Código da conta contábil cadastrada no Estrutura ou
160.01.01.001 50
contábil ERP código reduzido
Descrição da Descrição da conta contábil cadastrada no
Texto livre Locação 50
conta contábil ERP
Número/Código do documento Texto ou número
Documento 123456 50
cadastrado no ERP livre
D - Débito / C -
Natureza (D/C/A) Natureza do lançamento Crédito / A - D 1
Ambos
Número com 2
Valor Valor do lançamento 150000,00 14,2
casas decimais
Aquisição de
Histórico Histórico do lançamento Texto livre 250
equipamentos
Código do projeto. O código tem que
Texto ou número
Cód. do projeto coincidir com o que está no cadastro no 001 30
livre
sistema Plano. Campo não obrigatório
Nome fornecedor/cliente que gerou Texto ou número
Gerador Fornecedor X 100
lançamento. livre
Código da dimensão. O código tem que
Texto ou número
Cód. da dimensão coincidir com o que está no cadastro no 254 50
livre
Identifica importação como dados de S - Sim / N - Não /
Rateio S 1
rateio Nulo - Não
Os títulos do cabeçalho não são obrigatórios, porém os registros deverão ser incluídos a partir
da segunda linha.
4.2 FLUXO DE CAIXA

https://api.planoparasuaempresa.com.br/realizado/fluxodecaixa

integrados
modelo abaixo.
DELIMITADOR Texto livre ;
com extensão .csv
https://downloads.planoparasuaempresa.com.br/plano/especificacoes/realizados-fluxo.csv
Página 5 de 15
Responsável:
Amanda Silva
13/12/2021
Título Descrição Formato Modelo Tamanho

Mês MM 07 2
importado
Data vencimento Data de vencimento do documento DD/MM/AAAA 16/07/2021 10
Texto ou número
livre
Código da dimensão de negócio. O código
Texto ou número
Cód. dimensão tem que coincidir com o que está no 001 50
livre
Cód. da conta Código da estrutura ou da conta externa Estrutura ou da
160.01.01.001 50
financeira cadastra no sistema Plano conta externa
Descrição da Descrição da conta financeira cadastrada
Texto livre Locação 50
conta financeira no sistema Plano
Número/Código do documento Texto ou número
Documento 123456 50
cadastrado no sistema Plano livre
D - Débito / C -
Natureza (D/C) Natureza do lançamento D 1
Crédito
Número com 2
Valor Valor do lançamento 150000,00 14,2
casas decimais
Aquisição de
Histórico Histórico do lançamento Texto livre 250
equipamentos
Texto ou número
livre
Data liquidação Data de liquidação do documento DD/MM/AAAA 27/03/2015 10
Nome fornecedor/cliente que gerou Texto ou número
Gerador Fornecedor X 100
lançamento. livre
Código do tipo de documento. O código
Tipo de tem que coincidir com o que está no Texto ou número
001 50
documento cadastro no sistema Plano. Campo não livre
obrigatório
Os títulos do cabeçalho não são obrigatórios, mas os registros deverão ser incluídos a partir da
segunda linha.
4.3 BALANÇO

https://api.planoparasuaempresa.com.br/realizado/balanco

integrados
modelo abaixo.
CARGA_ADICIONAL Texto livre ;
com extensão .csv
https://downloads.planoparasuaempresa.com.br/plano/especificacoes/realizados-balanco.csv
Página 6 de 15
Responsável:
Amanda Silva
13/12/2021

Mês MM 7 2
importado
Texto ou número
livre
Texto ou número
Cód. da Dimensão tem que coincidir com o que está no 10010 50
livre
Cód. Conta Código da conta externa cadastra no Estrutura ou da
160.01.01.001 50
contábil sistema Plano conta externa
Número com 2
Saldo inicial Saldo de balanço. 1500,00 14,2
casas decimais
Os títulos do cabeçalho não são obrigatórios, mas os registros deverão ser incluídos a partir da
segunda linha.
4.4 RECURSOS HUMANOS
4.4.1 MENSALISTA

https://api.planoparasuaempresa.com.br/realizado/rh//mensalista

integrados
modelo abaixo.
com extensão .csv
https://downloads.planoparasuaempresa.com.br/plano/especificacoes/realizados-rh-
mensalista.csv
Página 7 de 15
Responsável:
Amanda Silva
13/12/2021

Mês MM 7 2
importado
Número com 2
Valor Valor do lançamento 1500 14,2
casas decimais
Código do funcionário. O código tem que
Cód. do Texto ou número
coincidir com o que está no cadastro no 1 50
funcionário livre
sistema Plano
Nome do Texto ou número
Nome do funcionário. João da Silva 50
funcionário livre
Código do cargo. O código do cargo tem
Estrutura ou da
Cód. do cargo que coincidir com o que está no cadastro 160.01.01.001 50
conta externa
no sistema Plano
Código do sindicato. O código do
Cód. do sindicato sindicato tem que coincidir com o que Texto livre Trabalhadores 50
está no cadastro no sistema Plano
Nome para fórmula O nome do
Nome para Texto ou número
funcionário tem que coincidir com o que Salário 50
fórmula livre
Texto ou número
livre
custo livre
no sistema Plano
Texto ou número
livre
Texto ou número
livre
Código da conta externa cadastra no Estrutura ou da
Conta contábil 160.01.01.001 50
sistema Plano conta externa
Considerar head
S/N Texto livre S 1
count (S/N)
Texto ou número
Histórico Descrição do histórico Gastos com hora extra 250
livre
4.4.2 HORISTA

https://api.planoparasuaempresa.com.br/realizado/rh//horista

integrados
modelo abaixo.
com extensão .csv
Página 8 de 15
Responsável:
Amanda Silva
13/12/2021
https://downloads.planoparasuaempresa.com.br/plano/especificacoes/realizados-rh-
horista.csv

Mês MM 7 2
importado
Número com 2
Valor Valor do lançamento 1500 14,2
casas decimais
Código do funcionário. O código tem que
Cód. do Texto ou número
coincidir com o que está no cadastro no 1 50
funcionário livre
sistema Plano
Nome do Texto ou número
Nome do funcionário. João da Silva 50
funcionário livre
Código do cargo. O código do cargo tem
Estrutura ou da
Cód. do cargo que coincidir com o que está no cadastro 160.01.01.001 50
conta externa
no sistema Plano
Código do sindicato. O código do
Cód. do sindicato sindicato tem que coincidir com o que Texto livre Trabalhadores 50
Nome para fórmula O nome do
Nome para Texto ou número
funcionário tem que coincidir com o que Salario 50
fórmula livre
Texto ou número
livre
custo livre
no sistema Plano
Texto ou número
livre
Texto ou número
livre
Código da conta externa cadastra no Estrutura ou da
Conta contábil 160.01.01.001 50
sistema Plano conta externa
Considerar head
S/N Texto livre S 1
count (S/N)
Texto ou número
Histórico Descrição do histórico Gastos com hora extra 250
livre
4.5 TRANSFERÊNCIAS
Endereço da API para realizar a integração de transferências:
https://api.planoparasuaempresa.com.br/performance-dre/transferencia
Os parâmetros de envio serão diferentes para cada tipo de transferência a ser cadastrado e
poderão ser passados somente via GET.
As transferências serão cadastradas no Plano da seguinte maneira:
• Status “Aprovado”, não sendo necessário o processo de aprovação da transferência;
• O campo de justificativa será preenchido com “Importado através da API de integração”;
• O campo motivo da aprovação não é obrigatório, caso o usuário não informe o motivo da
aprovação, o campo será preenchido com “Importado através da API de integração”.
Página 9 de 15
Responsável:
Amanda Silva
13/12/2021
• O campo data da solicitação será preenchido automaticamente com a data em que o

registro foi incluído;
• Os campos solicitante e aprovador serão preenchidos com o usuário utilizado na integração;
• O parâmetro de DIMENSÃO deverá ser aceito somente se a base do usuário estiver com o
parâmetro ativo.
• O campo IDPLANEJAMENTO não é obrigatório, caso não informado, a API irá incluir a
transferência no último planejamento oficial abrangente na competência passada no campo
COMPETENCIA.
4.5.1 TRANSFERIR
Campo Descrição Formato Modelo Opcional
AUTH_TOKEN Token válido gerado na autenticação. Texto livre eyJJRCI6NjM5NiwiRU... Não
TIPO Valor fixo = TRANSFERIR Texto livre TRANSFERIR Não
Origem dos valores (MES ou
ORIGEMVALORES Texto livre MES Não
ACUMULADO)
ID do Planejamento
Caso seja omitido o parâmetro, o
IDPLANEJAMENTO Número inteiro 154
sistema irá pegar o ID do Planejamento
Sim
oficial
UNIDADEORIGEM Código da unidade de Origem Texto livre 010.060 Não
UNIDADEDESTINO Código da unidade de Destino Texto livre 010.070 Não
Cód. do centro de custo ou cód. do
CCORIGEM Texto livre 030.050 Não
centro de custo externo de origem
CCDESTINO Texto livre 030.060 Não
centro de custo externo de destino
CONTAORIGEM Cód. da Conta externa de Origem Texto livre 01.02.01 Não
CONTADESTINO Cód. da Conta externa de Destino Texto livre 01.01.02 Não
DIMENSAOORIGEM Cód. da Dimensão de Origem Texto livre 010 Não
DIMENSAODESTINO Cód. da Dimensão de Destino Texto livre 020 Não
PROJETOORIGEM Cód. do projeto de Origem Texto livre 0015.05 Sim
PROJETODESTINO Cód. do projeto de Destino Texto livre 0015.06 Sim
COMPETENCIA Competência da transferência DD/MM/AAAA 01/01/2019 Não
VALOR Valor que será transferido Número livre 2500.00 Não
MOTIVOAPROVACAO Motivo da aprovação Texto livre Ajuste de verba Sim
Requisição exemplo:
https://api.planoparasuaempresa.com.br/performancedre/transferencia?AUTH_TOKEN=eyJJR
CI6NjM2OCwiRU1BSUwiOiJpbnRlZ3JhZG9yLjE2NUBhbGxzdHJhdGVneS5jb20uYnIiLCJBVVRIX1R
PS0VOIjoiaGxHclVma2lKbVFsTGpxT2RoWEFITVBLaTVuaHdxRmhFSEJUV1dJdmd3QnRwWmZOd
DdlSktldTc0a0FKNHRqS2sySkVQMVUxaFdJZW5cLzZtbVd0ckNnPT0ifQ==&TIPO=TRANSFERIR&O
RIGEMVALORES=MES&IDPLANEJAMENTO=9&UNIDADEORIGEM=020101&UNIDADEDESTINO=0
20101&CCORIGEM=020101.411001&CCDESTINO=020101.411001&CONTAORIGEM=30101010
02&CONTADESTINO=7070&DIMENSAOORIGEM=010&DIMENSAODESTINO=020&PROJETOORI
GEM=&PROJETODESTINO&COMPETENCIA=2021-01-
01&VALOR=100&MOTIVOAPROVACAO=Ajuste
Página 10 de 15
Responsável:
Amanda Silva
13/12/2021
4.5.2 SUPLEMENTAÇÃO
TIPO Valor fixo = SUPLEMENTACAO Texto livre SUPLEMENTACAO Não
ID do Planejamento
Sim
oficial
COMPETENCIAINICIAL Competência inicial da transferência DD/MM/AAAA 01/01/2019 Não
COMPETENCIAFINAL Competência final da transferência DD/MM/AAAA 01/01/2019 Não
CI6NjM2OCwiRU1BSUwiOiJpbnRlZ3JhZG9yLjE2NUBhbGxzdHJhdGVneS5jb20uYnIiLCJBVVRIX1R
PS0VOIjoicmZ3UDZuXC9YSDJWS1wvRWdjT2tkSU13blZtU0duNzdoc2M0TGpOZFJpMDh4c296bn
IxS1QyYVQ3Y2k5K3A1Q3dmazhGb2F1T2tHV29HY24xaXBYMGN6UT09In0=&TIPO=SUPLEMENT
ACAO&IDPLANEJAMENTO=9&UNIDADEDESTINO=020101&CCDESTINO=020101.411001&CONT
ADESTINO=7070&PROJETODESTINO=&COMPETENCIAINICIAL=2021-01-
01&COMPETENCIAFINAL=2021-01-
01&VALOR=100&DIMENSAODESTINO=020&MOTIVOAPROVACAO=Ajuste
Página 11 de 15
Responsável:
Amanda Silva
13/12/2021
4.5.3 ANTECIPAR/POSTERGAR
TIPO Valor fixo = ANTEPOSTE Texto livre ANTEPOSTE Não
Origem dos valores (MES ou
ORIGEMVALORES Texto livre MES Não
ACUMULADO)
ID do Planejamento
sistema irá pegar o ID do
Sim
Planejamento oficial
UNIDADEORIGEM Código da unidade de Origem Texto livre 010.060 Não
CCORIGEM Texto livre 030.050 Não
centro de custo externo de origem
CONTAORIGEM Cód. da Conta externa de Origem Texto livre 01.02.01 Não
DIMENSAOORIGEM Cód. da Dimensão de Origem Texto livre 010 Não
PROJETOORIGEM Cód. do projeto de Origem Texto livre 0015.05 Sim
Competência de origem da
COMPETENCIAORIGEM DD/MM/AAAA 01/01/2019 Não
transferência
Competência de destino da
COMPETENCIADESTINO DD/MM/AAAA 01/01/2019 Não
transferência
CI6NjM2OCwiRU1BSUwiOiJpbnRlZ3JhZG9
yLjE2NUBhbGxzdHJhdGVneS5jb20uYnIiLCJBVVRIX1RPS0VOIjoiV0dPak1lNTZTOXkzTjNnUU1tTDI
zXC93U2taZ25TU0FXOFQ1UDR6NlNzXC8rbHBJZkdYaFZrZHZ2NytVblFNRWVzWFVZaFNFNlVxYX
pcLzUzaGNaU2g4akE9PSJ9&TIPO=ANTEPOSTE&ORIGEMVALORES=MES&IDPLANEJAMENTO=9
&UNIDADEORIGEM=020101&UNIDADEDESTINO=020101&CCORIGEM=020101.411001&CCDES
TINO=020101.411001&CONTAORIGEM=3010101002&CONTADESTINO=7070&DIMENSAOORIG
EM=010&DIMENSAODESTINO=020&PROJETOORIGEM=&PROJETODESTINO=&COMPETE
NCIAORIGEM=2021-01-01&COMPETENCIADESTINO=2021-02-
01&VALOR=100&MOTIVOAPROVACAO=Ajuste
Página 12 de 15
Responsável:
Amanda Silva
13/12/2021
4.5.4 REDUÇÃO
TIPO Valor fixo = REDUCAO Texto livre REDUCAO Não
ID do Planejamento
Sim
oficial
DIMENSAODESTINO Cód. da Dimensão de Origem Texto livre 010 Não
COMPETENCIAINICIAL Competência inicial da transferência DD/MM/AAAA 01/01/2019 Não
COMPETENCIAFINAL Competência final da transferência DD/MM/AAAA 01/01/2019 Não
https://api.planoparasuaempresa.com.br/performance-
dre/transferencia?AUTH_TOKEN=eyJJRCI6MTQ5NTcsIkVNQUlMIjoiaW50ZWdyYWRvci4zMjZAYW
xsc3RyYXRlZ3kuY29tLmJyIiwiQVVUSF9UT0tFTiI6IlNXcldqY2QxS3dyODdSUm9udEhVMldSN3JLVj
JFb1BCbXp5cm5obGdlSFp3M1Y4aG11azdsd28zVlExRk1YdVlPZkdiNEZhZ2JqakJ3VWo2ZmV6ZzZ
RPT0ifQ==&TIPO=REDUCAO&IDPLANEJAMENTO=75&UNIDADEDESTINO=1&CONTADESTINO=4
08&PROJETODESTINO=&COMPETENCIAINICIAL=2021-05-01&COMPETENCIAFINAL=2021-12-
01&VALOR=100000&DIMENSAODESTINO=321&CCDESTINO=71054&MOTIVOAPROVACAO=Aju
ste
4.5.5 MENSAGENS DE RETORNO

(Valido para as transferências dos tipos: transferir, antecipar/postergar, redução e suplementação):
Token está incorreto ou expirado.

Msg: “Token inválido”
Parâmetro “COMPETENCIA” não informado.

Msg: “Campos obrigatórios: Competência”;
Parâmetro “DIMENSAOORIGEM” não informado ou inexistente.

Msg: “Campo obrigatório: Dimensão origem”.
[Parâmetro deverá ser obrigatório somente para bases com dimensão].
Parâmetro “DIMENSAODESTINO” não informado ou inexistente.

Msg: “Campos obrigatórios: Dimensão destino”.
[Parâmetro deverá ser obrigatório somente para bases com dimensão].
Parâmetro “TIPO” for inexistente.

Msg: “Escolha o tipo de transferência para prosseguir”
Página 13 de 15
Responsável:
Amanda Silva
13/12/2021
Quando a combinação de unidade, centro de custo, dimensão e projeto não apresenta saldo
para transferência.
Msg: “Problemas encontrados: Saldo insuficiente”:
Parâmetros de destino e origem iguais.

Msg: “Problemas encontrados: Não é possível realizar transferência para a mesma origem”
Parâmetro “UNIDADEORIGEM” não informado ou inexistente.

Msg: “Campos obrigatórios: Unidade origem”;
Parâmetro “UNIDADEDESTINO” não informado ou inexistente.

msg: “Campos obrigatórios: Unidade destino”;
Parâmetro “CCORIGEM” não informado ou inexistente.

Msg: “Campos obrigatórios: Centro de custo origem”;
Parâmetro “CCORIGEM” não informado ou inexistente.

msg: “Campos obrigatórios: Centro de custo destino”;
Parâmetro “CONTAORIGEM” não informado ou inexistente.

Msg: “Campos obrigatórios: Conta origem”;
Parâmetro “CONTADESTINO” não informado ou inexistente.

Msg: “Campos obrigatórios: Conta destino”;
Parâmetro “COMPETENCIA” fora do padrão aaaa-mm-dd.

Msg: “Competência fora padrão aaaa-mm-dd”;
Parâmetro “VALOR” fora do padrão 999.99.

Msg: “Valor fora do formato definido: 999.99”;
Parâmetro “COMPETENCIAINICIAL” que possui data maior que a “COMPETENCIAFINAL”.

Msg: “Problemas encontrados: Competência 'Inicial' deve ser menor ou igual a competência
'Final'”;
5. STATUS E MENSAGENS PADRÕES DE RETORNO
Válidos para os módulos:
• DRE.
• Fluxo de caixa.
• Balanço.
• Recursos humanos mensalista.
• Recursos humanos horista.
Status 0.
Token está incorreto ou expirado.

Msg: “Token inválido”.
Página 14 de 15
Responsável:
Amanda Silva
13/12/2021
Parâmetro “ARQUIVO” vazio.

Msg: “Campos obrigatórios: Arquivo”
Parâmetro “COMPETENCIA” vazio.
Msg: “Campos obrigatórios: Competência”.
Parâmetro “DELIMITADOR” vazio.

Msg: “Campos obrigatórios: Competência”.
Valido ao importar arquivos CSV.
Status 1.
Quando todos os parâmetros são passados com sucesso.

Msg: Dados validados com sucesso.
CEPP_ID: Número de identificação do processo na Central de processos.
Exemplo:
6. ACOMPANHAMENTO NA CENTRAL DE PROCESSOS
O acompanhamento será realizado através da central de processos.
Informações apresentadas na central:
ID - Será apresentado o id do processo, descrito no parâmetro de retorno da API.

Processo - Será apresentado o nome do processo informando ao usuário o nome do módulo.
Usuário - O usuário será apresentado como integrador.
Data/hora início - Será apresentado a data e hora início da integração via API.
Duração - Será apresentada a duração do processo.
Página 15 de 15

APIs de Integração do Plano

Enviado por

Dados do documento

Descrição original:

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

APIs de Integração do Plano

Enviado por

Direitos autorais:

Formatos disponíveis

Responsável:

3.1 SOLICITANDO O USUÁRIO PARA INTEGRAÇÃO

3.2 GERAÇÃO DE TOKEN

Endereço da API para geração do token:

Os parâmetros devem ser passados via “GET” ou “POST” da seguinte maneira:

3.3 MENSAGENS E STATUS PADRÕES DE RETORNO

Parâmetros “LOGIN” ou “PASSWORD” não enviados ou incorretos.

O sistema Plano permite realizar a integração de documentos de realizados para os seguintes

Endereço da API para realizar a integração:

Os parâmetros de envio deverão ser passados somente via “POST”.

Campo Descrição Formato Modelo

Segue link com o modelo de arquivo para integração:

O arquivo deve ter as seguintes colunas e ordem:

Campo Descrição Formato Modelo Tamanho

4.2 FLUXO DE CAIXA

Endereço da API para realizar a integração:

Os parâmetros de envio deverão ser passados somente via “POST”.

Campo Descrição Formato Modelo

Segue link com o modelo de arquivo para integração:

O arquivo deve ter as seguintes colunas e ordem:

Título Descrição Formato Modelo Tamanho

Endereço da API para realizar a integração:

Os parâmetros de envio deverão ser passados somente via “POST”.

Campo Descrição Formato Modelo

Segue link com o modelo de arquivo para integração:

O arquivo deve ter as seguintes colunas e ordem:

Título Descrição Formato Modelo Tamanho

4.4 RECURSOS HUMANOS

Endereço da API para realizar a integração:

Os parâmetros de envio deverão ser passados somente via “POST”.

Campo Descrição Formato Modelo

Segue link com o modelo de arquivo para integração:

O arquivo deve ter as seguintes colunas e ordem:

Título Descrição Formato Modelo Tamanho

Endereço da API para realizar a integração:

Os parâmetros de envio deverão ser passados somente via “POST”.

Campo Descrição Formato Modelo

Segue link com o modelo de arquivo para integração:

O arquivo deve ter as seguintes colunas e ordem:

Título Descrição Formato Modelo Tamanho

Endereço da API para realizar a integração de transferências:

As transferências serão cadastradas no Plano da seguinte maneira:

• Status “Aprovado”, não sendo necessário o processo de aprovação da transferência;

• O campo de justificativa será preenchido com “Importado através da API de integração”;

• O campo data da solicitação será preenchido automaticamente com a data em que o

• Os campos solicitante e aprovador serão preenchidos com o usuário utilizado na integração;

4.5.5 MENSAGENS DE RETORNO

Token está incorreto ou expirado.

Parâmetro “COMPETENCIA” não informado.

Parâmetro “DIMENSAOORIGEM” não informado ou inexistente.

Parâmetro “DIMENSAODESTINO” não informado ou inexistente.

Parâmetro “TIPO” for inexistente.

Parâmetros de destino e origem iguais.

Parâmetro “UNIDADEORIGEM” não informado ou inexistente.

Parâmetro “UNIDADEDESTINO” não informado ou inexistente.

Parâmetro “CCORIGEM” não informado ou inexistente.

Parâmetro “CCORIGEM” não informado ou inexistente.

Parâmetro “CONTAORIGEM” não informado ou inexistente.

Parâmetro “CONTADESTINO” não informado ou inexistente.

Parâmetro “COMPETENCIA” fora do padrão aaaa-mm-dd.

Parâmetro “VALOR” fora do padrão 999.99.

Parâmetro “COMPETENCIAINICIAL” que possui data maior que a “COMPETENCIAFINAL”.