Obtém uma lista com dados dos documentos constantes no Portal.
Para realizar a continuação de uma busca:
GET /api/v1/{modelo}/lista/continua/{codigo_paginacao}
Exemplo:
GET /api/v1/nfe/lista/continua/c2NhbjswOzE7dG90YWxfaGl0czozOw==
Parâmetro | Conteúdo |
---|---|
modelo | para NF-e: nfe para CT-e: cte para NFC-e: nfce para CF-e: cfe |
codigo_paginacao | na primeira requisição: não informar nas demais: o código recebido na requisição anterior |
Retorna a quantidade total de documentos da busca, o código para a próxima página, e a lista de documentos.
{
"total": 3,
"proxima_pagina": "c2NhbjswOzE7dG90YWxfaGl0czozOw==",
"documentos": [
{
"id": "53d2f08f9711f6abe20009e7",
"chave": "35140443283811001040550010001000151082422890",
"emitido_em": "2014-04-08T00:00:00-03:00",
"serie": 1,
"numero": 100015,
"valor": "111.4",
"situacao_custodia": "ok",
"situacao_sefaz": 100,
"emit_cnpj": "43283811001040",
"emit_nome": "Kalunga Comercio Industria Grafica Ltda",
"dest_cnpj": "10967573000142",
"dest_nome": "MEp Consultoria"
},
{ ... },
{ ... }
]
}
Significa que a requisição não foi aceita. A mensagem de erro irá informar mais detalhes.
{ "error": "Código de paginação inválido ou não reconhecido: abcdef" }
Significa que sua chave de acesso não tem permissão para listar documentos.
{ "error": "Ação não permitida" }
Ocorreu um erro no processamento. A mensagem de erro irá informar mais detalhes.
{ "error": "Serviço de busca fora do ar" }
curl -H 'X-Consyste-Auth-Token: Yuom51QL22X_RNsJpG-z'
-H 'Content-Type: application/json'
-X GET 'https://portal.consyste.com.br/api/v1/nfe/lista/recebidos'