No Ongsys é possível consultar dados da sua organização por meio de uma API.

A API permite a consulta de dados disponíveis no sistema, oferecendo maior flexibilidade para análise e integração. Com ela, é possível criar visualizações personalizadas, alimentar ferramentas de Business Intelligence (BI) e gerar relatórios sob medida, tornando a tomada de decisão mais eficiente.

Para utilizar a API do Ongsys, necessita-se de uma apikey.

A apikey deverá ser gerada internamento por meio do sistema, em Configurações > Configurações Gerais > Aba Outras.

Busque pelo campo Controle de acesso da API. Copie a chave, caso já esteja gerada, ou clique em Gerar novo token.

Além disso, por questões de segurança, somente serão aceitas requisições através de HTTPS.

Todas as URL's da API são case sensitive, ou seja, devem ser utilizadas da forma em que estão representadas.

A autenticação é realizada através do uso da apikey do usuário cadastrado na plataforma, onde toda chamada a API deve informar o token de acesso do usuário.

A autenticação de fato é feita utilizando HTTP Basic Auth. Para consumir qualquer serviço da API, todas e quaisquer requisições devem realizar esse tipo de autenticação. A autenticação básica fornecida pelo protocolo HTTP é bem simples, consiste em passar o header HTTP Authorization obedecendo ao seguinte algoritmo:

"Authorization: Basic" + "{#usuário}:{#senha}"

Para realizar a autenticação na API é preciso informar o campo usuário com o CNPJ da organização, sem pontos e hífen (por exemplo 29335055000134) e o campo password com a apikey gerada.

O algoritmo anterior portanto seria:

"Authorization: Basic" + "29335055000134:apikey"

A URL base de acesso as rotas da API é https://www.ongsys.com.br/app/index.php/api/v2/

Todos os endpoints são acessíveis a partir desta rota. Por ex: https://www.ongsys.com.br/app/index.php/api/v2/contas-pagar

Um conjunto de status é definido e retornado em cada requisição para indicar situações de sucesso ou falha dos serviços e detalharmos o erro. Caso exista algum erro, ele será retornado no corpo resposta em formato JSON.

Por convenção, os status são divididos em "famílias":

• 2xx: Sucesso
• 4xx: Erro do cliente
• 5xx: Erro do servidor

A seguir alguns exemplos de status retornados pela API:

• 201 Ok - Requisição OK, tudo ocorreu como esperado.
• 401 Unauthorized – Erro de autenticação.
• 422 Unprocessable Entity – Existem erros nas requisições, como dados obrigatórios ausentes, erros de formatos de dados, entre outros.
• 500 Internal Server Error - A requisição não foi atendida por algum erro ocorrido no servidor.

Em caso de falha de um dado serviço, o erro poderá ser detalhado no corpo da mensagem de resposta em formato JSON.

Na API as mensagens de erros são detalhadas da seguinte forma:

{

         code:”422”,

         message:”Unprocessable Entity”,

         errors:[

                 {

                          message:”mensagem de erro”

                 },

                 {

                          message:”outra mensagem de erro”

                 }

         ]

}

Por padrão, cada requisição GET irá retornar, no máximo, 100 registros.

No retorno de cada requisição, estará presente a informação "totalRecords": x, que indicará a quantidade total de registros encontrados com base nos parâmetros enviados na consulta.

Utilizando o parâmetro "pageNumber": y, você deverá fazer chamadas consecutivas até que consiga acessar todos os registros necessários.

Por exemplo, se na primeira requisição você enviou "pageNumber": 1 e o retorno constou "totalRecords": 160, então há 160 resultados com base nos filtros aplicados. Contudo, como cada página retorno apenas 100 registros, você deverá fazer uma nova chamada, enviando "pageNumber": 2, para ter acesso aos registros restantes.

Lista de endpoints para carregamentos de movimentações financeiras: contas a pagar, contas a receber, transferências bancárias, lançamentos bancários, adiantamentos de clientes e adiantamentos a fornecedores.

GET – Contas a Pagar

GET → Buscar contas a pagar no período

Endpoint: .../api/v2/contas-pagar



QUERY PARAMETERS:

filtro: inteiro 1, 2, 3, 4 ou 6, sendo 1 - Emissão, 2 - Vencimento, 3 - Pagamento, 4 - Data Cadastro, ou 6 - Competência;

data_inicio: data no formato aaaa-mm-dd;

data_fim: data no formato aaaa-mm-dd;

pageNumber: número maior ou igual 1;

RETORNO 201:

{

  "totalRecords": 3,

  "data": [

      {

       "codLancamento": "CP000001",

       "fornecedor": {

           "nome": "FERNANDA SILVA LTDA",

           "documento": "029.111.111/0001-11"

       },

       "historicoDespesa": "Contrações de Serviços",

       "tipoDespesa": "2 - Contratação de Serviço(s)",

       "dataEmissao": "2023-05-26",

       "dataVencimento": "2023-05-26",

       "dataCadastro": "2023-06-13",

       "valorBruto": 7219.11,

       "valorLiquido": 7219.11,

       "competencia": "05/2023",

       "contrato": {

           "codigo": 1,

           "nome": "Pagamentos de serviços e departamentos"

       },

   "servico": "19 - Planejamento, confecção, manutenção e atualização de páginas   eletrônicas.",

        "itemServico": "101",

        "natureza": "20106",

       "estadoServico": "SP",

       "municipioServico": "São Paulo",

       "lancamento": "Real",

       "tipoLancamento": "PRINC",

       "tipoDocumento": "1 - Nota Fiscal",

       "numeroDocumento": "3131",

       "meioPagamento": "Internet Banking",

       "tipoPagamento": "7 - Boleto Simples (Mesmo banco do pagamento)",

       "codigoBarras": "00000000003216",

       "observacoes": "teste observação",

       "rateios": [

           {

               "conta": "2.5.1.02 - TRANSPORTE",

               "projeto": "15.1.01 - VEÍCULOS",

              "subprojeto": "1 - Categorização",

               "atividade": "12 - Subcategorização",

               "observacoes": "A VERIFICAR",

               "percentual": 50,

               "valor": 3609.55

           },

           {

               "conta": "2.5.1.02 - APERFEICOMENTO DE PESSOAL",

               "projeto": "4.2.2 - CAPACITAÇÃO",

              "subprojeto": "1 - Categorização",

               "atividade": "12 - Subcategorização",

               "observacoes": "A VERIFICAR",

               "percentual": 25,

               "valor": 1804.78

           },

           {

               "conta": "2.5.1.03 - RECOLHIMENTO DE IMPOSTOS",

               "projeto": "4.1.1 - ETAPA 2",

               "subprojeto": "1 - Categorização",

               "atividade": "12 - Subcategorização",

               "observacoes": "A VERIFICAR",

               "percentual": 25,

               "valor": 1804.78

           }

       ],

       "statusAprovacao": "Aprovado",

       "statusRemessa": null,

       "pagamentoParcelado": false,

       "baixaInformada": true,

       "baixaTipo": [

           {

               "tipo": "Conta Bancária",

               "origem": "12 - Conta padrão - (Banco do Brasil S.A.)",

               "data": "2023-05-26",

               "valor": "7219.11"

           }

       ],

       "aliquotaIrrf": 0,

       "codIrrf": "1708",

       "baseIrrf": 7219.11,

       "aliquotaPcc": 0,

       "codPcc": "5952",

       "basePcc": 7219.11,

       "aliquotaInss": 0,

       "codInss": "2631",

       "baseInss": 7219.11,

       "aliquotaIss": 0,

       "codIss": "0000",

       "baseIss": 7219.11,

       "aliquotaPis": 0,

       "codPis": "5979",

       "basePis": 7219.11,

       "aliquotaCofins": 0,

       "codCofins": "5960",

       "baseCofins": 7219.11,

       "aliquotaCsll": 0,

       "codCsll": "5987",

       "baseCsll": 7219.11,

       "solicitante": "0002 - Pedro Silva"

       "aprovadores": [

          {

             "aprovador1": {

                  "autorizador": "0001 - Vinicius Pires",

                  "status": "Autorizado",

                  "data": "2024-06-27",

                  "hora": "11:54",

                  "observações": "Aprovado com ressalvas"

              },

             "aprovador2": {

                  "autorizador": "0003 - William Tenório",

                   “status": "Aguardando aprovação",

                   "data": null,

                   “hora": null,

                   "observações": null

              },

              "aprovador3": "Dispensada",

              "aprovador4": "Dispensada"

           }

       ]

   },

   {...},

   {...}

 ]

}

GET – Contas a Receber

GET → Buscar contas a receber no período

Endpoint: .../api/v2/contas-receber

QUERY PARAMETERS:

filtro: inteiro 1, 2, 3, 4, 5 ou 6, sendo 1 - Emissão, 2 - Vencimento, 3 - Prev. Efetivação, 4 - Recebimento, 5 - Data Cadastro ou 6 - Competência;

data_inicio: data no formato aaaa-mm-dd;

data_fim: data no formato aaaa-mm-dd;

pageNumber: número maior ou igual 1;

RETORNO 201:

{

 "totalRecords": 3,

 "data": [

   {

       "codLancamento": "CR00001",

       "cliente": {

           "nome": "JAQUELINE SILVA SOUZA LTDA",

           "documento": "27.111.111/0001-11"

       },

       "dataEmissao": "2023-05-29",

       "dataVencimento": "2023-05-29",

       "dataCadastro": "2023-06-13",

       "dataRecebimento": "2023-05-29",

       "valorBruto": 3890.14,

       "valorLiquido": 3112.26,

       "competencia": "01/1970",

       "contrato": {

           "codigo": 78946,

           "nome": "aluguel de sede"

       },

       "historicoReceita": "TED-TRANSF ELET DISPON REMET.COND.EDIF.COMENDADOR",

       "tipoReceita": "2 - Prestação de Serviço(s)",

       "servico": "1 - Análise de serviços",

       "lancamento": "Projetado",

       "tipoLancamento": "PRINC",

       "tipoDocumento": "1 - Nota Fiscal",

       "numeroDocumento": "0000000123123",

       "meioRecebimento": "Cartão de Crédito",

       "observacoes": "Verificando prestção de itens ",

       "rateios": [

           {

               "conta": "1.1.1.01.009 - Conta principal",

               "projeto": "1.2.01 - DEPARTAMENTOS",

               "subprojeto": "1 - Categorias",

               "atividade": "1 - Categorias internas de departamentos ",

               "observacoes": "Verificações",

               "percentual": 100,

               "valor": 3890.14

           }

       ],

       "recebimentoParcelado": false,

       "baixaInformada": true,

       "baixaTipo": [

           {

               "tipo": "Conta Bancária",

               "origem": "12 - Conta padrão - (Banco do Brasil S.A.)",

               "data": "2023-05-29",

               "valor": "3112.26"

           }

       ],

       "aliquotaIrrf": 1.22,

       "codIrrf": "1708",

       "baseIrrf": 3890.14,

       "aliquotaPcc": 4.12,

       "codPcc": "8863",

       "basePcc": 3890.14,

       "aliquotaInss": 3.45,

       "codInss": "2631",

       "baseInss": 3890.14,

       "aliquotaIss": 2.4564",

       "codIss": "122",

       "baseIss": 3890.14,

       "aliquotaPis": 4.12,

       "codPis": "5979",

       "basePis": 3890.14,

       "aliquotaCofins": 2.31,

       "codCofins": "5856",

       "baseCofins": 3890.14,

       "aliquotaCsll": 2.32,

       "codCsll": "5987",

       "baseCsll": 3890.14

   },

   {...},

   {...}

 ]

}

POST – Contas a Receber

POST → Rota para inserção de Contas a Receber na base de dados

Endpoint: .../api/v2/create-contas-receber

QUERY PARAMETERS:

Sem parâmetros

REQUEST BODY:

{

   "cliente":   {

"nome":   "FULANO DE TAL",

"documento":   "27.111.111/0001-11"

   },

   "dataEmissao":   "2023-05-29",

   "dataVencimento":   "2023-05-29",

   "valorBruto":   3890.14,

   "historicoReceita":   "RECEBIMENTO DE DOAÇÃO",

   "tipoReceita":   "2",

   "lancamento":   "Projetado",

   "tipoDocumento":   "1",

  "meioRecebimento": "1",

   "numeroDocumento":   "0000000123123",

   "observacoes": "Registro de doação",

   "rateios":   [

{

"conta":   "1.1.1.01.009",

"projeto":   "1.2.01",

"subprojeto": "1",

"atividade": "1",

"observacoes": "Verificações",

"percentual":   100,

"valor":   3890.14

}

   ],

   "baixa": [

{

 "contaBancaria": "12",

"data": "2023-05-29",

"valor": "3890.14"

}

   ]

}

No request body a ser enviado, é necessário se atentar às seguintes restrições:

• Elementos em negrito são obrigatórios
• Campos de data precisam estar no formato AAA-MM-DD
• Campos de valor precisam ter os decimais separados por ponto (.) e não vírgula
• O elemento "tipoReceita" aceita os valores:
• 1 - Venda de Produto
• 2 - Prestação de Serviço
• 3 - Doações
• 4 - Convênio
• 9 - Outras Receitas
• O elemento "lancamento" aceita os valores:
• Real
• Projetado
• O elemento "tipoDocumento" aceita os valores:
• 1 - Nota Fiscal
• 6 - Cupom Fiscal
• 41 - Recibo
• 42 - Fatura
• 52 - Outros
• 54 - Provisório
• O elemento "meioRecebimento" aceita os valores:
• 1 - Boleto Bancário
• 2 - Transferência Bancária
• 3 - Cartão de Crédito
• 4 - Cartão de Débito
• 5 - Outros (dinheiro, cheque, vale, etc...)
• Sobre o "rateio":
• Nos elementos do rateio "conta" e "projeto", deve ser identificada a numeração da conta do plano de contas financeiro e dos projetos/centros de custo parametrizados na base de dados do sistema
• Podem ser incluídas múltiplas linhas de rateio, porém a soma do elemento "percentual" de todas as linhas deve ser igual a 100
• Podem ser incluídas múltiplas linhas de rateio, porém a soma do elemento "valor" de todas as linhas deve ser igual ao valor bruto do lançamento
• Sobre a "baixa":
• Elemento não obrigatório. Se não enviado, o lançamento é incluída ser baixa.
• O elemento "contaBancaria" deve conter o ID da conta bancária cadastrada no sistema
• O elemento "valor" deve ser igual ao valor bruto do lançamento

RETORNO 201:

O retorno da requisição, caso esteja correta, irá retornar o Código do Lançamento recém inserido. Esse código é único e necessário para identificar o lançamento em outras requisições.

{

"code": "201",

"message": "Conta a receber criada com sucesso!",

"codigo lançamento": 314,
"codigo baixa": 79

}

POST – Baixa de Contas a Receber

POST → Rota para informar a baixa de Contas a Receber já cadastradas na base de dados

Endpoint: .../api/v2/baixa-contas-receber

QUERY PARAMETERS:

Sem parâmetros

REQUEST BODY:

{

    "codigoLancamento": "312",

    "baixa": [

        {

            "contaBancaria": "12",

            "data": "2023-05-29",

            "valor": "1945.07"

        }

    ]

}

No request body a ser enviado, é necessário se atentar às seguintes restrições:

• Elementos em negrito são obrigatórios
• Campos de data precisam estar no formato AAA-MM-DD
• Campos de valor precisam ter os decimais separados por ponto (.) e não vírgula
• O elemento "codigoLancamento" é o identificador único retornado na inserção da Conta a Receber
• Sobre a "baixa":
• O elemento "contaBancaria" deve conter o ID da conta bancária cadastrada no sistema
• O elemento "valor" deve ser igual ao valor bruto do lançamento

RETORNO 201:

{

"code": "201",

"message": "Baixa de conta a receber efetuada com sucesso!",
"codigo baixa": 79

}

GET – Transferências Bancárias

GET → Buscar transferências bancárias no período

Endpoint: .../api/v2/transferencias-bancarias

QUERY PARAMETERS:

data_inicio: data no formato aaaa-mm-dd;

data_fim: data no formato aaaa-mm-dd;

pageNumber: número maior ou igual 1;

exibicao_detalhada: false (padrão), true

RETORNO 201 - Exibição detalhada: false

{

 "totalRecords": 3,

  "data": [

  {

    "codigo": "TB00000121",

    "dataOperacao": "2023-06-01",

    "descricao": "Correção de valores utilizados",

    "origem": "12 - Conta padrão - (Banco do Brasil S.A.)",

    "destino": "15 - Conta alternativa - (Banco Bradesco S.A.) ",

    "valor": 8974.14,

    "observacoes": "Verificação de recibo"

  },

  {...},

  {...}

 ]

}

RETORNO 201 - Exibição detalhada: true

{

 "totalRecords": 3,

  "data": [

  {

    "codigo": "TS00000121",

    “tipo”: “saida”,

    "dataOperacao": "2023-06-01",

    "descricao": "Correção de valores utilizados",

    "conta": "12 - Conta padrão - (Banco do Brasil S.A.)",

    "valor": 8974.14,

    "observacoes": "Verificação de recibo"

  },

  {

    "codigo": "TE00000121",

    “tipo”: “entrada”,

    "dataOperacao": "2023-06-01",

    "descricao": "Correção de valores utilizados",

    "conta": "15 - Conta alternativa - (Banco Bradesco S.A.) ",

    "valor": 8974.14,

    "observacoes": "Verificação de recibo"

  },

  {...},

  {...}

 ]

}

GET – Lançamentos Bancários

GET → Buscar lançamentos bancários no período

Endpoint: .../api/v2/lancamentos-bancarios

QUERY PARAMETERS:

data_inicio: data no formato aaaa-mm-dd;

data_fim: data no formato aaaa-mm-dd;

pageNumber: número maior ou igual 1;

RETORNO 201:

{

 "totalRecords": 3,

 "data": [

  {

    "codigo": "LB00000001",

    "dataOperacao": "2023-06-01",

    "contaBancaria": "12 - Conta padrão - (Banco do Brasil S.A.)",

    "tipo": "C",

    "valor": 350,

    "categoria": "7 - Estorno",

    "descricao": "Estorno",

    "observacoes": "Estorno de produto não entregue",

    "rateios": [

      {

        "conta": "2.5.1.01 - CONTA PADRÃO",

        "projeto": "1.1.01 - PROJETO",

        "subprojeto": "1 - Subprojeto",

        "atividade": "1 - Atividade",

        "percentual": 50,

        "valor": 175

      },

      {

        "conta": "2.5.1.01 - ADIANTAMENTO DE 13º SALARIOS",

        "projeto": "1102 - Produto de pessoal ",

        "subprojeto": "1 - Subprojeto",

        "atividade": "1 - Atividade",

        "percentual": 50,

        "valor": 175

      }

    ]

  },

  {...},

  {...}

 ]

}

GET – Adiantamentos a Fornecedores

GET → Buscar adiantamentos a fornecedores no período

Endpoint: .../api/v2/adiantamentos-fornecedores

QUERY PARAMETERS:

data_inicio: data no formato aaaa-mm-dd;

data_fim: data no formato aaaa-mm-dd;

pageNumber: número maior ou igual 1;

RETORNO 201:

{

  "totalRecords": 3,

  "data": [

  {

    "codigo": "AP00000001",

    "fornecedor": {

      "nome": "FERNANDA SOUZA SILVA",

      "documento": "029.111.111/0001-11"

    },

    "dataOperacao": "2023-06-05",

    "descricao": "Adiantamento de fornecedor padrão",

    "contaBancaria": "12 - Conta padrão - (Banco do Brasil S.A.)",

    "formaPagamento": "10 -DARF Normal",

    "valorAdiantado": 50,

    "valorBaixado": 50,

    "baixado": "Sim",

    "statusRemessa": "Agendado",

    "observacoes": "Verificação de produto",

    "codigolancamento": "CP009102"

  },

  {...},

  {...}

  ]

}

GET – Adiantamentos a Clientes

GET → Buscar adiantamentos a clientes no período

Endpoint: .../api/v2/adiantamentos-clientes

QUERY PARAMETERS:

data_inicio: data no formato aaaa-mm-dd;

data_fim: data no formato aaaa-mm-dd;

pageNumber: número maior ou igual 1;

RETORNO 201:

{

  "totalRecords": 3,

  "data": [

   {

      "codigo": "AR00000001",

       "cliente": {

        "nome": "THALES JUNIOR",

        "documento": "24.111.111/0001-11"

       },

      "dataOperacao": "2022-02-01",

      "descricao": "Soluções",

      "contaBancaria": "12 - Conta padrão - (Banco do Brasil S.A.)",

      "formaRecebimento": "2 - Transferência eletrônica",

      "valorAdiantado": 800,

      "valorBaixado": 800,

      "baixado": "Sim",

      "observacoes": "Agendamento a concluir",

      "codigoRecebimento": "CR000199"

      },

    {...},

    {...}

  ]

}

Lista de endpoints para carregamentos dos cadastros de clientes e fornecedores.

GET – Clientes

GET → Buscar clientes cadastrados

Endpoint: .../api/v2/clientes

QUERY PARAMETERS:

filtro: inteiro 1,2,3,4,5,6 ou 7, sendo 1 tipo serviço Fornecedor, 2 - Parceiro, 3 - Projeto Apoiado, 4 - Voluntário, 5 - Funcionário, 6 – Governo e 7 - Outros

pageNumber: número maior ou igual 1;

RETORNO 201:

{

  "totalRecords": 3,

  "data": [

   {

      "id": "1",

      "pessoa": "Física",

      "tipoCliente": "Projeto Apoiado",

      "tipo": "C",

      "documento": "390.982.468-42",

      "nomeEmpresa": "WT SA",

      "nomeFantasia": WT SA BRASIL,

       "endereco": {

        "endereco": "Rua Doutor José Milton de Freitas",

        "numero": "211",

        "complemento": "casa",

        "bairro": "Jardim Walkíria",

        "cidade": "São José do Rio Preto",

        "cep": "15.085-380",

        "estado": "SP",

        "pais": "Brasil"

      },

      "telefonePrincipal": "(11) 00000-0000",

      "telefoneSecundario": (17) 00000-5106,

      "email": "wt@gmail.com",

      "inscricaoEstadual": "032412134",

      "inscricaoMunicipal": "111012124214",

   "atividadePrincipal": "85.99-6-04 - Treinamento em desenvolvimento          profissional e gerencial",

      "atividadeSecundaria": "85.99-6-05 - Cursos preparatórios 

para concursos",

      "naturezaJuridica": "213-5 - Empresário (Individual)",

      "dadosBancarios": {

        "banco": "8 - TRANSITÓRIA",

        "agencia": "324-1",

        "contaCorrente": "1414-1",

        "nomeCorrentista": "Valdir silva",

        "tipoCorrentista": "J",

        "documentoCorrentista": null,

        "remessa": null,

        "tipoConta": "Conta Corrente",

        "chavePix": "(41) 24124-1241",

        "tipoPix": "TEL"

      },

      "tipoConta": "Conta Corrente",

      "observacoes": null,

      "codigoContabil": "6246246",

      "formaPagamento": "GARE - SP ICMS"

    },

    {...},

    {...}

  ]

}

GET – Fornecedores

GET → Buscar fornecedores cadastrados

Endpoint: .../api/v2/fornecedores

QUERY PARAMETERS:

filtro: inteiro 1,2,3,4,5,6 ou 7, sendo 1 tipo serviço Fornecedor, 2 - Parceiro, 3 - Projeto Apoiado, 4 - Voluntário, 5 - Funcionário, 6 – Governo e 7 - Outros

pageNumber: número maior ou igual 1;

RETORNO 201:

{

  "totalRecords": 3,

  "data": [

   {

      "id": "101",

      "pessoa": " Jurídica",

      "ativoInativo": "A",

      "tipo": "F"

      "tipoFornecedor ": "Projeto Apoiado",

      "documento": "390.982.468-42",

      "nomeEmpresa": " CHANGE.ORG BRASIL",

      "nomeFantasia": CHANGE.ORG SA BRASIL,

       "endereco": {

        "endereco": "Rua Doutor José Milton de Freitas",

        "numero": "211",

        "complemento": "casa",

        "bairro": "Campo Grande",

        "cidade": "Duque de Caxias",

        "cep": "23.070-220",

        "estado": "RJ",

        "pais": "Brasil"

      },

      "telefonePrincipal": "(21) 00000-0000",

      "telefoneSecundario": "(21) 00000-4406",

      "email": "admin@changebrasil.org”,

      "inscricaoEstadual": "032412134",

      "inscricaoMunicipal": "111012124214",

 "atividadePrincipal":"85.99-6-04 - Treinamento em desenvolvimento          profissional e gerencial",

      "atividadeSecundaria": "85.99-6-05 - Cursos preparatórios 

para concursos",

      "naturezaJuridica": "399-9 - Associação Privada)",

      "dadosBancarios": {

        "banco": "237 - Banco Bradesco S.A.",

        "agencia": "324-1",

        "contaCorrente": "1414-1",

        "nomeCorrentista": "Niley Gomes",

        "tipoCorrentista": "J",

        "documentoCorrentista": "525.535.885-38",

        "remessa": null,

        "tipoConta": "Conta Corrente",

        "chavePix": "(41) 24124-1241",

        "tipoPix": "TEL"

      },

      "tipoConta": "Conta Corrente",

      "observacoes": null,

      "codigoContabil": "62462463535",

      "formaPagamento": "GARE - SP ICMS",

      "itemServico": [ 

      "2", 

      "101"

     ]

      "natureza": [ 

       "503", 

       "20105", 

       "20106", 

       "20203" 

      ], 

      "avaliacao": "sim",

      "dataAvaliacao": "2024-07-18",

      "risco": "Médio",

      "kypInicio": "2023-11-30",

      "kypFim": "2024-10-15",

      "kysInicio": "2023-11-30",

      "kysFim": "2024-10-15",

      "riscoCompliance": "Alto",

      "observacoesCompliance": "Histórico positivo"

    },

    {...},

    {...}

  ]

}

Lista de endpoints para carregamentos dos cadastros de clientes e fornecedores.

GET – Contratos a Pagar

GET → Buscar contratos a pagar cadastrados

Endpoint: .../api/v2/contratos

QUERY PARAMETERS:

pageNumber: número maior ou igual 1;

RETORNO 201:

{

  "totalRecords": 3,

  "data": [

    {

      "id": "6009",

      "codigo": "4938-3",

      "fornecedor": {

        "dcto": "00.111.111/0041-75",

        "nome": "Ação Assistencial"

      },

      "nomeContrato": "Contrato de serviço",

      "descricaoContrato": "Contrato com prazo de 3 meses, com possível prorrogação.",

      "valorAprovado": "20320.00",

      "dataInicio": "2024-07-02",

      "dataFim": "2025-07-02",

      "assinado": true,

      "dataAssinaturaContrato": "2024-08-01",

      "status": "Ativo",

      "tipoModalidade": "Prestação de Serviço",

      "riscoContrato": "Médio",

      "contratoHomologado": true,

      "dataHomologacao": "2024-07-02",

      "modeloContrato": "master",

      "obsRiscoContrato": "prestador de índice alto de confiabilidade",

      "obsContrato": "Checagem para entrega pontuais",

      "responsavel": "3947 - Vinicius Pires",

      "instrumentos": [

        {

          "id_instrumento": "6007",

          "codigo": "4938-1",

          "data": "02/07/2024",

          "informacoes": [

            "Dados Bancários",

            "Prazo"

          ],

          "descricao": "Instrumento cadastrado",

          "tipo": "Termo de licença",

          "valor": "100.00"

        },

        {...}, 

        {...} 

      ],

      "ess": [

        {

          "numero": "4938-1",

          "descricao": "Solicitação enviada",

          "valor": "200"

        },

        {...}, 

        {...} 

      ],

      "parcelas": [

        {

          "numero": "1",

          "valor": "10160.00",

          "possuiSolicitacaoPgto": false

        },

        {

          "numero": "2",

          "valor": "10160.00",

          "possuiSolicitacaoPgto": true

        },

        {...}, 

        {...} 

      ]

    },

    {...}, 

    {...} 

  ]

}

GET – Contratos a Receber

GET → Buscar contratos a receber cadastrados

Endpoint: .../api/v2/contratos-receber

QUERY PARAMETERS:

pageNumber: número maior ou igual 1;

RETORNO 201:

{

  "totalRecords": 3,

  "data": [

    {

      "id": "79",

      "codigo": "0013/2024",

      "cliente": {

        "dcto": "390.982.468-42",

        "nome": "William Tenório"

      },

      "nomeContrato": "Teste rota api contratos a receber",

      "descricaoContrato": "Contrato para prestação de serviços com cliente pontual",

      "valorAprovado": "Sem valor definido",

      "dataInicio": "2024-09-01",

      "dataFim": "2025-03-03",

      "assinado": true,

      "dataAssinaturaContrato": null,

      "status": "Ativo",

      "tipoModalidade": "Prestação de Serviço",

      "riscoContrato": "Não informado",

      "contratoHomologado": false,

      "dataHomologacao": null,

      "modeloContrato": null,

      "obsRiscoContrato": null,

      "aditivos": null

    },

    {

      "id": "78",

      "codigo": "0012/2024-2",

      "cliente": {

        "dcto": "390.982.468-42",

        "nome": "William Tenório"

       },

      "nomeContrato": "Consultoria recorrente",

      "descricaoContrato": "Consultoria recorrente realizada trimestralmente ",

      "valorAprovado": "58507.90",

      "dataInicio": "2024-09-04",

      "dataFim": "2025-09-04",

      "assinado": true,

      "dataAssinaturaContrato": null,

      "status": "Ativo",

      "tipoModalidade": "Prestação de Serviço",

      "riscoContrato": "Não informado",

      "contratoHomologado": false,

      "dataHomologacao": null,

      "modeloContrato": null,

      "obsRiscoContrato": null,

      "aditivos": [

        {

          "id_aditivo": "77",

          "codigo": "0012/2024-1",

          "data": "11/09/2024",

          "informacoes": [

            "Indefinido"

          ],

          "descricao": "234",

          "tipo": "Termo de licença",

          "valor": "23452.35"

        },

        {

          "id_aditivo": "78",

          "codigo": "0012/2024-2",

          "data": "11/09/2024",

          "informacoes": [

            "Indefinido"

          ],

          "descricao": "555",

          "tipo": "Termo de distrato",

          "valor": "55.55"

        }

      ]

    },

    {...}

  ]

}

No Ongsys é possível anexar arquivos nos cadastros e lançamentos financeiros do sistema.

Desta forma, também é possível consultar esses conteúdos por meio da API.

Rotas GET com anexos disponíveis:

• Cadastros:
• Cadastro de Clientes
• Cadastro de Contratos a Pagar
• Cadastro de Contratos a Receber
• Cadastro de Fornecedores
• Movimentações Financeiras:
• Adiantamentos a Clientes
• Adiantamentos a Fornecedores
• Contas a Pagar
• Contas a Receber
• Lançamentos Bancários
• Transferências Bancárias

Por padrão, as rotas acima não apresentam os anexos nos resultados. Para que os anexos sejam retornados, é necessário enviar um QUERY PARAMETER, conforme segue abaixo:

exibir_anexos: true

Desta forma, em cada registro retornado, o JSON de retorno terá um elemento "anexos": [] com os anexos vinculados, apresentando a URL de endereço com nome "caminho" e o nome original do arquivo, como "nome_original".

GET → Buscar logs de ações no sistema

Endpoint: .../api/v2/logs

QUERY PARAMETERS:

data_inicio:  data no formato aaaa-mm-dd;

data_fim:  data no formato aaaa-mm-dd;

pageNumber:  número maior ou igual 1;



RETORNO 201:

{

  "totalRecords": 3,

  "data": [

    {

            "logId": "32023",

            "usuarioId": "1938",

            "usuarioNome": "William  Tenório",

            "origem": "Login",

            "descricaoTransacao": "Login no sistema",

            "data": "2025-05-12 14:34:06"

     },

    {

            "logId": "32015",

            "usuarioId": "1938",

            "usuarioNome": "William  Tenório",

            "origem": "Incluir contas a pagar",

            "descricaoTransacao": "CP 9456 - PRINC<br>HISTÓRICO: Pagamento<br>FORNECEDOR: 1351 - NOME DO FORNECEDOR<br>NÚM. DCTO: 202<br>VALOR: 1900",

            "data": "2025-05-09 15:07:33",

            "codigo": "CP009456",

            "numeroDocumento": "202200000000001"

     },

    {...}

  ]

}