NFSe

Lista as NFses da conta com base nos filtros aplicados

Este endpoint permite buscar todas as NFses da conta, retornando os dados das NFSes obtidas.

post/v1/dfe/nfse

Request

  • Base URL: https://api.arquivei.com.br
  • URL: https://api.arquivei.com.br/v1/dfe/nfse
  • 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

paginatorstring

Paginator é uma string contendo a informação da próxima página de resultados obtidos

Example request

{
  "filters": {
    "createdAt": {
      "From": "2006-01-02",
      "To": "2006-01-02 23:59:59"
    },
    "documentIdentifier": "76564624000101:03160081000185:2025-09-24:1",
    "emissionDate": {
      "From": "2006-01-02",
      "To": "2006-01-02 23:59:59"
    },
    "emitterCnpj": [
      "12345678000195",
      "98765432000195"
    ],
    "isCanceled": "true",
    "origin": "nacional",
    "owners": [
      "12345678000195",
      "98765432000195"
    ],
    "takerCnpj": [
      "12345678000195",
      "98765432000195"
    ],
    "ownerRoles": [
      "emitter",
      "taker",
      "intermediate"
    ],
    "competence": [
      "2025-09"
    ],
    "customData": [
      {
        "Name": "categoria",
        "Values": [
          "compras",
          "insumos"
        ]
      }
    ]
  },
  "fields": [
    "xmlAbrasf",
    "xmlAbrasfRtc",
    "originalXml",
    "origin",
    "flagErp",
    "customData",
    "document"
  ],
  "paginator": "eyJwYWdlIjoyfQ=="
}

Response

HTTPNfseListResponseV1 contém a resposta da chamada para a API de listagem de NFes.

paginatorstring

Token de paginação para a próxima consulta, se houver mais resultados.

totalinteger

Total de NFS-e encontradas na consulta.

Example response

{
  "nfses": [
    {
      "customData": [
        {
          "Name": "categoria",
          "Values": [
            "compras",
            "insumos"
          ]
        }
      ],
      "event": [
        {
          "origin": "NACIONAL",
          "type": "101101"
        }
      ]
    }
  ],
  "paginator": "eyJwYWdlIjoyfQ==",
  "total": 20
}

Changes

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