Skip to content

Operações Api (v1.0.0)

API de Operações

Esta API centraliza a gestão do ciclo de vida de operações e seus ativos, oferecendo funcionalidades completas para:

  • Criação, listagem, consulta, alteração e exclusão de operações.
  • Gerenciamento de ativos, tanto individualmente quanto em massa, por meio de importação.
  • Controle de status, situação e acompanhamento do progresso das importações.
  • Consultas detalhadas, extração de informações e registro de erros no processo.

Todas as operações são protegidas por autenticação e autorização robustas, garantindo segurança, organização e rastreabilidade em todas as etapas do gerenciamento das informações.

Download OpenAPI description
v1.json
v1.yaml
Overview
rgbtec
support@rgbtec.com.br
Languages
Servers
Mock server
https://apidocs.ger26.com.br/_mock/apis/operacoes/v1/
http://rgbsys.dyndns.info/ger2025-operacao-api-desenvolvimento/

Operações Importação

Principais funcionalidades disponíveis:

  • Importação de Ativos:
    • Permite o upload de arquivos em lote, vinculando-os a uma operação específica do sistema.
    • Possibilita o acompanhamento detalhado do status e andamento da importação, bem como a consulta de arquivos e itens importados.
    • Permite ajustar metadados da importação, como quantidade de arquivos e finalização do processo.
    • Oferece mecanismos para registrar e consultar eventuais erros ocorridos durante a importação.
    • Todas as operações são restritas a usuários autenticados e com permissões adequadas para consulta ou alteração.
Operations

Incluir ativos via upload de arquivos

Request

Efetua a inclusão de ativos via upload de arquivos e retorna o id da importação

Path
idstringrequired

Id da operação

curl -i -X POST \
  'https://apidocs.ger26.com.br/_mock/apis/operacoes/v1/api/v1/operacoes/{id}/importacoes'

Responses

OK

Bodyapplication/json
idstring or nullrequired
Response
application/json
{
  "id": "string"
}

Recuperar a lista de arquivos da importação

Request

Retorna a lista de arquivos informando se ouve erro ou nõ

Path
idstringrequired

Id da operação

importacaoIdstringrequired

Id da importação

curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/apis/operacoes/v1/api/v1/operacoes/{id}/importacoes/{importacaoId}/arquivos'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired
arquivoZipstring or nullrequired
arquivostring or nullrequired
errostring or nullrequired
]
Response
application/json
[
  {
    "id": "string",
    "arquivoZip": "string",
    "arquivo": "string",
    "erro": "string"
  }
]

Recuperar o resultado das importação de um arquivo

Request

Retorna a lista de ativos importados em um arquivo e se houve erro ou não

Path
idstringrequired

Id da operação

importacaoIdstringrequired

Id da importação

arquivoIdstringrequired

Id do arquivo

curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/apis/operacoes/v1/api/v1/operacoes/{id}/importacoes/{importacaoId}/arquivos/{arquivoId}'

Responses

OK

Bodyapplication/jsonArray [
ativostring or nullrequired
vencimentostring(date-time)required
valornumber(double)required
sacadostring or nullrequired
cpfCnpjstring or nullrequired
errostring or nullrequired
]
Response
application/json
[
  {
    "ativo": "string",
    "vencimento": "2019-08-24T14:15:22Z",
    "valor": 0.1,
    "sacado": "string",
    "cpfCnpj": "string",
    "erro": "string"
  }
]

Recuperar o andamento da importação

Request

Retorna o andamento da importação

Path
idstringrequired

Id da operação

importacaoIdstringrequired

Id da importação

curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/apis/operacoes/v1/api/v1/operacoes/{id}/importacoes/{importacaoId}/andamento'

Responses

OK

Bodyapplication/json
quantidadeArquivosinteger or null(int32)required
quantidadeProcessadosinteger or null(int32)required
finalizadabooleanrequired
Response
application/json
{
  "quantidadeArquivos": 0,
  "quantidadeProcessados": 0,
  "finalizada": true
}

Atualiza a quantidade de arquivos

Request

Atualiza a informação da quantidade de arquivos totais que serão importados

Path
idstringrequired

Id da operação

importacaoIdstringrequired

Id da importação

Body
required

Erro da importação

importacaoIdstring or null
quantidadeinteger(int32)required
curl -i -X PATCH \
  'https://apidocs.ger26.com.br/_mock/apis/operacoes/v1/api/v1/operacoes/{id}/importacoes/{importacaoId}/quantidade' \
  -H 'Content-Type: application/json' \
  -d '{
    "importacaoId": "string",
    "quantidade": 0
  }'

Responses

OK

Response
No content

Atualiza a quantidade de arquivos

Request

Atualiza a informação da quantidade de arquivos totais que serão importados

Path
idstringrequired

Id da operação

importacaoIdstringrequired

Id da importação

Body
required

Erro da importação

importacaoIdstring or null
valorBrutonumber(double)required
curl -i -X PATCH \
  'https://apidocs.ger26.com.br/_mock/apis/operacoes/v1/api/v1/operacoes/{id}/importacoes/{importacaoId}/finalizada' \
  -H 'Content-Type: application/json' \
  -d '{
    "importacaoId": "string",
    "valorBruto": 0.1
  }'

Responses

OK

Response
No content

Registra os erros da importação em ativos

Request

Registra os erros da importação em ativos

Path
idstringrequired

Id da operação

importacaoIdstringrequired

Id da importação

Body
required

Erro da importação

arquivoIdstring or nullrequired
importacaoIdstring or null
arquivoZipstring or nullrequired
arquivostring or nullrequired
errostring or nullrequired
ativosArray of objects or null(ImportacaoStatusAtivoRequest)required
ativos[].​ativostring or nullrequired
ativos[].​vencimentostring(date-time)required
ativos[].​valornumber(double)required
ativos[].​sacadostring or nullrequired
ativos[].​cpfCnpjstring or nullrequired
ativos[].​errostring or null
curl -i -X POST \
  'https://apidocs.ger26.com.br/_mock/apis/operacoes/v1/api/v1/operacoes/{id}/importacoes/{importacaoId}/status' \
  -H 'Content-Type: application/json' \
  -d '{
    "arquivoId": "string",
    "importacaoId": "string",
    "arquivoZip": "string",
    "arquivo": "string",
    "erro": "string",
    "ativos": [
      {
        "ativo": "string",
        "vencimento": "2019-08-24T14:15:22Z",
        "valor": 0.1,
        "sacado": "string",
        "cpfCnpj": "string",
        "erro": "string"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
idstring or nullrequired

Id da operação criada

sequencialDiariointeger(int32)required

Sequencial diário da operação

cadastrostring(date-time)required

Data da criação da operação

Response
application/json
{
  "id": "string",
  "sequencialDiario": 0,
  "cadastro": "2019-08-24T14:15:22Z"
}

Operações Ativos

Principais funcionalidades disponíveis:

  • Inclusão de Ativos em Operações:
    • Possibilita importar e vincular arquivos ou registros de ativos a uma operação específica, garantindo que toda a documentação necessária fique centralizada no contexto da operação.
    • Função disponível apenas para usuários devidamente autorizados, cumprindo os critérios de permissão estabelecidos pelo sistema.
    • Geração de respostas padronizadas para sucesso, validação de dados, falhas de autenticação/autorização e casos em que a operação não é localizada.
Operations

Operações

Principais funcionalidades disponíveis:

  • Consulta de Operações:
    • Listagem de operações com múltiplos filtros (datas, status, tipos, ids, etc.).
    • Busca de detalhes completos de uma operação específica.
  • Cadastro e Alteração:
    • Permite cadastrar novas operações.
    • Altera dados das operações existentes.
  • Exclusão:
    • Remove uma operação e todos os ativos associados.
  • Alteração de Status e Situação:
    • Modifica o status ou situação da operação e de seus ativos relacionados.
Operations

Operações Status

Principais funcionalidades disponíveis:

  • Listar Status de Operação:
    • Consultar todos os status de operação registrados no sistema, facilitando análise e integração com outros módulos.
  • Consultar Detalhes de Status de Operação:
    • Obter informações detalhadas de um status específico, utilizando seu identificador único.
  • Cadastrar Novo Status de Operação:
    • Adicionar um novo status de operação, aumentando a flexibilidade nos fluxos de trabalho.
  • Atualizar Status de Operação:
    • Modificar dados de um status existente, permitindo ajustes conforme regras de negócio.
  • Excluir Status de Operação:
    • Remover um status de operação, ação restrita a usuários autorizados e auditada para garantir segurança.
Operations