1. Operações
Qprof
  • Qprof API
    • Guia de Integração
      • Primeiros Passos & Autenticação
      • Compressão gzip
    • Autenticação
      • Geração de token de acesso
    • Consultas
      • Consultar espécies de documento (Versão 1.0.0)
      • Consultar indexadores (Versão 1.0.0)
      • Consultar rótulos (Versão 1.0.0)
      • Consultar motivos controladoria (Versão 1.0.0)
    • Cadastro Pessoa
      • Agente
        • Consultar
        • Inserir
        • Atualizar
        • Excluir
      • Cadastrar Pessoa (Versão 1.0.0)
      • Cadastrar Representante (Versão 1.0.0)
      • Cadastrar Contrato/Modalidade (Versão 1.0.0)
      • Consultar Listas de Valores (Versão 1.0.0)
      • Cadastrar Cônjuge (Versão 1.0.0)
      • Cadastrar Conta e Favorecido (Versão 1.0.0)
      • Cadastro Contrato Geral
      • Cadastro de Observação Pessoa (Versão 1.0.0)
      • Atualizar Faturamento
    • Cedente
      • Tarifas
        • Consultar
        • Inserir
        • Atualizar
        • Excluir
      • Informações Operacionais
    • Cobrança
      • Consultar Status
      • Inserir Ocorrência de Cobrança em Título
      • Importar Retorno Bancário
    • Operações
      • Importar Títulos (Versão 5.0.0)
        POST
      • Listar Favorecido
        GET
      • Importar CNAB (Versão 2.0.0)
        POST
      • Simular Operação (Versão 2.0.0)
        POST
      • Importar Documento
        POST
      • Consultar Títulos (Versão 2.0.0)
        GET
      • Emitir Boletos
        POST
      • Validar Acesso
        GET
      • Instruções a Regularizar (Versão 1.0.0)
        POST
      • Consulta Arquivos de Retorno Cedente (Versão 1.0.0)
        POST
      • Consulta de Operações (Versão 2.0.0)
        GET
      • Consulta de Tarifas de Operação (Versão 1.0.0)
        POST
      • Operação de Crédito Estruturado (Versão 2.0.0)
        POST
      • Importar Documento (sem borderô)
        POST
    • Relatórios
      • Emitir Relatório (Versão 1.0.0)
    • Retorno de Status de Operação
      • Callback: Retorno de Status de Operação (`atualizaStatus`)
    • Monitoramento NFe
      • Monitoramento NFe — Visão Geral do Fluxo
      • Callback: Início do Monitoramento (`monitoraNfe`)
      • Callback: Parar/Continuar Monitoramento (`alteraStatusMonitoramento`)
      • Receber Status Monitoramento
    • Controladoria
      • Atualizar Status Checagem Título
      • Inserir Ocorrência de Controladoria em Título
      • Atualizar Títulos em Tranche
      • Atualizar Chave Fiscal Título
    • Esquemas
      • importar_retorno_bancario
      • importar_retorno_bancario_success
      • authorization_request
      • authorization_response_denied
      • importar_operacao
      • importar_operacao_2
      • valores_titulo
      • valor_titulo
      • valores_titulo_2
      • valor_titulo_2
      • valores_titulo_3
      • valor_titulo_3
      • telefone
      • valores_titulo_5
      • endereco
      • valor_titulo_5
      • simular_operacao
      • simular_operacao_v2
      • lista_titulo
      • info_titulo
      • importar_operacao_request_sucess
      • importar_documento_request_sucess
      • simular_operacao_request_sucess
      • simular_operacao_request_sucess_v2
      • importar_operacao_request_denied
      • simular_operacao_request_denied
      • importar_documento_request_denied
      • importar_operacao_request_failed
      • simular_operacao_request_failed
      • importar_documento_request_failed
      • retorna_status_ope
      • titulos
      • titulo
      • titulos_importados
      • sequencial
      • sequencial1
      • retorna_status_resultado
      • monitora_status_nfe
      • atualiza_status_checagem_titulo
      • inserir_ocorrencia_controladoria_titulo
      • inserir_ocorrencia_cobranca_titulo
      • atualiza_titulo_tranche
      • notasV2
      • notaV2
      • monitora_nfe_sucess
      • atualiza_chave_fiscal_titulo
      • atualiza_status_checagem_sucesso
      • atualizar_chave_fiscal_titulo_sucesso
      • atualizar_titulo_tranche_sucesso
      • insert_ocorr_cob_success
      • monitora_nfe_error
      • monitora_nfe_denied
      • consultar_titulo
      • consultar_titulo_request_denied
      • consultar_titulo_request_failed
      • consultar_titulo_request_sucess
      • lista_titulo_cliente
      • consultar_titulo_request_sucess_v2
      • lista_titulo_cliente_v2
      • emitir_boletos
      • lista_titulo_boleto
      • emitir_boletos_request_denied
      • emitir_boletos_request_failed
      • importar_operacao_cnab
      • favorecidos
      • informacao
      • lista_fav_request_sucess
      • lista
      • importar_operacao_3
      • valida_acesso
      • request_denied
      • request_failed
      • titulos_e_suas_instruções
      • lista_titulo_instrucoes_a_regularizar
      • consultar_arquivos_retorno_cedente
      • consultar_status_inst
      • cadastrar_conjuge_pess
      • cadastrar_representante_pess
      • cadastrar_contrato_pess
      • cadastrar_pss
      • cadastrar_conta_favorecido
      • status_inst_request_sucess
      • cadastro_conta_favorecido_status
      • cadastro_conjuge_status
      • cadastro_pessoa_status
      • cadastro_represen_status
      • cadastro_contrato_status
      • lista_instrucoes
      • instrucao
      • info_operacionais
      • info_operacionais_sucess
      • tarifas_consulta_request
      • tarifas_inserir_request
      • tarifas_atualizar_request
      • tarifas_excluir_request
      • tarifas_consulta_result
      • tarifas_consulta
      • debito_credito
      • concentracao_sacado
      • sacados
      • limites_contrato
      • limites
      • consultar_operacoes_retorno
      • consultar_operacoes_retorno_v2
      • consultar_tarifas_operacao_retorno
      • consultar_operacoes_request_sucess
      • consultar_operacoes_request_sucess_v2
      • consultar_tarifas_operacoes_request_sucess
      • lista_operacoes_na_data
      • emitir_relatorio
      • lista_resposta_consulta_especies_documento
      • resposta_consulta_especie_documento
      • lista_resposta_consulta_indexadores
      • resposta_consulta_indexadores
      • lista_resposta_consulta_rotulos
      • resposta_consulta_rotulos
      • credito_estruturado_request_sucess
      • credito_estruturado_request_sucess_v2
      • operacao_credito_estruturado
      • detalhamento_parcelas
      • parcela_info
      • importar_operacao_4
      • importar_operacao_cnab_2
      • person_observation_attributes
      • person_observation_success
      • agente_consulta_request
      • agente_update_insert_request
      • importar_operacao_5
      • agente_consulta_result
      • agente_update_result
      • agente_insert_result
      • agente_delete_result
      • contrato_geral_insert
      • regra_filtro
  • OData Standard
    • Visão Geral
    • Guia de Conexão
      • Conexão via Power BI e Excel
      • Conexão via Postman
      • Conexão via Python
    • Dicionário de Dados
      • Definições
      • Entidades
    • Base de Conhecimento
      • FAQ — Exemplos de Consultas
      • Análise de Crédito — Baixados no Período
      • Medidas DAX (Power BI)
  1. Operações

Instruções a Regularizar (Versão 1.0.0)

POST
/servicos/operacao/gerarInstrucao
Nota: Devido a possibilidade de haver uma grande massa de dados neste Método o conteúdo do body da requisição deve ser comprimido para otimizar a velocidade da chamada e resposta da requisição.
Retorno do método está em G-Zip e convertido para Base64 (o conteúdo do arquivo é compactado por padrão para otimização da resposta da requisição, devido a possibilidade de uma grande massa de dados.)
O conteúdo do arquivo compactado é um arquivo Json com a estrutura documentada a seguir:

    [
       {
          "codigo_empresa":1,
          "codigo_filial":1,
          "sequencial_titulo":1,
          "instrucao":"A",
          "sucesso":false,
          "error":{
             "code":4,
             "message":"Título não encontrado."
          }
       },
       {
          "codigo_empresa":1,
          "codigo_filial":1,
          "sequencial_titulo":2,
          "instrucao":"A",
          "sucesso":false,
          "error":{
             "code":4,
             "message":"Instrução não permitida ou já realizada."
          }
       },
       {
          "codigo_empresa":1,
          "codigo_filial":1,
          "sequencial_titulo":3,
          "instrucao":"E",
          "sucesso":false,
          "error":{
             "code":4,
             "message":"Instrução não permitida ou já realizada."
          }
       },
       {
          "codigo_empresa":1,
          "codigo_filial":1,
          "sequencial_titulo":4,
          "instrucao":"C",
          "sucesso":false,
          "error":{
             "code":4,
             "message":"Instrução não permitida ou já realizada."
          }
       },
       {
          "codigo_empresa":1,
          "codigo_filial":1,
          "sequencial_titulo":5,
          "instrucao":"B",
          "sucesso":false,
          "error":{
             "code":4,
             "message":"Instrução não permitida ou já realizada."
          }
       },
       {
          "codigo_empresa":1,
          "codigo_filial":1,
          "sequencial_titulo":6,
          "instrucao":"P",
          "sucesso":false,
          "error":{
             "code":3,
             "message":"Data de prorrogação deve ser maior que a data de vencimento ou igual a data atual."
          }
       },
       {
          "codigo_empresa":1,
          "codigo_filial":1,
          "sequencial_titulo":7,
          "instrucao":"S",
          "sucesso":true,
          "error":null
       }
    ]

Estrutura do Json#

PropriedadeTipoDescrição
codigo_empresaNumberCódigo da empresa.
codigo_filialNumberCódigo da filial.
sequencial_tituloNumberSequencial do título (máx 11)
instrucaoStringTipo de Instrução
sucessoBoleanotrue em caso de sucesso ou false em caso erro
errorStringSe ocorrer um erro na geração da instrução retornará aqui.
⚠️ Compressão obrigatória: o corpo desta requisição (JSON) deve ser enviado comprimido em gzip.

Requisição

Parâmetros de Consulta

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200
text/plain
OK
🟠400
🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://prod.your-api-server.com/servicos/operacao/gerarInstrucao?version=1.0.0' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '[
    {
        "codigo_empresa": 1,
        "codigo_filial": 1,
        "sequencial_titulo": 1,
        "instrucao": "A",
        "valor": 7000,
        "motivo": "teste abatimento 7.500,00"
    },
    {
        "codigo_empresa": 1,
        "codigo_filial": 1,
        "sequencial_titulo": 2,
        "instrucao": "A",
        "valor": 150.1,
        "motivo": "teste abatimento 10.000,00"
    },
    {
        "codigo_empresa": 1,
        "codigo_filial": 1,
        "sequencial_titulo": 3,
        "instrucao": "E",
        "motivo": "teste encaminhar protesto"
    },
    {
        "codigo_empresa": 1,
        "codigo_filial": 1,
        "sequencial_titulo": 4,
        "instrucao": "C",
        "motivo": "teste Nao Encaminhar Protesto",
        "data": "2022-06-27"
    },
    {
        "codigo_empresa": 1,
        "codigo_filial": 1,
        "sequencial_titulo": 5,
        "instrucao": "B",
        "motivo": "teste Pedido Baixa"
    },
    {
        "codigo_empresa": 1,
        "codigo_filial": 1,
        "sequencial_titulo": 6,
        "instrucao": "P",
        "motivo": "teste Prorrogacao",
        "data": "2022-06-24"
    },
    {
        "codigo_empresa": 1,
        "codigo_filial": 1,
        "sequencial_titulo": 7,
        "instrucao": "S",
        "motivo": "teste Sustacao",
        "data": "2022-07-01"
    }
]'
Response Response Example
200 - Sucesso
H4sIAAAAAAAAC+2Uv07DMBDG9z7FyXOFBBSQsvFvYEOCDaHqFF8jI8cOZ7sDqA+DGJh4irwYTkOkpq2HDKAOucm+786++w3f0wTaeO8OOyFyK1Vh51RWTA5Fdjyd7KoLpRXqbdHRayCTR2XulQ/abhco4zyHHKMgLkW/N+TkXBQWqB31JGK2LLL0zN1kJLLZZmeTLuOrWERFPNbfzUxg6k8LcUxrPKO0R2KjY7X3j9X037mdHA63u/Xn9VeDbc2uIi6VVxLBBnipP4AJtXpDiYfJ8jTJ8nZkOZDlLMnyemQ5kOVZkuXVyHIgy/Mky/s/YdnzlL5f3qBHkARVfI1tga1zSloSOGIoUVmGuADEqt/SZbNNScbbxlJVEVB3Kvp4OUxfvUgyf0gwjwV7kZugdZdu13v+AVK4mfCrCAAA
Modificado em 2026-06-30 19:55:16
Página anterior
Validar Acesso
Próxima página
Consulta Arquivos de Retorno Cedente (Versão 1.0.0)
Built with