Consulta de Notas Fiscais

Endpoint

Consulta paginada de notas fiscais

get

Consulta paginada com filtro das notas do usuário autenticado

Authorizations

Query parameters

searchstringoptional

Parâmetro de texto para a busca

perPagenumberrequired

Número de registros por página

pagenumberrequired

Página de resultados a ser recuperada (0..N)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://apim.niiw.io/api/receipt/pager/query/search?perPage=1&page=1' \
  --header 'Authorization: Bearer JWT'

200

404

200

{
  "page": 1,
  "perPage": 1,
  "total": 1,
  "list": [
    {
      "_id": "text",
      "origin": {
        "qrcode": "text",
        "url": "text",
        "params": "text",
        "accessCode": "text",
        "state": "text",
        "type": "text"
      },
      "company": {
        "cnpj": "text",
        "matrixBranchIdentifier": "text",
        "registrationStatus": "text",
        "registrationStatusDate": "2025-04-03T22:40:44.625Z",
        "startActivityDate": "2025-04-03T22:40:44.625Z",
        "mainFiscalCnae": "text",
        "cnae": "text",
        "mainActivity": [
          "text"
        ],
        "secondaryActivities": [
          "text"
        ],
        "street": "text",
        "number": "text",
        "complement": "text",
        "neighborhood": "text",
        "postalCode": "text",
        "state": "text",
        "city": "text",
        "phones": [
          "text"
        ],
        "email": "text",
        "image": "text",
        "tradeName": "text",
        "streetType": "text",
        "legalName": "text"
      },
      "data": {
        "number": "text",
        "issueDate": "2025-04-03T22:40:44.625Z",
        "authorizationDate": "2025-04-03T22:40:44.625Z",
        "authorizationProtocol": "text",
        "accessKey": "text",
        "taxpayerInterest": "text",
        "consumerData": "2025-04-03T22:40:44.625Z",
        "quantityItems": 1,
        "value": 1,
        "discount": 1,
        "valueToPay": 1,
        "formOfPayment": "text",
        "change": 1,
        "tax": 1,
        "sefaz": "text",
        "serie": "text"
      },
      "nfce": {
        "xmlVersion": "text",
        "accessKey": "text",
        "numberNFC": "text",
        "issueDate": "2025-04-03T22:40:44.625Z",
        "model": "text",
        "serie": "text",
        "inOutDate": "text",
        "totalValue": {},
        "qrCode": "text",
        "eventsNFe": "text",
        "protocol": "text",
        "dateTime": "2025-04-03T22:40:44.625Z",
        "baseCalculationICMS": 1,
        "valueICMS": 1,
        "baseCalculationICMSST": 1,
        "valueICMSReplacement": 1,
        "valueICMSFCPUFDest": 1,
        "valueICMSIntUFDest": 1,
        "valueICMSIntUFRemet": 1,
        "valueTotalProducts": 1,
        "valueTransport": 1,
        "valueInsurance": 1,
        "otherAdditionalCost": 1,
        "totalValueIPI": 1,
        "totalValueNFCe": 1,
        "totalValueDiscount": 1,
        "totalValueII": 1,
        "valuePIS": 1,
        "valueCONFINS": 1,
        "transportModality": "text",
        "formOfPayment": "text",
        "valuePaid": 1,
        "typeCharge": "text",
        "documentAcquirer": "text",
        "operatorFlag": "text",
        "numberAuthorization": "text",
        "printFormatDANFE": "text",
        "xsltVersion": "text",
        "complementInformationTaxPayer": "text"
      },
      "items": [
        "text"
      ]
    }
  ]
}

---

Exemplo cURL

curl -X 'GET' \
  'https://apim.niiw.io/api/receipt/pager/query/search?perPage=1&page=1' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciO....................................'

Exemplo Response Body

{
  "page": 1,
  "perPage": 1,
  "total": 128,
  "list": [
    {
      "_id": "650........",
      "origin": {
        "qrcode": "5323........",
        "accessCode": "5323........",
        "state": "DF",
        "type": "NFCe"
      },
      "company": {
        "cnpj": "213........",
        "matrixBranchIdentifier": "2",
        "registrationStatus": "ATIVA",
        "registrationStatusDate": "2017-06-06T00:00:00.000Z",
        "startActivityDate": "2017-06-06T00:00:00.000Z",
        "mainFiscalCnae": "47........",
        "cnae": "Seç........",
        "mainActivity": [
          {
            "code": "471........",
            "text": "Com........"
          }
        ],
        "secondaryActivities": [
          {
            "code": "00........",
            "text": "Não........"
          }
        ],
        "street": "RUA........",
        "number": "S/N",
        "complement": "LOT........",
        "neighborhood": "SUL........",
        "postalCode": "71........",
        "state": "DF",
        "phones": [
          "61........"
        ],
        "email": "nad......",
        "tradeName": "BEL......",
        "streetType": "FILIAL",
        "legalName": "SIC........"
      },
      "data": {
        "number": "13........",
        "issueDate": "2023-09-05T18:17:29.000Z",
        "authorizationDate": "2023-09-10T15:06:54.000Z",
        "authorizationProtocol": "3532........",
        "accessKey": "5323........",
        "taxpayerInterest": "13........",
        "quantityItems": 9,
        "value": 64.91,
        "discount": 0,
        "valueToPay": 64.91,
        "formOfPayment": "Cartão de Débito",
        "change": 0,
        "tax": 30.34,
        "serie": "107"
      },
      "nfce": {
        "xmlVersion": "4.00",
        "accessKey": "53-2........",
        "numberNFC": "135........",
        "issueDate": "2023-09-05T18:17:29.000Z",
        "model": "65",
        "serie": "107",
        "totalValue": "64,91",
        "qrCode": "http://dec.fazend........",
        "eventsNFe": "Auto........,
        "protocol": "353........",
        "dateTime": "2023-09-10T15:06:54.000Z",
        "baseCalculationICMS": 0.18,
        "valueICMS": 0.04,
        "baseCalculationICMSST": 0,
        "valueICMSReplacement": 0,
        "valueICMSFCPUFDest": 0,
        "valueICMSIntUFDest": 0,
        "valueICMSIntUFRemet": 0,
        "valueTotalProducts": 64.91,
        "valueTransport": 0,
        "valueInsurance": 0,
        "otherAdditionalCost": 0,
        "totalValueIPI": 0,
        "totalValueNFCe": 64.91,
        "totalValueDiscount": 0,
        "totalValueII": 0,
        "valuePIS": 0,
        "valueCONFINS": 0,
        "transportModality": "9-SemFrete",
        "formOfPayment": "4 - Cartão de Débito",
        "valuePaid": 64.91,
        "operatorFlag": "99 - Outros",
        "numberAuthorization": "09........",
        "printFormatDANFE": "4 - DAN........,
        "xsltVersion": "v3.1.0",
        "complementInformationTaxPayer": "Tri........"
      },
      "items": [
        {
          "code": "62........",
          "description": "BEB........",
          "quantity": 1,
          "unit": "UN",
          "unitValue": 29.99,
          "value": 29.99,
          "ncm": "22042100",
          "ncmName": "Vin........",
          "cfop": "5405",
          "valueDiscount": 0,
          "valueTransport": 0,
          "valueInsurance": 0,
          "originGoods": "0 - Nacional",
          "tributationICMS": "60 - ICMS........",
          "baseCalculationICMSNormal": 0,
          "aliquotICMSNormal": 0,
          "valueICMSNormal": 0,
          "comercialCodeEAN": "779........",
          "comercialUnit": "UN",
          "comercialQuantity": 1000,
          "tributableCodeEAN": "779........",
          "tributableUnit": "UN",
          "tributableQuantity": 1000,
          "comercializationUnitValue": 29.99,
          "tributalizationUnitValue": 29.99,
          "tributeValueAproximated": 14.2
        }
      ]
    }
  ]
}