Rota retorna o resultado do processamento do último, último autorizado ou todos Manifestos Do Destinatário ou Desacordos com a Prestação do Serviço.
GET
https://app.plugstorage.com.br/api/v2/manifests/index?invoice_key=chaveNF&cnpj_cpf=cnpj/cpfCliente
Querystring
| Nome | Descrição | Obrigatório | Valores aceitos |
| cnpj_cpf | Cnpj/CPF do cliente nota segura | Sim | |
|
invoice_key
|
Chave do documento | Sim | |
|
filter_type
|
Tipo de filtro para retorno de manifestos | Não | all, last e last_authorized |
|
page
|
Número da página | Não | Ex: 1, 2, 3 ... |
Headers
| Nome | Valor | Descrição |
| Authorization | Basic encode64(TokenSH:senha) | Token de identificação da sua Software House : Senha do usuário da Software House |
| Content-Type | application/x-www-form-urlencoded ou application/json |
Retorno
Exemplo de retorno de validações:
{
"error": true,
"message": "Parâmetro "invoice_key" não informado ou inválido."
}
{
"error": true,
"message": "Parâmetro 'filter_type' inválido. Valores aceitos: 'last_authorized', 'all' ou 'last'."
}
Exemplo de retorno NF-e:
{
"error": false,
"status": "success",
"message": "Manifesto encontrado.",
"data": {
"id": "1153591",
"invoice_id": "69461855",
"invoice_mod": "NFE",
"invoice_key": "41200902368443000165550010000090461100090461",
"softwarehouse_id": "141",
"user_id": "8308",
"type": "CIENCIA",
"datetime": "2020-09-22 11:00:31",
"justify": "Ciencia da operação",
"status": "SUCCESS",
"environment": "1",
"created_at": "2020-09-22 11:00:31",
"status_description": "Evento registrado e vinculado a NF-e"
}
}
Exemplo de retorno NF-e utilizando all:
{
"error": false,
"status": "success",
"message": "Manifesto encontrado.",
"data": {
"events":[
{
"id": "2",
"invoice_key": "51190218582206000132558040000003281000000001",
"softwarehouse_id": "2",
"user_id": "8308",
"type": "CONFIRMAR",
"protocol": "0",
"sequence": "1",
"status_description": "Evento registrado e vinculado a NF-e",
"event_date": "2024-11-13 16:03:00",
"created_at": "2024-11-13 16:00:00",
"invoice_mod": "NFE",
"status": "SUCCESS"
},
{
"id": "3",
"invoice_key": "51190218582206000132558040000003281000000001",
"softwarehouse_id": "2",
"user_id": "8308",
"type": "NAO_REALIZADA",
"protocol": "0",
"sequence": "2",
"status_description": "Rejeicao: Duplicidade de evento",
"event_date": "2024-11-13 17:01:00",
"created_at": "2024-11-13 17:00:00",
"invoice_mod": "NFE",
"status": "ERROR"
}
],
"NextPage": true
}
}
Obs: Lembrando que só vai retornar NextPage: true, quando tiver mais de 10 registros de manifestos, e serve para usar na busca da próxima página, partindo da número 1.
Exemplo de retorno NF-e utilizando last_authorized:
{
"error": false,
"status": "success",
"message": "Manifesto encontrado.",
"data": {
"id": "1",
"invoice_key": "41190218582206000132558040000003281000000013",
"softwarehouse_id": "1",
"user_id": "8308",
"type": "CIENCIA",
"protocol": "891240001055769",
"sequence": "1",
"status_description": "Evento registrado e vinculado a NF-e",
"event_date": "2024-11-13 17:01:00",
"created_at": "2024-11-13 17:00:00",
"invoice_mod": "NFE",
"status": "SUCCESS"
}
}
Exemplo de retorno CT-e:
{
"error": false,
"status": "success",
"message": "Manifesto encontrado.",
"data": {
"id": "1",
"invoice_id": "1",
"invoice_mod": "CTE",
"invoice_key": "41190218582206000132578040000003281000000011",
"softwarehouse_id": "1",
"user_id": "8308",
"type": "DESACORDO",
"datetime": "2024-07-25 11:35:00",
"justify": "Tomador incorreto na nota",
"status": "SUCCESS",
"environment": "1",
"created_at": "2024-07-25 11:34:00",
"status_description": "Evento registrado e vinculado a CT-e.",
"date_emission": null
}
}
Exemplo de retorno CT-e utilizando all:
{
"error": false,
"status": "success",
"message": "Manifesto encontrado.",
"data": {
"events":[
{
"id": "1",
"invoice_key": "41190218582206000132578040000003281000000011",
"softwarehouse_id": "1",
"user_id": "8308",
"type": null,
"protocol_event_cte": "141240000093984",
"protocol": "141240000093984",
"sequence": "1",
"status_description": "Prestacao do Servico em Desacordo",
"event_date": "2024-11-13 12:01:30",
"created_at": "2024-11-13 11:32:56",
"invoice_mod": "CTE",
"status": "SUCCESS"
},
{
"id": "2",
"invoice_key": "41190218582206000132578040000003281000000011",
"softwarehouse_id": "2",
"user_id": "8308",
"type": null,
"protocol_event_cte": "141240000096042",
"protocol": "141240000096042",
"sequence": "2",
"status_description": "Cancelamento Prestacao do Servico em Desacordo",
"event_date": "2024-11-13 12:20:30",
"created_at": "2024-11-13 12:15:56",
"invoice_mod": "CTE",
"status": "SUCCESS"
}
],
"NextPage": true
}
}
Obs: Lembrando que só vai retornar NextPage: true, quando tiver mais de 10 registros de manifestos, e serve para usar na busca da próxima página, partindo da número 1.
Exemplo de retorno CT-e utilizando last_authorized:
{
"error": false,
"status": "success",
"message": "Manifesto encontrado.",
"data": {
"id": "1",
"invoice_key": "41190218582206000132578040000003281000000011",
"softwarehouse_id": "1",
"user_id": "8308",
"type": null,
"protocol_event_cte": "141240000096042",
"protocol": "141240000096042",
"sequence": "1",
"status_description": "Prestacao do Servico em Desacordo",
"event_date": "2024-11-13 12:01:30",
"created_at": "2024-11-13 11:32:56",
"invoice_mod": "CTE",
"status": "SUCCESS"
}
}
Exemplo de retorno com erro:
{
"error": true,
"message": "Manifesto não encontrado."
}
Comentários
0 comentário
Por favor, entre para comentar.