Lista as NFes - Sensio API

Requisição

Parâmetros Query

type

string

opcional

Filtro de tipo opcional, valores possíveis "Saída", "Entrada"

status

string

opcional

valores possíveis "Autorizada", "Cancelada", "Denegada" e "Pendente"

dateInit

string

opcional

data inicial de criação

Exemplo:

YYYY-MM-DD

dateFinal

string

opcional

data final de criação

Exemplo:

YYYY-MM-DD

dateEmiInit

string

opcional

data inicial de emissão

Exemplo:

YYYY-MM-DD

dateEmiFinal

string

opcional

data final de criação

Exemplo:

YYYY-MM-DD

dateEntInit

string

opcional

data inicial de entrada

Exemplo:

YYYY-MM-DD

dateEntFinal

string

opcional

data final de criação

Exemplo:

YYYY-MM-DD

Exemplos de Requisição

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET '/nfes/list?type&status&dateInit=YYYY-MM-DD&dateFinal=YYYY-MM-DD&dateEmiInit=YYYY-MM-DD&dateEmiFinal=YYYY-MM-DD&dateEntInit=YYYY-MM-DD&dateEntFinal=YYYY-MM-DD'

Respostas

🟢200OK

application/json

Response

Body

success

boolean

opcional

Padrão:

true

message

string

opcional

Padrão:

NFes encontradas

response

array[object (nfeListObj) {9}]

opcional

chave

string

opcional

Chave de acesso da NFe

type

enum<string>

opcional

Tipo da NFe

Valores permitidos:

SaídaEntrada

date

string

opcional

Data da NFe

nNF

string

opcional

Número da NFe

status

enum<string>

opcional

Status da NFe

Valores permitidos:

AutorizadaPendenteCanceladaDenegada

customer

string

opcional

Destinatário/Emitente da NFe

customerId

string

opcional

Id do Destinatário/Emitente da NFe

sale

string

opcional

Id do pedido associado (se houver)

vNF

number

opcional

Valor total da NFe

Exemplo

{
    "success": true,
    "message": "NFes encontradas",
    "response": [
        {
            "chave": "string",
            "type": "Saída",
            "date": "string",
            "nNF": "string",
            "status": "Autorizada",
            "customer": "string",
            "customerId": "string",
            "sale": "string",
            "vNF": 0
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error