Nessa rota é possível consultar o status da solicitação de abertura da apuração.
Requisição
Método HTTP
GET
Endpoint
https://app.plugstorage.com.br/api/sped/apuracao/:apuracaoId
Query string
Nome | Descrição |
---|---|
token | Token de identificação da Software House. |
Headers
Nome | Valor |
---|---|
Authorization | Basic encode64(email:senha)== |
Body
Nenhum.
Resposta
Retornos de sucesso
Status code 200
- Os status que podem ser retornados são: PENDENTE, PROCESSANDO, ABERTA, FECHADA ou ERRO. Para cada status, uma mensagem diferente será retornada.
- Para o status ABERTA, a mensagem informará se existem ou não pendências que precisam ser verificadas.
- Para o status ERRO, será retornado um campo
erros
, contendo uma lista de todos os erros que ocorreram.
{
"apuracao": {
"id": "676309019ea85157dbc7ca1b",
"status": "PENDENTE",
"cnpj": "99999999999999",
"ano": "2024",
"mes": "12",
"pendencias": false,
"mensagem": "Apuração pendente, aguarde alguns instantes"
}
}
{
"apuracao": {
"id": "676db1465efd690c802642fd",
"status": "PROCESSANDO",
"cnpj": "99999999999999",
"ano": "2024",
"mes": "12",
"pendencias": false,
"mensagem": "Apuração ainda em processamento, consulte novamente em instantes"
}
}
{
"apuracao": {
"id": "6764630b65087a9dd23ed29f",
"status": "ABERTA",
"cnpj": "99999999999999",
"ano": "2024",
"mes": "12",
"erros": [],
"pendencias": true,
"mensagem": "Apuração aberta possui pendências, favor utilize a rota de consultar pendencias"
}
}
{
"apuracao": {
"id": "677bdd7ce18ecf2cc55160e7",
"status": "ABERTA",
"cnpj": "99999999999999",
"ano": "2024",
"mes": "12",
"erros": [],
"pendencias": false,
"mensagem": "Apuração aberta e sem pendências"
}
}
{
"apuracao": {
"id": "6762fd74216386e7df6aba29",
"status": "FECHADA",
"cnpj": "99999999999999",
"ano": "2024",
"mes": "12",
"erros": [],
"pendencias": false,
"mensagem": "Apuração concluída com sucesso e não pode ser modificada novamente"
}
}
{
"apuracao": {
"id": "676304636a6714cc63e3696e",
"status": "ERRO",
"cnpj": "99999999999999",
"ano": "2024",
"mes": "12",
"erros": [
"Erro de exemplo 01",
"Erro de exemplo 02"
],
"pendencias": false,
"mensagem": "Ocorreu um erro na apuração. Verifique os detalhes e tente novamente"
}
}
Retornos de erro
Status code 400
{
"error": true,
"message": "ID inválido: 676db1465efd690c802642f"
}
{
"error": true,
"message": "Nenhuma apuração localizada com os parâmetros informados."
}
Status code 401
Consulte essa documentação para saber os possíveis retornos de erros de autenticação.
Comentários
0 comentário
Por favor, entre para comentar.