Lista de documentos

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Query

Códigos de solicitação

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Respostas

🟢200Success

application/json

Body

Exemplo

{
    "status": "success",
    "code": 200,
    "message": "",
    "error": null,
    "data": [
        {
            "id": "87foo31dfb99e47dc186c1b32fooc4f2",
            "partnerId": null,
            "internalCode": null,
            "isCancelled": false,
            "storeDocument": "05887887000187",
            "storeName": "Loja S.A",
            "number": "1174118",
            "purchaseDate": "2025-01-02T00:00:00-03:00",
            "value": 428.89,
            "totalValue": 428.89,
            "message": "",
            "created": "2025-02-12T16:24:41-03:00",
            "statusEnum": 8,
            "status": "processing",
            "documentTypeEnum": 1,
            "documentType": "receipt"
        },
        {
            "id": "87foo31dfb99e47dc186c1b32fooc4f2",
            "partnerId": null,
            "internalCode": null,
            "isCancelled": false,
            "storeDocument": "05887887000187",
            "storeName": "Loja S.A",
            "number": "1174118",
            "purchaseDate": "2025-01-02T00:00:00-03:00",
            "value": 428.89,
            "totalValue": 428.89,
            "message": "",
            "created": "2025-02-12T16:24:41-03:00",
            "statusEnum": 64,
            "status": "quarantine",
            "documentTypeEnum": 8,
            "documentType": "nfce"
        },
        {
            "id": "87foo31dfb99e47dc186c1b32fooc4f2",
            "partnerId": null,
            "internalCode": null,
            "isCancelled": false,
            "storeDocument": "05887887000187",
            "storeName": "Loja S.A",
            "number": "1174118",
            "purchaseDate": "2025-01-02T00:00:00-03:00",
            "value": 428.89,
            "totalValue": 428.89,
            "message": "Documento ilegível",
            "created": "2025-02-12T16:24:41-03:00",
            "statusEnum": 1,
            "status": "invalid",
            "documentTypeEnum": 1,
            "documentType": "receipt"
        }
    ]
}