Consulta Arquivos de Retorno Cedente (Versão 1.0.0)

Método que retorna os arquivos do retorno de cedente de um cedente dentro de um período.Por padrão será limitado a 10 registros. Essa quantidade pode ser configurada pela equipe do Q'Prof pela constante (1979 - Quantidade de registros retornados na "Consulta de Arquivos de Retorno Cedente" via API).

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": 0,
    "codigo_filial": 0,
    "nome_empresa": "Nome Empresa",
    "nome_filial": "Nome Filial",
    "nome_arquivo": "Nome do Arquivo",
    "arquivo_base64": "MDJSRVRPUk5PMDFDT0JSQU5DQSAgICAg"
  }
]

Estrutura do Json

Propriedade	Tipo	Descrição
codigo_empresa	Number	Código da empresa.
codigo_filial	Number	Código da filial.
nome_empresa	String	Nome da empresa (máx 55)
nome_filial	String	Nome da filial (máx 45)
nome_arquivo	String	Nome do arquivo (máx 240)
arquivo_base64	String	Arquivo em Base64.

curl --location 'https://prod.your-api-server.com/servicos/operacao/arquivoRetornoCedente?version=1.0.0' \ --header 'Authorization: Bearer {{token}}' \ --header 'Content-Type: application/json' \ --data '{ "cpf_cnpj_cedente": "00.000.000/0000-00", "data_de": "2022-07-01", "data_ate": "2022-07-01" }'

Consulta Arquivos de Retorno Cedente (Versão 1.0.0)

Estrutura do Json

Requisição

Respostas

Consulta Arquivos de Retorno Cedente (Versão 1.0.0)

Estrutura do Json#

Requisição

Respostas

Estrutura do Json