NFe

Lista as NFes da conta com base nos filtros aplicados

Este endpoint permite buscar todas as NFes da conta, retornando os dados conforme a projeção solicitada, além de permitir novos filtros como chave de acesso, CNPJ do emitente, transportador e destinatário, status da NFe, entre outros.

post/v2/dfe/nfe

Request

  • Base URL: https://api.arquivei.com.br
  • URL: https://api.arquivei.com.br/v2/dfe/nfe
  • 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, caso nenhum seja passado, o padrão será "Xml" e "AccessKey".

Limitinteger

Limit é a quantidade máxima de resultados a serem retornados (padrão 500, máximo 500)

Paginatorstring

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

Example request

{
  "Fields": [
    "Xml",
    "Origin",
    "FlagErp",
    "CustomData",
    "Document",
    "Events",
    "Tags",
    "Cfops",
    "AccessKey",
    "EmissionDate",
    "CreatedAt",
    "HasCCE",
    "Manifestations",
    "Number",
    "Owner",
    "OwnerRole",
    "Receiver",
    "Emitter",
    "Status"
  ],
  "Filters": {
    "CreatedAt": {
      "From": "2006-01-02",
      "To": "2006-01-02 23:59:59"
    },
    "EmissionDate": {
      "From": "2006-01-02",
      "To": "2006-01-02 23:59:59"
    },
    "DocumentIdentifier": "12345678901234567890123456789012345678901234",
    "EmitterCnpj": [
      "12345678000195",
      "98765432000195"
    ],
    "TransporterCnpj": [
      "12345678000195",
      "98765432000195"
    ],
    "ReceiverCnpj": [
      "12345678000195",
      "98765432000195"
    ],
    "Owners": [
      "12345678000195",
      "98765432000195"
    ],
    "Status": "canceled",
    "Origins": [
      "sefaz",
      "upload"
    ],
    "HasCCE": true,
    "HasEvent": true,
    "HasManifestation": true,
    "HasXPed": true,
    "Cfops": [
      "5102",
      "6102"
    ],
    "NfeNumber": {
      "From": 1,
      "To": 10
    },
    "Tags": [
      1,
      2
    ],
    "TagsAll": [
      1,
      2
    ],
    "XPeds": [
      "12345",
      "54321"
    ],
    "OwnerRoles": [
      "receiver",
      "emitter",
      "transporter",
      "authorized"
    ],
    "FinNFe": [
      "1",
      "4"
    ],
    "CustomData": [
      {
        "Name": "categoria",
        "Values": [
          "compras",
          "insumos"
        ]
      }
    ]
  },
  "Limit": 100,
  "Paginator": "[\"75e7ccc0a702d0a823a2ef073a023c8fc9afedf7\"]"
}

Response

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

Paginatorstring

Paginator é a hash utilizada para a próxima página de NFes encontradas.

Totalinteger

Total é a quantidade total de NFes obtida na listagem

Example response

{
  "Nfes": [
    {
      "CustomData": [
        {
          "Name": "categoria",
          "Values": [
            "compras",
            "insumos"
          ]
        }
      ]
    }
  ]
}

Changes

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