Documentação

APIs

API Totvs RM

URL: https://integrator2-teste.funarbe.org.br/rm

Apresentação

Esta API RESTful disponibiliza serviços e métodos para integração com o sistema Totvs RM. Possibilita consultar dados e em alguns casos até a inserção de novos dados conforme a regra de negócio do sistema por meio da utilização do TBC (Totvs Business Conector).

Ambientes

Teste: https://integrator2-teste.funarbe.org.br/rm
Produção: https://integrator2.funarbe.org.br/rm

Campos

Você pode especificar quais campos deseja receber como resposta. Para isso faça:
[GET] /rm/cliente-fornecedor/?fields=NOME,CGCCFO,RUA,BAIRRO,CIDADE,EMAIL
Caso não especifique os campos desejados, por padrão os serviços retornarão todos os campos disponíveis

Campos extras

Para otimizar a performance alguns campos são ocultados por padrão, para fazer com que sejam exibidos faça:
[GET] /rm/cliente-fornecedor/?fields=NOME,CIDADE&expand=FORMASPAGAMENTO

Paginação

Por padrão as consultas retornam 20 registros por página. A página pode ser selecionada da seguinte forma:
[GET] /rm/cliente-fornecedor/?page=2

Filtro

Cada serviço possui filtros que podem ser utilizados da seguinte forma:
[GET] /rm/cliente-fornecedor/?filter[CGCCFO]=096.424.616-73
Verifique na seção "Serviços" quais campos podem ser utilizados para busca

Para utilizar a nossa API RESTful é necessário fazer uma Autenticação Básica HTTP usando usuário e senha fornecidos pela equipe de desenvolvimennto do Núcleo de Tecnologia da Informação da Funarbe.

  • /cliente-fornecedor
    Status: Ok
    Métodos: GET, POST
    Filtros: NOME, NOMEFANTASIA, CGCCFO, CODCFO,ATIVO, CODDEPARTAMENTO
    Campos extras: FORMASPAGAMENTO, LIMITEDISPONIVELCHEQUINHO, CODTB2FLX, FUNCIONARIOATIVO, DADOSDEFAULT, TIPOFRETE, CODIGOTRANSPORTADORA, CODIGOREPRESENTANTE, NOMEREPRESENTANTE, RESTRICOES, CODIGOVENDEDOR, CODIGOPAGAMENTO
    Observações: Para uso do campo extra LIMITEDISPONIVELCHEQUINHO é necessário enviar via GET os campos DTABERTURA e DTFECHAMENTO no formato aaaa-mm-dd
  • /produto
    Status: Ok
    Métodos: GET
    Filtros: IDPRD, CODIGOPRD, NOMEFANTASIA, SKU, EAN, EAN, VENDERNOECOMMERCE
    Campos extras: EAN, SECAO, SUBSECAO, IDNAT, SALDOMOV, NOMEECOMMERCE, VENDERNOECOMMERCE
  • /estoque
    Status: Ok
    Métodos: GET
    Filtros: IDPRD, CODIGOPRD, NOMEFANTASIA, DESCRICAO, SKU
    Campos extras: EAN, SECAO, SUBSECAO, IDNAT, SALDOMOV, SALDOFISICO2
  • /movimento
    Status: Ok
    Métodos: GET, POST
    Filtros: IDMOV, CODTMV, NUMEROMOV, CODCFO, DATAEMISSAO
    Exemplos:
  • /local-estoque
    Status: Ok
    Métodos: GET
    Filtros: IDPRD, EAN, CODLOC
    Campos extras: EAN, SECAO, SUBSECAO, IDNAT, INATIVO

API Transparência

URL: https://integrator2-teste.funarbe.org.br/transparencia

Apresentação

Esta API RESTful disponibiliza serviços e métodos para integração com sistemas de gestão de recursos utilizados na Fundação. Possibilita que instituições parceiras consigam consultar projetos e pagamentos realizados.

Ambientes

Teste: https://integrator2-teste.funarbe.org.br/transparencia
Produção: https://integrator2.funarbe.org.br/transparencia

Campos

Você pode especificar quais campos deseja receber como resposta. Para isso faça:
[GET] /transparencia/projetos/?fields=nome,dtfim,dtinicio,coordenador
Caso não especifique os campos desejados, por padrão os serviços retornarão todos os campos disponíveis

Campos extras

Para otimizar a performance alguns campos são ocultados por padrão, para fazer com que sejam exibidos faça:
[GET] /transparencia/projetos/?fields=nome,dtfim&expand=executora

Paginação

Por padrão as consultas retornam 20 registros por página. A página pode ser selecionada da seguinte forma:
[GET] /transparencia/projetos/?page=2

Filtro

Cada serviço possui filtros que podem ser utilizados da seguinte forma:
[GET] /transparencia/projetos/?filter[cpf]=096.424.616-73
Verifique na seção "Serviços" quais campos podem ser utilizados para busca

Para utilizar a nossa API RESTful é necessário fazer uma Autenticação Básica HTTP usando usuário e senha fornecidos pela equipe de desenvolvimennto do Núcleo de Tecnologia da Informação da Funarbe.

  • /projetos
    Status: Ok
    Métodos: GET
    Filtros: referencia, coordenador, anoInicio, situacao, classificacao
    Campos extras: executora, departamento, pagamentosPessoasJuridicas, pagamentosPessoasFisicas, pagamentosServidores, equipe, documentos, metas
  • /pagamentos
    Status: Ok
    Métodos: GET
    Filtros: nome, cpf, projeto
    Campos extras: pedido
  • /pagamentos/servidores
    Status: Ok
    Métodos: GET
    Filtros: nome, cpf, projeto
    Campos extras: pedido
  • /pagamentos/pessoa-fisica
    Status: Ok
    Métodos: GET
    Filtros: nome, cpf, projeto
    Campos extras: pedido
  • /pagamentos/pessoa-juridica
    Status: Ok
    Métodos: GET
    Filtros: razaoSocial, cnpj, projeto
    Campos extras: pedido

API Cartão Alimentação

URL: https://integrator2-teste.funarbe.org.br/cartao-alimentacao

Apresentação

Esta API RESTful disponibiliza serviços e métodos para integração com o cartão alimentação da Fundação.

Ambientes

Teste: https://integrator2-teste.funarbe.org.br/cartao-alimentacao
Produção: https://integrator2.funarbe.org.br/cartao-alimentacao
Verifique na seção "Serviços" os endpoints disponíveis

Para utilizar a nossa API RESTful é necessário fazer uma Autenticação Básica HTTP usando usuário e senha fornecidos pela equipe de desenvolvimennto do Núcleo de Tecnologia da Informação da Funarbe.

  • /saldo/consultar
    Status: Ok
    Métodos: GET
    Parâmetros: cpf, matricula(opcional), senha(opcional)
  • /saldo/debitar
    Status: Ok
    Métodos: POST
    Campos: valor, serie, cupom, cpf, senha
  • /saldo/estornar
    Status: Ok
    Métodos: POST
    Campos: valor, serie, cupom, cpf, senha

API Megasul

URL: https://integrator2-teste.funarbe.org.br/megasul

Apresentação

Esta API RESTful disponibiliza serviços e métodos para integração com o Megasul.

Ambientes

Teste: https://integrator2-teste.funarbe.org.br/megasul
Produção: https://integrator2.funarbe.org.br/megasul
Verifique na seção "Serviços" os endpoints disponíveis

Exemplo:

[GET] /megasul/bandeira/?dataInicio=2025-04-20&dataFim=2025-04-20

Para utilizar a nossa API RESTful é necessário fazer uma Autenticação Básica HTTP usando usuário e senha fornecidos pela equipe de desenvolvimennto do Núcleo de Tecnologia da Informação da Funarbe.

  • /bandeira/consultar
    Status: Ok
    Métodos: GET
    Parâmetros: dataInicio, dataFim