Gestão de Pagamentos - Comprovantes

Lista os comprovantes de pagamento da conta com base nos filtros aplicados

Este endpoint permite buscar os comprovantes de pagamento da conta, retornando os dados conforme a projeção solicitada em Fields, com filtros por identificador, data de pagamento, documento do recebedor e faixa de valor.

O mesmo endpoint entrega o PDF do comprovante: basta incluir EncodedPdf em Fields. Nesse caso Filters.Identifier passa a ser obrigatório e a quantidade de identificadores por requisição é limitada (2 em produção).

A caixa das chaves é exigida. identifier, IDENTIFIER ou limit retornam 400 apontando a grafia correta, e o mesmo vale para os valores de Fields. Campo desconhecido retorna 400, nunca é descartado em silêncio.

Os comprovantes retornados são sempre restritos aos CNPJs/CPFs autorizados para as credenciais utilizadas. Comprovante fora desse escopo é indistinguível de comprovante inexistente: retorna 404, nunca 403.

O corpo da requisição é limitado a 1 MiB, e o tempo máximo de resposta é de 60 segundos.

post/v1/receipts/list

Request

Base URL: https://api.arquivei.com.br
URL: https://api.arquivei.com.br/v1/receipts/list
Auth: none declared. Required headers: X-Api-Id, X-Api-Key, X-Use-ApiGateway

Headers

X-Api-Idstring required

API ID usado para autenticação.

X-Api-Keystring required

API KEY usado para autenticação.

X-Use-ApiGatewaystring required

Este header indica que a request será roteada pelo API Gateway da Qive e o valor deve ser passado como always.

Request body

Fieldsstring[]

Fields são os campos que podem ser retornados na resposta, sensível a caixa. Caso nenhum seja passado, o padrão será "Identifier", "Source", "PaymentDate" e "Amount". Valor desconhecido retorna 400 citando o valor recebido.

Limitinteger

Limit é o tamanho da página, e não o teto do resultado: Total continua contando o conjunto filtrado inteiro. Padrão 50, máximo 500 (acima disso é limitado, não rejeitado). Com "EncodedPdf" em Fields e sem Limit, assume a quantidade de identificadores pedidos em Filters.Identifier.

Paginatorstring

Paginator é o cursor opaco devolvido pela página anterior. Vazio ou ausente significa a primeira página. Não é número de página nem offset, e não é intercambiável com o token de Identifier.

Example request

{
  "Fields": [
    "Identifier",
    "Amount",
    "Source",
    "PaymentDate",
    "CurrencyCode",
    "CodeAuth",
    "BankSlipNumber",
    "DueDate",
    "Payer",
    "Receiver",
    "EncodedPdf"
  ],
  "Filters": {
    "Identifier": [
      "ypVSWL_Cib9xU5VdCgCUTJvPNpvuWKPgfRfU8vMNPqiglrRVhQ",
      "bNrCAcsaGUsKpzzOkIsgfiwKjNOKzroZjpAb4_MFAJnvqeFV"
    ],
    "PaymentDate": {
      "From": "2024-04-01",
      "To": "2024-05-10"
    },
    "ReceiverDocument": [
      "22222222000191",
      "12345678909"
    ],
    "Amount": {
      "From": 100,
      "To": 150
    }
  },
  "Limit": 50
}

Response

HTTPReceiptListResponseV1 contém a resposta da chamada para a API de listagem de comprovantes.

Paginatorstring

Paginator é o cursor da próxima página. Vazio significa fim da listagem. Sendo cursor e não offset, uma linha inserida durante a paginação não faz páginas repetirem nem pularem registros.

Totalinteger

Total é a quantidade de comprovantes que casam com os filtros, ignorando Paginator e Limit.

Example response

{
  "Receipts": [
    {
      "Identifier": "ypVSWL_Cib9xU5VdCgCUTJvPNpvuWKPgfRfU8vMNPqiglrRVhQ",
      "Source": "manual",
      "PaymentDate": "2025-09-12",
      "Amount": 725.72,
      "CodeAuth": "aaaaaaaaxfdfgh",
      "BankSlipNumber": "34191090084550688091811216710001715020000072572",
      "DueDate": "2026-07-09",
      "Payer": {
        "Name": "CJR CONSTRUTORA LTDA",
        "Document": "03160081000185",
        "DocType": "CNPJ",
        "BankCode": "001",
        "BankName": "Banco do Brasil S.A."
      },
      "Receiver": {
        "Name": "Sotreq Fidc Responsabilidade",
        "Document": "52100879000147",
        "DocType": "CNPJ"
      },
      "EncodedPdf": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBl..."
    }
  ],
  "Paginator": "pTnnPsUwBq0GEduCzBT33YvFiZFAugZply48ayKIzA_Njx8pRTFE1iftCCnnK6-mxsCkmQ_4M3u4Xm4xe_wN",
  "Total": 26
}

Changes

No recorded changes to this operation across all 1 revision of this API.