Torre Fiscal — API pública

1

Produção: https://api.sbff.miydas.com.br

Teste: https://sandbox.sbff.miydas.com.br

NFe

Notas Fiscais Eletrônicas (modelo 55): a fila de XMLs por papel da empresa (/v1/nfe/{role}), o upload em lote e os eventos (fila da conta e eventos de uma nota).

Papéis: received (destinatária), emitted (emitente), transporter (transportadora) e authorized (CNPJ/CPF citado em autXML).


Fila de XMLs de NF-e por papel da empresa

GET/v1/nfe/{role}

Documentos na ordem em que chegaram à conta, até 50 por página, pelo cursor.

  • cursor: posição estável (reprocesse voltando a 0); a próxima página está em page.next.
  • limit: até 50 (padrão 50; 0 também vale 50).
  • created_at[from]/created_at[to]: quando o documento chegou à conta, não a emissão.
  • cnpj[]: empresas donas do documento.
  • access_key[]: chaves de acesso.
  • format_type: XML em base64 ou JSON.

Parâmetros

Respostas

APPLICATION/JSON

Headers

X-RateLimit-Limit

Limite por minuto

integer
X-RateLimit-Remaining

Requisições restantes no minuto

integer
CampoTipoDescrição
status*object
code*integer
message*string
data*array[object]
access_key*stringChave de acesso
xml*string | objectO XML do documento
page*object
next*stringPróxima página (cursor + count)
previous*stringEsta página (o cursor pedido)
count*integerItens nesta página
signature*stringSHA-256 (hex) de `data` serializado como no json_encode do PHP
Sucesso
{
  "status": {
    "code": 200,
    "message": "Ok"
  },
  "data": [
    {
      "access_key": "35260911222333000181550010000000011000000019",
      "xml": "PD94bWwgdmVyc2lvbj0iMS4wIj8+PGV4ZW1wbG8vPg=="
    }
  ],
  "page": {
    "next": "https://api.exemplo.com.br/v1/nfe/received?limit=50&cursor=50",
    "previous": "https://api.exemplo.com.br/v1/nfe/received?limit=50&cursor=0"
  },
  "count": 1,
  "signature": "4f53cda18c2baa0c0354bb5f9a3ecbe5ed12ab4d8e11ba873c2f11161202b945"
}